Data Structure for Creating ECSs
Contents
- publicip Field Description
- security_groups Field Description
- eip Field Description
- bandwidth Field Description
- extendparam Field Description for Creating Disks
- extendparam Field Description for Creating ECSs
- metadata Field Description for Creating Disks
- metadata Field Description for Creating ECSs
- os:scheduler_hints Field Description
- binding:profile Field Description
- extra_dhcp_opts Field Description
publicip Field Description
- Creating ECSs /v1/{project_id}/cloudservers
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
No |
String |
Specifies the ID of the existing EIP assigned to the ECS to be created. The value is in UUID format. Only EIPs in DOWN state can be assigned. |
eip |
No |
Object |
Specifies an EIP that will be automatically assigned to an ECS. For details, see Table 3. |
delete_on_termination |
No |
Boolean |
Specifies whether the EIP is released when the ECS where the EIP is bound is deleted.
The default value is 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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
No |
String |
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. |
eip Field Description
- Creating ECSs /v1/{project_id}/cloudservers
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
iptype |
Yes |
String |
Specifies the EIP type. For details about the enumerated values, see the publicip field in "Assigning an EIP" in Virtual Private Cloud API Reference. |
bandwidth |
Yes |
Object |
Specifies the bandwidth of an EIP. For details, see bandwidth Field Description. |
bandwidth Field Description
- Creating ECSs /v1/{project_id}/cloudservers
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
size |
Yes |
Integer |
Specifies the bandwidth size. 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. |
sharetype |
Yes |
String |
Specifies the bandwidth sharing type. Enumerated values: PER (indicates exclusive bandwidth) and WHOLE (indicates sharing) |
chargemode |
Yes |
String |
Specifies the bandwidth billing mode.
|
extendparam Field Description for Creating Disks
This field is used by the following APIs:
- Creating ECSs /v1/{project_id}/cloudservers
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
snapshotId |
No |
String |
Specifies the snapshot ID or ID of the original data disk contained in the full-ECS image. Application scenarios: 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:
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.
|
extendparam Field Description for Creating ECSs
- Creating ECSs /v1/{project_id}/cloudservers
metadata Field Description for Creating Disks
This field is used by the following APIs:
- Creating ECSs /v1/{project_id}/cloudservers
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
__system__encrypted |
No |
String |
Specifies encryption in metadata. The value can be 0 (encryption disabled) or 1 (encryption enabled). If this parameter does not exist, the disk will not be encrypted by default. |
__system__cmkid |
No |
String |
Specifies the CMK ID, which indicates encryption in metadata. This parameter is used with __system__encrypted.
NOTE:
For details about how to obtain the CMK ID, see "Querying the List of CMKs" in Key Management Service API Reference. |
metadata Field Description for Creating ECSs
This field is used by the following APIs:
- Creating ECSs /v1/{project_id}/cloudservers
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
admin_pass |
No |
String |
Specifies the password of user Administrator for logging in to a Windows ECS. For details, see Function.
NOTE:
This parameter is mandatory when a Windows ECS using password authentication is created. |
op_svc_userid |
No |
String |
Specifies the user ID. |
agency_name |
No |
String |
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. |
BYOL |
No |
String |
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.
|
os:scheduler_hints Field Description
- Creating ECSs: /v1/{project_id}/cloudservers
- Creating ECSs (native): /v2.1/{project_id}/servers
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
group |
No |
String |
Specifies the ECS group ID in UUID format. Obtain the parameter value from the console or by referring to Querying ECS Groups.
NOTE:
Ensure that the ECS group uses the anti-affinity policy. |
tenancy |
No |
String |
Creates ECSs on a dedicated or shared host. The value of this parameter can be dedicated or shared. |
dedicated_host_id |
No |
String |
Specifies the dedicated host ID.
NOTE:
A DeH ID takes effect only when tenancy is set to dedicated. |
Parameter |
Type |
Description |
---|---|---|
group |
Array of strings |
Specifies the ECS group ID in UUID format. Obtain the parameter value from the console or by referring to Querying ECS Groups. |
tenancy |
Array of strings |
Creates ECSs on a dedicated or shared host. The value of this parameter can be dedicated or shared. |
dedicated_host_id |
Array of strings |
Specifies the dedicated host ID.
NOTE:
A DeH ID takes effect only when tenancy is set to dedicated. |
binding:profile Field Description
- Creating ECSs: /v1/{project_id}/cloudservers
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
disable_security_groups |
No |
Boolean |
Specifies whether the NIC of an ECS for HANA is not added to a security group.
NOTE:
|
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot