Data Structure for Creating ECSs

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

id

No

String

Definition

Specifies the ID of an IPv6 bandwidth.

Constraints

N/A

Range

N/A

Default Value

N/A

resourceSpecCode

No

String

Definition

Specifies the code of the disk specifications, such as SATA, SAS, or SSD.

Constraints

N/A

Range

N/A

Default Value

N/A

resourceType

No

String

Definition

Specifies the resource type.

Constraints

N/A

Range

N/A

Default Value

N/A

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

chargingMode

No

String

Definition

Specifies the billing mode.

Constraints

When chargingMode is set to prePaid (indicating that the created ECS is billed in yearly/monthly payments) and the ECS is logged in using an SSH key, op_svc_userid in metadata is mandatory.

For details about the value of op_svc_userid in metadata, see Table 11.

Range

• prePaid: indicates the yearly/monthly billing mode.
• postPaid: indicates the pay-per-use billing mode.

Default Value

postPaid

regionID

No

String

Definition

Specifies the ID of the region where the ECS resides.

See Regions and Endpoints.

Constraints

N/A

Range

N/A

Default Value

N/A

periodType

No

String

Definition

Specifies the subscription period.

Constraints

This parameter is valid and mandatory if chargingMode is set to prePaid.

Range

• month: indicates that the subscription is in the unit of month.
• year: indicates that the subscription is in the unit of year.

Default Value

N/A

periodNum

No

Integer

Definition

Specifies the number of subscription periods.

Constraints

• This parameter is valid and mandatory if chargingMode is set to prePaid.
• The parameter value must be a positive integer.
• According to Huawei Cloud ECS pricing rules, the price of a one-year ECS (yearly) is equal to the price of a 10-month ECS (monthly). If you need to purchase a monthly ECS for more than nine months, it is a good choice to purchase a yearly ECS.

Range

• If periodType is month, the value ranges from 1 to 9.
• If periodType is year, the value ranges from 1 to 3.

Default Value

N/A

isAutoRenew

No

String

Definition

Specifies whether auto renew is enabled.

Constraints

This parameter is valid when chargingMode is set to prePaid. If this parameter is not specified, auto renew is disabled by default.

Range

• true: indicates that auto renew is enabled.
• false: indicates that auto renew is disabled.

Constraints

N/A

isAutoPay

No

String

Definition

Specifies whether the order is automatically or manually paid.

Constraints

This parameter is valid when chargingMode is set to prePaid. If this parameter is not specified, the order must be manually paid by default.

Range

• true: The order will be automatically paid.
• false: The order must be manually paid.

Default Value

N/A

enterprise_project_id

No

String

Definition

Specifies the enterprise project ID.

For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.

Constraints

If this parameter is not specified or is set to 0, resources will be bound to the default enterprise project.

Range

N/A

Default Value

N/A

support_auto_recovery

No

Boolean

Definition

Specifies whether to enable automatic ECS recovery.

Constraints

This parameter is of boolean type. If a non-boolean character is imported, the parameter value is set to false.

Range

• true: enables this function.
• false: disables this function.

Default Value

N/A

marketType

No

String

Definition

Specifies a spot ECS. When creating a spot ECS, set the parameter value to spot.

Constraints

This parameter takes effect only when chargingMode is set to postPaid and marketType is set to spot.

Range

N/A

Default Value

N/A

spotPrice

No

String

Definition

Specifies the highest price per hour you are willing to pay for a spot ECS.

Constraints

• This parameter takes effect only when chargingMode is set to postPaid and marketType is set to spot.
• When chargingMode is set to postPaid and marketType is set to spot, if the spotPrice parameter is not specified or specified to null, the pay-per-use price is used by default.
• The spotPrice value must be less than or equal to the pay-per-use price and greater than or equal to the ECS market price.

Range

N/A

Default Value

N/A

diskPrior

No

String

Definition

Specifies whether to support the function of creating a disk and then ECS.

Constraints

N/A

Range

• true: enables this function.
• false: disables this function.

Default Value

N/A

spot_duration_hours

No

Integer

Definition

Specifies the predefined duration of the spot ECS.

Constraints

• This parameter is mandatory for spot block ECSs and is valid only when interruption_policy is set to immediate.
• The spot_duration_hours value must be greater than 0. Its maximum value is automatically set by the system and can be obtained from the cond:spot_block:operation:longest_duration_hours field of flavor parameter extra_specs.

Range

N/A

Default Value

N/A

spot_duration_count

No

Integer

Definition

Specifies the number of durations.

Constraints

• This parameter is mandatory for spot block ECSs and is valid only when spot_duration_hours is greater than 0.
• If spot_duration_hours is set to a value smaller than 6, spot_duration_count must be 1.
• If spot_duration_hours is set to 6, spot_duration_count must be greater than or equal to 1.

Range

N/A

Default Value

N/A

interruption_policy

No

String

Definition

Specifies the spot ECS interruption policy. The parameter can only be set to immediate currently, meaning that the spot ECSs are released immediately.

Constraints

This parameter must be set to immediate for spot block ECSs.

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

__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 Key List.

Constraints

This parameter must be used with __system__encrypted.

Range

N/A

Default Value

N/A

op_svc_userid

No

String

Definition

Specifies the user ID.

You can obtain the value of this parameter from IAM User ID on the My Credentials > API Credentials page. For details, see API Credentials.

Constraints

N/A

Range

N/A

Default Value

N/A

agency_name

No

String

Definition

Specifies the IAM 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

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 using bring your own license (BYOL) model to continue using your existing licenses.

Constraints

N/A

Default Value

N/A

group

No

String

Definition

Specifies the ECS group ID in UUID format.

Obtain the parameter value from the console or by referring to Querying 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.

The value of this parameter can be dedicated or shared.

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

group

Array of strings

Definition

Specifies the ECS group ID in UUID format.

Obtain the parameter value from the console or by referring to Querying 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

key

Yes

String

Definition

Specifies the tag key.

Constraints

• The key can contain a maximum of 36 Unicode characters.
• It cannot be left blank.
• It cannot contain ASCII (0-31) or the following special characters: =*<>\,|/
• The tag key of an ECS must be unique.

Range

N/A

Default Value

N/A

value

Yes

String

Definition

Specifies the tag value.

Constraints

• The value can contain a maximum of 43 Unicode characters and can be left blank.
• It cannot contain ASCII (0-31) or the following characters: =*<>\,|

Range

N/A

Default Value

N/A