yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
a41a4e0331fbc0beff63bb28fa59228cc9a751df
doc-exports/docs/ecs/api-ref/en-us_topic_0167957246.html
wanghuijuan738 8f024b87ae ECS API 20251204 version. Adding an API Document. 
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: wanghuijuan738 <wanghuijuan738@huawei.com>
Co-committed-by: wanghuijuan738 <wanghuijuan738@huawei.com>
2025-12-17 11:05:14 +00:00

79 KiB
Raw Blame History

Data Structure for Creating ECSs

Contents

publicip Field Description

This field is used by the following APIs:
  • Creating ECSs /v1/{project_id}/cloudservers
Table 1 publicip field description

Parameter

Mandatory

Type

Description

id

No

String

Definition

Specifies the ID of the existing EIP assigned to the ECS to be created. The value is in UUID format.

Constraints

Only EIPs in DOWN state can be assigned.

Range

N/A

Default Value

N/A

eip

No

Object

Definition

Specifies an EIP that will be automatically assigned to an ECS.

For details, see Table 3.

Constraints

N/A

Range

N/A

Default Value

N/A

delete_on_termination

No

Boolean

Definition

Specifies whether the EIP is released along with the associated ECS.

Constraints

N/A

Range

  • true: The EIP is released along with the associated ECS.
  • false: The EIP is not released along with the associated ECS.

Default Value

false

Either id or eip in the publicip field can be configured.

security_groups Field Description

This field is used by the following APIs:

  • Creating ECSs /v1/{project_id}/cloudservers
Table 2 security_groups field description

Parameter

Mandatory

Type

Description

id

No

String

Definition

Specifies the ID of the security group to which an ECS is to be added. The configuration will take effect on the NICs of the ECS. You need to specify the ID of an existing security group in UUID format. Otherwise, the default security group will be used at the underlying layer.

Constraints

N/A

Range

N/A

Default Value

N/A

eip Field Description

This field is used by the following APIs:
  • Creating ECSs /v1/{project_id}/cloudservers
Table 3 eip field description

Parameter

Mandatory

Type

Description

iptype

Yes

String

Definition

Specifies the EIP type.

For details about the enumerated values, see the publicip field in "Assigning an EIP" in Virtual Private Cloud API Reference.

Constraints

N/A

Range

N/A

Default Value

N/A

bandwidth

Yes

Object

Definition

Specifies the bandwidth of an EIP.

For details, see bandwidth Field Description.

Constraints

N/A

Range

N/A

Default Value

N/A

bandwidth Field Description

This field is used by the following APIs:
  • Creating ECSs /v1/{project_id}/cloudservers
Table 4 bandwidth field description

Parameter

Mandatory

Type

Description

size

Yes

Integer

Definition

Specifies the bandwidth size.

Constraints

N/A

Range

Specifies the bandwidth (Mbit/s). The value ranges from 1 to 1,000.

The specific range may vary depending on the configuration in each region. You can see the bandwidth range of each region on the management console.

Default Value

N/A

sharetype

Yes

String

Definition

Specifies the bandwidth sharing type.

Constraints

N/A

Range

Enumerated values: PER (indicates exclusive bandwidth) and WHOLE (indicates shared bandwidth)

Default Value

N/A

chargemode

Yes

String

Definition

Specifies the bandwidth billing mode.

Constraints

  • If the field value is traffic, the ECS is billed by traffic.
  • If the field value is others, creating the ECS will fail.

Range

N/A

Default Value

N/A

ipv6_bandwidth Field Description

This field is used by the following APIs:
  • Creating ECSs /v1/{project_id}/cloudservers
Table 5 ipv6_bandwidth field description

Parameter

Mandatory

Type

Description

id

No

String

Definition

Specifies the ID of an IPv6 bandwidth.

Constraints

N/A

Range

N/A

Default Value

N/A

extendparam Field Description for Creating Disks

This field is used by the following APIs:

  • Creating ECSs /v1/{project_id}/cloudservers
Table 6 extendparam field description for creating disks

Parameter

Mandatory

Type

Description

snapshotId

No

String

Definition

Specifies the snapshot ID or ID of the original data disk contained in the full-ECS image.

  • Scenario:

    This parameter is used if an ECS is created using a full-ECS image, and the image contains one or more data disks.

    If you use a full-ECS image to create an ECS, the system automatically restores the data type and data from the data disks in the image. The snapshotId parameter allows you to specify the disk type for the original data disk after restoration.

    NOTE:
    • You are advised to specify snapshotId for each original data disk.
    • If you are required to change a disk size, ensure that the changed disk size is greater than or equal to the size of the original data disk. Otherwise, restoring data of the original data disk will fail.
    • To set disk sharing, you need to specify the sharing attribute.
    • To set disk encryption, you need to specify the encryption attribute in the metadata field.
  • Working rules:

    snapshotId uniquely identifies an original data disk contained in a full-ECS image. You can use snapshotId to obtain the information of the original data disk for data restoration.

  • Obtaining snapshotId through the management console:

    Log in to the management console, choose Elastic Volume Service > Snapshot. Then, use the name of the original data disk to find the snapshot ID or the original disk ID.

  • Obtaining snapshotId through the API:
    If you have obtained the full-ECS image ID, obtain the Cloud Backup and Recovery (CBR) or Cloud Server Backup Service (CSBS) backup ID associated with the full-ECS image ID by following the instructions provided in the API for querying image details.
    • If CBR backup is used, use the CBR backup ID to obtain the backup. The resource_id or snapshot_id contained in the children field in the response is the desired snapshotId. For details, see the API for "Querying a Specified Backup" in Cloud Backup and Recovery User Guide.
    • If CSBS backup is used, use the CSBS backup ID to obtain the backup. The source_volume_id or snapshot_id contained in the volume_backups field in the response is the desired snapshotId. For details, see the API for "Querying a Single Backup" in Cloud Server Backup Service User Guide.

Constraints

N/A

Range

N/A

Default Value

N/A

extendparam Field Description for Creating ECSs

This field is used by the following APIs:
  • Creating ECSs /v1/{project_id}/cloudservers
Table 7 extendparam field description for creating ECSs (for V1 APIs)

Parameter

Mandatory

Type

Description

regionID

No

String

Definition

Specifies the ID of the region where the ECS resides.

Constraints

N/A

Range

N/A

Default Value

N/A

CB_CSBS_BACKUP

No

String

Definition

Specifies a CSBS policy ID and CSBS vault ID.

For example, a CSBS policy ID obtained on the console is fdcaa27d-5be4-4f61-afe3-09ff79162c04.

A CSBS vault ID is 332a9408-463f-436a-9e92-78dad95d1ac4.

The CB_CSBS_BACKUP value is "{\"policy_id\":\"fdcaa27d-5be4-4f61-afe3-09ff79162c04\",\"vault_id\":\"332a9408-463f-436a-9e92-78dad95d1ac4\"}".

Constraints

N/A

Range

N/A

Default Value

N/A

metadata Field Description for Creating Disks

This field is used by the following APIs:

  • Creating ECSs /v1/{project_id}/cloudservers
  • When you create an ECS, both root_volume and data_volume contain the metadata field.
Table 8 metadata field description for creating disks

Parameter

Mandatory

Type

Description

__system__encrypted

No

String

Definition

Specifies the encryption parameter in metadata.

Constraints

If this parameter does not exist, the disk will not be encrypted by default.

Range

  • 0: indicates a non-encrypted disk.
  • 1: indicates an encrypted disk.

Default Value

N/A

__system__cmkid

No

String

Definition

Specifies the CMK ID, which indicates encryption in metadata.

For details about how to obtain the CMK ID through HTTPS requests, see "Querying the List of CMKs" in Key Management Service API Reference.

Constraints

This parameter must be used with __system__encrypted.

Range

N/A

Default Value

N/A

metadata Field Description for Creating ECSs

This field is used by the following APIs:

  • Creating ECSs /v1/{project_id}/cloudservers
Table 9 metadata reserved field description

Parameter

Mandatory

Type

Description

admin_pass

No

String

Definition

Specifies the password of user Administrator for logging in to a Windows ECS. For details, see Function.

Constraints

This parameter is mandatory when a Windows ECS using password authentication is created.

Range

N/A

Default Value

N/A

op_svc_userid

No

String

Definition

Specifies the user ID.

NOTE:

The value of this parameter is that of IAM User ID of the current login account. If you log in as an IAM user, obtain the IAM user ID of that IAM user.

Constraints

N/A

Range

N/A

Default Value

N/A

agency_name

No

String

Definition

Specifies the agency name.

An agency is created by a tenant administrator on Identity and Access Management (IAM) to provide temporary credentials for ECSs to access cloud services.

Constraints

N/A

Range

N/A

Default Value

N/A

__support_agent_list

No

String

Definition

Specifies whether the ECS supports Host Security Service (HSS).

Determine whether the image used for creating the ECS supports HSS via the API for querying images.

Constraints

N/A

Range

hss,hss-ent: indicates the HSS enterprise edition.

Example values:

_support_agent_list: "hss,hss-ent"

Default Value

N/A

BYOL

No

String

Definition

If you have an OS or a software license (a license certified based on the number of physical servers and cores), you can migrate your services to the cloud platform in BYOL mode to continue using your existing licenses.

Constraints

N/A

Range

  • True: Use your existing licenses.
  • False: System licenses are used.

Default Value

N/A

os:scheduler_hints Field Description

This field is used by the following APIs:
  • Creating ECSs: /v1/{project_id}/cloudservers
  • Creating ECSs (native): /v2.1/{project_id}/servers
Table 10 os:scheduler_hints field description (request parameters)

Parameter

Mandatory

Type

Description

group

No

String

Definition

Specifies the ECS group ID in UUID format.

Obtain the parameter value from the console or by referring to Listing ECS Groups.

Constraints

Ensure that the ECS group uses the anti-affinity policy.

The anti-affinity policy is not supported for ECSs created on a specified DeH.

Range

N/A

Default Value

N/A

tenancy

No

String

Definition

Creates ECSs on a dedicated or shared host.

Constraints

N/A

Range

The value of this parameter can be dedicated or shared.

Default Value

N/A

dedicated_host_id

No

String

Definition

Specifies the dedicated host ID.

Constraints

A DeH ID takes effect only when tenancy is set to dedicated.

Range

N/A

Default Value

N/A
Table 11 os:scheduler_hints field description (response parameters)

Parameter

Type

Description

group

Array of strings

Definition

Specifies the ECS group ID in UUID format.

Obtain the parameter value from the console or by referring to Listing ECS Groups

Constraints

N/A

Range

N/A

Default Value

N/A

tenancy

Array of strings

Definition

Creates ECSs on a dedicated or shared host.

Constraints

N/A

Range

share or dedicate

Default Value

N/A

dedicated_host_id

Array of strings

Definition

Specifies the dedicated host ID.

Constraints

A DeH ID takes effect only when tenancy is set to dedicated.

Range

N/A

Default Value

N/A

binding:profile Field Description

This field is used by the following APIs:
  • Creating ECSs: /v1/{project_id}/cloudservers
Table 12 binding:profile field description

Parameter

Mandatory

Type

Description

disable_security_groups

No

Boolean

Definition

Specifies whether the NIC of an ECS is not added to a security group.

Constraints

  • The primary NIC of the ECS must be added to a security group.
  • At most one NIC of the ECS is allowed not to be added to any security groups.

Range

N/A

Default Value

N/A

extra_dhcp_opts Field Description

This field is used by the following APIs:
  • Creating ECSs: /v1/{project_id}/cloudservers
Table 13 extra_dhcp_opts field description

Parameter

Mandatory

Type

Description

opt_value

Yes

Integer

Definition

Specifies the NIC MTU.

Constraints

N/A

Range

1280 to 8888

Default Value

N/A

opt_name

Yes

String

Definition

Set the parameter value to 26.

Constraints

N/A

Range

N/A

Default Value

N/A
Parent topic: Data Structure