Example Request
Change the ECS flavor to c3.15xlarge.2.
POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/resize
diff --git a/docs/ecs/api-ref/en-us_topic_0020212656.html b/docs/ecs/api-ref/en-us_topic_0020212656.html
index 4cf31faf7..dc0cc08e4 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212656.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212656.html
@@ -3,7 +3,7 @@
Querying Details About Flavors and Extended Flavor Information
Function
This API is used to query details about ECS flavors and extended flavor information.
-
URI
GET /v1/{project_id}/cloudservers/flavors?availability_zone={availability_zone}
+
URI
GET /v1/{project_id}/cloudservers/flavors
Table 1 describes the parameters in the URI.
Table 1 Path parametersParameter
|
@@ -42,7 +42,14 @@
String
|
-Specifies an AZ. If this parameter is not left blank, flavors in the normal, obt, or promotion states are returned.
+ | Definition
+Specifies an AZ. If this parameter is not left blank, flavors in the normal, obt, or promotion states are returned.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
|
|---|
@@ -63,7 +70,10 @@
Array of objects
|
-Specifies ECS flavors. For details, see Table 4.
+ | Definition
+Specifies ECS flavors. For details, see Table 4.
+Range
+N/A
|
@@ -82,91 +92,126 @@
String
|
-Specifies the ID of the ECS flavor.
+ | Definition
+Specifies the ID of the ECS flavor.
+Range
+N/A
|
name
|
String
|
-Specifies the name of the ECS flavor.
+ | Definition
+Specifies the name of the ECS flavor.
+Range
+N/A
|
vcpus
|
String
|
-Specifies the number of vCPUs in the ECS flavor.
+ | Definition
+Specifies the number of vCPUs in the ECS flavor.
+Range
+N/A
|
ram
|
Integer
|
-Specifies the memory size (MB) in the ECS flavor.
+ | Definition
+Specifies the memory size (MiB) in the ECS flavor.
+Range
+N/A
|
disk
|
String
|
-Specifies the system disk size in the ECS flavor.
+ | Definition
+Specifies the system disk size in the ECS flavor.
This parameter has not been used. Its default value is 0.
+Range
+N/A
|
swap
|
String
|
-Specifies the swap partition size required by the ECS flavor.
+ | Definition
+Specifies the swap partition size required by the ECS flavor.
This parameter has not been used. Its default value is "".
+Range
+N/A
|
OS-FLV-EXT-DATA:ephemeral
|
Integer
|
-Specifies the temporary disk size. This is an extended attribute.
+ | Definition
+Specifies the temporary disk size. This is an extended attribute.
This parameter has not been used. Its default value is 0.
+Range
+N/A
|
OS-FLV-DISABLED:disabled
|
Boolean
|
-Specifies whether the ECS flavor has been disabled. This is an extended attribute.
+ | Definition
+Specifies whether the ECS flavor has been disabled. This is an extended attribute.
This parameter has not been used. Its default value is false.
+Range
+N/A
|
rxtx_factor
|
Float
|
-Specifies the ratio of the available network bandwidth to the network hardware bandwidth of the ECS.
+ | Definition
+Specifies the ratio of the available network bandwidth to the network hardware bandwidth of the ECS.
This parameter has not been used. Its default value is 1.0.
+Range
+N/A
|
rxtx_quota
|
String
|
-Specifies the software constraints of the network bandwidth that can be used by the ECS.
+ | Definition
+Specifies the software constraints of the network bandwidth that can be used by the ECS.
This parameter has not been used. Its default value is null.
+Range
+N/A
|
rxtx_cap
|
String
|
-Specifies the hardware constraints of the network bandwidth that can be used by the ECS.
+ | Definition
+Specifies the hardware constraints of the network bandwidth that can be used by the ECS.
This parameter has not been used. Its default value is null.
+Range
+N/A
|
os-flavor-access:is_public
|
Boolean
|
-Specifies whether a flavor is available to all tenants. This is an extended attribute.
+ | Definition
+Specifies whether a flavor is available to all tenants. This is an extended attribute.
+Range
- true: indicates that a flavor is available to all tenants.
- false: indicates that a flavor is available only to certain tenants.
Default value: true
|
@@ -175,14 +220,20 @@
Array of objects
|
-Specifies shortcut links for ECS flavors. For details, see Table 5.
+ | Definition
+Specifies shortcut links for ECS flavors. For details, see Table 5.
+Range
+N/A
|
os_extra_specs
|
Object
|
-Specifies extended ECS specifications. For details, see Table 6.
+ | Definition
+Specifies extended ECS specifications. For details, see Table 6.
+Range
+N/A
|
@@ -272,7 +323,7 @@
The value of this parameter is in format of {type}:{count}:{size}:{safeFormat}.
- type: indicates the disk type, which can only be HDD.
- count: indicates the number of local disks. The following types are supported:
- For D2 ECSs, the value can be 2, 4, 8, 12, 16, or 24.
- For D3 ECSs, the value can be 2, 4, 8, 12, 16, 24, or 28.
- - size: indicates the capacity of a single disk, in GB. Currently, only 1675 is supported. The actual disk size is 1800, and the available size after formatting is 1675.
- safeFormat: indicates whether the local disks of the ECS are securely formatted. The following types are supported:
- For D2 or D3 ECSs, the value is True.
+ - size: indicates the capacity of a single disk, in GiB. Currently, only 1675 is supported. The actual disk size is 1800, and the available size after formatting is 1675.
- safeFormat: indicates whether the local disks of the ECS are securely formatted. The following types are supported:
- For D2 or D3 ECSs, the value is True.
NOTE: This field is dedicated for disk-intensive ECSs.
@@ -283,8 +334,8 @@
| String
|
The value of this parameter is in the format of {type}:{spec}:{num}:{size}:{safeFormat}.
-- type: indicates the capacity of a single NVME SSD disk attached to the ECS, which can only be 1.6 TB or 3.2 TB.
- spec: indicates the specifications of the NVMe SSD disk, which can be large (large specifications) or lvs (small specifications).
If spec is set to large, only I series (for example, I3) is supported.
- - num indicates the number of local disks.
- size: indicates the capacity, in the unit of GB, of the disk used by the guest user. If the spec value is large, the value of this parameter is the size of a single disk attached to the ECS. If the value of spec is lvs, the value of size is an integer multiple of 50.
- safeFormat: indicates whether the local disks of the ECS are securely formatted.
If safeFormat is set to True, only I series (for example, I3) is supported.
+- type: indicates the capacity of a single NVMe SSD disk attached to the ECS, which can only be 1.6 TB or 3.2 TB.
- spec: indicates the specifications of the NVMe SSD disk, which can be large (large specifications) or lvs (small specifications).
If spec is set to large, only I series (for example, I3) is supported.
+ - num indicates the number of local disks.
- size: indicates the capacity, in the unit of GiB, of the disk used by the guest user. If the spec value is large, the value of this parameter is the size of a single disk attached to the ECS. If the value of spec is lvs, the value of size is an integer multiple of 50.
- safeFormat: indicates whether the local disks of the ECS are securely formatted.
If safeFormat is set to True, only I series (for example, I3) is supported.
NOTE: This field is dedicated for ultra-high I/O ECSs.
@@ -295,7 +346,7 @@
String
|
Specifies the generation of an ECS type.
-For example, 3 in s3 indicates the general-purpose third-generation ECSs. For details about flavors and generations, see ECS Specifications in the Elastic Cloud Server User Guide.
+For example, 3 in s3 indicates the general-purpose third-generation ECSs. For details about flavors and generations, see ECS Specifications in the Elastic Cloud Server User Guide.
|
ecs:virtualization_env_types
@@ -328,7 +379,7 @@
|
String
|
-This parameter takes effect region-wide. If an AZ is not configured in the cond:operation:az parameter, the value of this parameter is used by default. If this parameter is not set or used, the meaning of normal applies. Value range:
+ | This parameter takes effect region-wide. If an AZ is not configured in the cond:operation:az parameter, the value of this parameter is used by default. If this parameter is not set or used, the meaning of normal applies. Options:
- normal: indicates normal commercial use of the flavor.
- abandon: indicates that the flavor has been taken offline (not displayed).
- sellout: indicates that the flavor has been sold out.
- obt: indicates that the flavor is under open beta testing (OBT).
- obt_sellout: indicates that the OBT resources are sold out.
- promotion: indicates that the flavor is recommended (for commercial use, which is similar to normal).
|
diff --git a/docs/ecs/api-ref/en-us_topic_0020212658.html b/docs/ecs/api-ref/en-us_topic_0020212658.html
index 6382bfe16..bcd5873bd 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212658.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212658.html
@@ -43,7 +43,7 @@
|
String
|
-Specifies the minimum disk specification in the unit of GB. Only the ECSs with the disk specification greater than or equal to the minimum specification can be queried.
+ | Specifies the minimum disk size in GiB. Only the ECSs with a disk size greater than or equal to the minimum size can be queried.
|
minRam
@@ -52,7 +52,7 @@
|
String
|
-Specifies the minimum RAM in the unit of MB. Only the ECSs with the RAM specification greater than or equal to the minimum specification can be queried.
+ | Specifies the minimum memory size in MiB. Only the ECSs with the memory size greater than or equal to the minimum size can be queried.
|
sort_key
@@ -147,7 +147,7 @@
|
Integer
|
-Specifies the memory size (MB) in the ECS flavor.
+ | Specifies the memory size (MiB) in the ECS flavor.
|
disk
@@ -163,7 +163,7 @@
| String
|
Specifies the swap partition size required by the ECS flavor.
-This parameter has not been used. Its default value is "".
+This parameter has not been used. Its default value is "".
|
OS-FLV-EXT-DATA:ephemeral
@@ -171,7 +171,7 @@
| Integer
|
Specifies the temporary disk size. This is an extended attribute.
-This parameter has not been used. Its default value is 0.
+This parameter has not been used. Its default value is 0.
|
OS-FLV-DISABLED:disabled
@@ -179,7 +179,7 @@
| Boolean
|
Specifies whether the ECS flavor has been disabled. This is an extended attribute.
-This parameter has not been used. Its default value is false.
+This parameter has not been used. Its default value is false.
|
rxtx_factor
@@ -187,7 +187,7 @@
| Float
|
Specifies the ratio of the available network bandwidth to the network hardware bandwidth of the ECS.
-This parameter has not been used. Its default value is 1.0.
+This parameter has not been used. Its default value is 1.0.
|
os-flavor-access:is_public
@@ -195,7 +195,7 @@
| Boolean
|
Specifies whether a flavor is available to all tenants. This is an extended attribute.
-- true: indicates that a flavor is available to all tenants.
- false: indicates that a flavor is available only to certain tenants.
+- true: indicates that a flavor is available to all tenants.
- false: indicates that a flavor is available only to certain tenants.
Default value: true
|
diff --git a/docs/ecs/api-ref/en-us_topic_0020212659.html b/docs/ecs/api-ref/en-us_topic_0020212659.html
index 388865d21..2338a6108 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212659.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212659.html
@@ -96,7 +96,7 @@
Integer
|
-Specifies the memory size (MB) in the ECS flavor.
+ | Specifies the memory size (MiB) in the ECS flavor.
|
disk
@@ -112,7 +112,7 @@
| String
|
Specifies the swap partition size required by the ECS flavor.
-This parameter has not been used. Its default value is "".
+This parameter has not been used. Its default value is "".
|
OS-FLV-EXT-DATA:ephemeral
@@ -120,7 +120,7 @@
| Integer
|
Specifies the temporary disk size. This is an extended attribute.
-This parameter has not been used. Its default value is 0.
+This parameter has not been used. Its default value is 0.
|
OS-FLV-DISABLED:disabled
@@ -128,7 +128,7 @@
| Boolean
|
Specifies whether the ECS flavor has been disabled. This is an extended attribute.
-This parameter has not been used. Its default value is false.
+This parameter has not been used. Its default value is false.
|
rxtx_factor
@@ -136,7 +136,7 @@
| Float
|
Specifies the ratio of the available network bandwidth to the network hardware bandwidth of the ECS.
-This parameter has not been used. Its default value is 1.0.
+This parameter has not been used. Its default value is 1.0.
|
os-flavor-access:is_public
@@ -144,7 +144,7 @@
| Boolean
|
Specifies whether a flavor is available to all tenants. This is an extended attribute.
-- true: indicates that a flavor is available to all tenants.
- false: indicates that a flavor is available only to certain tenants.
+- true: indicates that a flavor is available to all tenants.
- false: indicates that a flavor is available only to certain tenants.
Default value: true
|
diff --git a/docs/ecs/api-ref/en-us_topic_0020212661.html b/docs/ecs/api-ref/en-us_topic_0020212661.html
index 2c5cc0024..932692fcd 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212661.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212661.html
@@ -81,7 +81,7 @@
String
|
-Specifies the network ID to which the NIC port belongs.
+ | Specifies the network ID (network_id) that the NIC port belongs to.
|
port_id
diff --git a/docs/ecs/api-ref/en-us_topic_0020212662.html b/docs/ecs/api-ref/en-us_topic_0020212662.html
index 24eb3ff73..cc190f09d 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212662.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212662.html
@@ -88,7 +88,7 @@
|
String
|
-Specifies the network ID to which the NIC port belongs.
+ | Specifies the network ID that the NIC port belongs to.
|
port_id
diff --git a/docs/ecs/api-ref/en-us_topic_0020212663.html b/docs/ecs/api-ref/en-us_topic_0020212663.html
index 51f010109..f6f1e19ac 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212663.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212663.html
@@ -2,30 +2,32 @@
Adding NICs to an ECS in a Batch
FunctionThis API is used to add one or multiple NICs to an ECS.
- This API is an asynchronous API. After the NIC addition request is successfully delivered, a job ID is returned. This does not mean the NIC addition is complete. You need to call the API by referring to Querying Task Execution Status to query the job status. The SUCCESS status indicates that the NIC addition is successful.
+ This API is an asynchronous API. After the NIC addition request is successfully delivered, a job ID is returned. This does not mean the NIC addition is complete. You need to call the API by referring to Querying Job Execution Status to query the job status. The SUCCESS status indicates that the NIC addition is successful.
+
+ ConstraintsDo not detach or delete the NICs that are being added.
URIPOST /v1/{project_id}/cloudservers/{server_id}/nics
Table 1 describes the parameters in the URI.
- Table 1 Parameter descriptionParameter
+Table 1 Parameter descriptionParameter
|
-Mandatory
+ | Mandatory
|
-Description
+ | Description
|
|---|
-project_id
+ | project_id
|
-Yes
+ | Yes
|
-Specifies the project ID.
+ | Specifies the project ID.
|
-server_id
+ | server_id
|
-Yes
+ | Yes
|
-Specifies the ECS ID.
+ | Specifies the ECS ID.
|
@@ -34,107 +36,107 @@
RequestTable 2 describes the request parameters.
- Table 2 Request parametersParameter
+Table 2 Request parametersParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-nics
+ | nics
|
-Yes
+ | Yes
|
-Array of objects
+ | Array of objects
|
-Specifies the NICs to be added. For details, see Table 3.
+ | Specifies the NICs to be added. For details, see Table 3.
|
Table 3 nics field descriptionParameter
+Table 3 nics field descriptionParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-subnet_id
+ | subnet_id
|
-Yes
+ | Yes
|
-String
+ | String
|
-Specifies the information about the NICs to be added to an ECS.
+ | Specifies the information about the NICs to be added to an ECS.
The value must be the ID of a created network in UUID format.
|
-security_groups
+ | security_groups
|
-No
+ | No
|
-Array of objects
+ | Array of objects
|
-Specifies the security groups for NICs. For details, see Table 4.
+ | Specifies the security groups for NICs. For details, see Table 4.
|
-ip_address
+ | ip_address
|
-No
+ | No
|
-String
+ | String
|
-Specifies the IP address. If this parameter is unavailable, the IP address is automatically assigned.
+ | Specifies the IP address. If this parameter is unavailable, the IP address is automatically assigned.
|
-ipv6_enable
+ | ipv6_enable
|
-No
+ | No
|
-Boolean
+ | Boolean
|
-Indicates whether to support IPv6 addresses.
+ | Indicates whether to support IPv6 addresses.
If this parameter is set to true, the NIC supports IPv6 addresses.
|
-ipv6_bandwidth
+ | ipv6_bandwidth
|
-No
+ | No
|
-Object
+ | Object
|
-Specifies the bound shared bandwidth. For details, see ipv6_bandwidth Field Description.
+ | Specifies the bound shared bandwidth. For details, see ipv6_bandwidth Field Description.
|
Table 4 security_groups field descriptionParameter
+Table 4 security_groups field descriptionParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-id
+ | id
|
-Yes
+ | Yes
|
-String
+ | String
|
-Specifies the ID of the security group.
+ | Specifies the ID of the security group.
|
@@ -142,7 +144,7 @@
-ResponseSee Responses (Task).
+
Example RequestAdd the NIC whose ID is d32019d3-bc6e-4319-9c1d-6722fc136a23 and security group ID is f0ac4394-7e4a-4409-9701-ba8be283dbc3 to an ECS.
POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/nics
diff --git a/docs/ecs/api-ref/en-us_topic_0020212665.html b/docs/ecs/api-ref/en-us_topic_0020212665.html
index 5bfd3cc48..67654cf15 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212665.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212665.html
@@ -1,8 +1,8 @@
Deleting NICs from an ECS in a Batch
-FunctionThis API is used to uninstall and delete one or multiple NICs from an ECS.
- This API is an asynchronous API. After the deletion request is successfully delivered, a job ID is returned. This does not mean the deletion is complete. You need to call the API by referring to Querying Task Execution Status to query the job status. The SUCCESS status indicates that the deletion is successful.
+ FunctionThis API is used to delete one or multiple NICs from an ECS.
+ This API is an asynchronous API. After the deletion request is successfully delivered, a job ID is returned. This does not mean the deletion is complete. You need to call the API by referring to Querying Job Execution Status to query the job status. The SUCCESS status indicates that the deletion is successful.
ConstraintsThe primary NIC of an ECS has routing rules configured and cannot be deleted.
@@ -85,7 +85,7 @@
ResponseSee Responses (Task).
+
Example RequestDelete the NIC whose ID is d32019d3-bc6e-4319-9c1d-6722fc136a23 from an ECS.
POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/nics/delete
diff --git a/docs/ecs/api-ref/en-us_topic_0020212668.html b/docs/ecs/api-ref/en-us_topic_0020212668.html
index 31c95e47d..f67936bef 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212668.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212668.html
@@ -2,14 +2,14 @@
Creating an ECS
FunctionThis API is used to create one or more ECSs.
- This API is an asynchronous API. After the creation request is successfully delivered, a job ID is returned. This does not mean that the creation is complete. You need to call the API by referring to Querying Task Execution Status to query the job status. The SUCCESS status indicates that the creation is successful.
+ This API is an asynchronous API. After the creation request is successfully delivered, a job ID is returned. This does not mean that the creation is complete. You need to call the API by referring to Querying Job Execution Status to query the job status. The SUCCESS status indicates that the creation is successful.
Before calling this API, you need to obtain regions and endpoints.
Logging in to an ECS can be authenticated using either a key pair or password. For security purposes, you are advised to use key pair authentication.
- Key pair
A key pair is used for ECS login authentication.
Method of calling APIs: Use the key_name field to specify the key file used for logging in to the ECS.
- - Password
If you choose the initial password for authentication in an ECS, you can log in to the ECS using the username and its initial password. The initial password of user root is used for authentication in Linux, while that of user Administrator is used for authentication in Windows.
-Method of calling APIs: Use the adminPass field to specify the initial login password of the administrator account. For details about how to use the adminPass field, see Table 3. If an encrypted password is required for logging in to a Linux ECS that is created using an image with Cloud-Init installed, you can use the user_data field to inject the password. For details, see Table 3.  If the user_data field is specified for a Linux ECS that is created using an image with Cloud-Init installed, the adminPass field becomes invalid.
+ - Password
If you choose the initial password for authentication in an ECS, you can log in to the ECS using the username and its initial password. The initial password of user root is used for authentication in Linux, while that of user Administrator is used for authentication in Windows.
+Method of calling APIs: Use the adminPass field to specify the initial login password of the administrator account. For details about how to use the adminPass field, see Table 3. If an encrypted password is required for logging in to a Linux ECS that is created using an image with Cloud-Init installed, you can use the user_data field to inject the password. For details, see Table 3. If the user_data field is specified for a Linux ECS that is created using an image with Cloud-Init installed, the adminPass field becomes invalid.
- Image password
If you use a Linux private image to create an ECS, you can use the image password for login authentication.
@@ -56,7 +56,14 @@
Object
|
-Specifies the ECS information. For details, see Table 3.
+ | Definition
+Specifies the ECS information. For details, see Table 3.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
|
dry_run
@@ -65,9 +72,16 @@
|
Boolean
|
-Specifies whether to check the request and create the ECS. The default value is false.
-- true: The request is sent, but the ECS will not be created. Check items include mandatory parameters and request format.
- If the check fails, the system returns an error.
- If the check is successful, the system returns status code 202.
- - false: The request is sent and the ECS will be created after the check is passed.
+ | Definition
+Specifies whether to check the request. If this parameter is set to true, no instance is created.
+Constraints
+N/A
+Range
+- true: Check the request. Check items include the mandatory parameters and request format.
- If the check fails, the system returns an error.
- If the check is successful, the system returns status code 202.
+
+- false: Send the request without checking the request body.
+Default Value
+false
|
@@ -90,9 +104,16 @@
String
|
-Specifies the ID of the system image used for creating ECSs. The ID is in Universally Unique Identifier (UUID) format.
+ | Definition
+Specifies the ID of the system image used for creating ECSs. The ID is in the format of a Universally Unique Identifier (UUID).
+You can obtain the image ID from the console or by following the instructions provided in "Querying Images" in Image Management Service API Reference.
+Constraints
NOTE: - Certain ECS flavors cannot support all public images provided on the cloud platform. To obtain the images supported by an ECS flavor, log in to the management console, view the images displayed on the Create ECS page, and obtain the image IDs on the Image Management Service page.
- If the creation fails, modify the parameter settings.
+Range
+N/A
+Default Value
+N/A
|
flavorRef
@@ -101,8 +122,15 @@
|
String
|
-Specifies the flavor ID of the ECS to be created.
+ | Definition
+Specifies the flavor ID of the ECS to be created.
For details about the flavors that have been released, see "ECS Specifications and Types" in Elastic Cloud Server User Guide.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
|
name
@@ -111,11 +139,14 @@
|
String
|
-Specifies the ECS name.
-Value range:
-- The parameter value consists of 1 to 128 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
- If more than one ECS is to be created (the count value is greater than 1), the system automatically adds a hyphen followed by a four-digit incremental number, such as -0000, to the end of each ECS name. If you specify a number, the name of the first new ECS will start from the specified number. In this case, the ECS name contains a maximum of 59 characters.
NOTE: ECS hostnames comply with RFC952 and RFC1123 naming rules. It is recommended that you configure hostnames using digits, lower-case letters, and hyphens (-).
-
-
+ | Definition
+Specifies the ECS name.
+Constraints
+- If more than one ECS is to be created (the count value is greater than 1), the system automatically adds a hyphen followed by a four-digit incremental number, such as -0000, to the end of each ECS name. If you specify a number, the name of the first new ECS will start from the specified number. In this case, the ECS name contains 1 to 59 characters.
- ECS hostnames comply with RFC 952 and RFC 1123 naming rules. It is recommended that you configure hostnames using digits (0 to 9), lowercase letters (a to z), and hyphens (-). Underscores (_) are converted into hyphens (-) by default.
+Range
+The parameter value consists of 1 to 128 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
+Default Value
+N/A
|
user_data
@@ -124,10 +155,8 @@
|
String
|
-Specifies the user data to be injected to the ECS during the creation. Text and text files can be injected.
- NOTE: - The content of user_data must be encoded with base64.
- The maximum size of the content to be injected (before encoding) is 32 KB.
- If the user_data field is specified for a Linux ECS that is created using an image with Cloud-Init installed, the adminPass field becomes invalid.
-
-For more information about the user data to be injected, see "Injecting User Data into ECSs" in the Elastic Cloud Server User Guide.
+ | Definition
+Specifies the user data to be injected to the ECS during the creation. Text and text files can be injected.
Examples
Before base64 encoding:
- Linux
#!/bin/bash
@@ -139,6 +168,13 @@ echo 111 > c:\aaa.txt
+For more information about the user data to be injected, see "Injecting User Data into ECSs" in Elastic Cloud Server User Guide.
+Constraints
+- The content of user_data must be encoded with base64.
- The maximum size of the content to be injected (before encoding) is 32 KB.
- If the user_data field is specified for a Linux ECS that is created using an image with Cloud-Init installed, the adminPass field becomes invalid.
+Range
+N/A
+Default Value
+N/A
|
adminPass
@@ -147,9 +183,14 @@ echo 111 > c:\aaa.txt
|
String
|
-Specifies the initial login password of the administrator account for logging in to an ECS using password authentication. The Linux administrator is root, and the Windows administrator is Administrator. For details, see Function.
-Password complexity requirements: - The password must contain 8 to 26 characters.
- The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (!@$%^-_=+[{}]:,./?~#*).
- The password cannot contain the username or the username in reverse.
- The Windows ECS password cannot contain the username, the username in reverse, or more than two consecutive characters in the username.
+ Definition
+Specifies the initial login password of the administrator account for logging in to an ECS using password authentication. The Linux administrator is root, and the Windows administrator is Administrator. For details, see Function.
+Constraints
+- The password cannot contain the username or the username in reverse.
- The Windows ECS password cannot contain the username, the username in reverse, or more than two consecutive characters in the username.
- If the user_data field is specified for a Linux ECS that is created using an image with Cloud-Init installed, the adminPass field becomes invalid.
- If the key_name field is specified for an ECS that is created using an image with Cloud-Init installed, the adminPass field becomes invalid.
+Range- The password must contain 8 to 26 characters.
- The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (!@$%^-_=+[{}]:,./?~#*).
+Default Value
+N/A
|
|
key_name
@@ -158,8 +199,15 @@ echo 111 > c:\aaa.txt
|
String
|
-Specifies the name of the SSH key used for logging in to the ECS.
+ | Definition
+Specifies the name of the SSH key used for logging in to the ECS.
Keys can be created using the key creation API (Creating and Importing an SSH Key Pair) or obtained using the SSH key query API (Querying SSH Key Pairs).
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
|
vpcid
@@ -168,8 +216,15 @@ echo 111 > c:\aaa.txt
|
String
|
-Specifies the ID of the VPC to which the ECS belongs. The value is in the format of the UUID.
+ | Definition
+Specifies the ID of the VPC to which the ECS belongs. The value is in the format of the UUID.
You can obtain the VPC ID from the management console or by following the instructions provided in "Querying VPCs" in Virtual Private Cloud API Reference.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
|
nics
@@ -178,10 +233,15 @@ echo 111 > c:\aaa.txt
|
Array of objects
|
-Specifies the NIC information of the ECS. For details, see Table 4.
-Constraints:
+ | Definition
+Specifies the NIC information of the ECS. For details, see Table 4.
+Constraints
- The value must be the ID of the subnet created in the VPC specified by vpcid and in the format of the UUID.
- A maximum of 12 NICs can be attached to an ECS.
+Range
+N/A
+Default Value
+N/A
|
publicip
@@ -190,9 +250,16 @@ echo 111 > c:\aaa.txt
|
Object
|
-Specifies the EIP bound to the ECS, which can be configured in one of the following ways:
+ | Definition
+Specifies the EIP bound to the ECS, which can be configured in one of the following ways:
- Do not use: In such a case, this parameter is unavailable.
- Automatically assign: You need to specify the information about the EIP to be created.
- Use existing: You need to specify an existing EIP for your ECS.
For details, see Table 1.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
|
count
@@ -201,9 +268,14 @@ echo 111 > c:\aaa.txt
|
Integer
|
-Specifies the number of ECSs to be created.
-Constraints:
-- If this parameter is not specified, the default value is 1.
- If the quota is sufficient, the maximum value is 500.
+ | Definition
+Specifies the number of instances to be created.
+Constraints
+- If this parameter is not specified, the default value is 1.
- If the tenant quota is sufficient, the maximum value is 100.
+Range
+N/A
+Default Value
+N/A
|
root_volume
@@ -212,8 +284,15 @@ echo 111 > c:\aaa.txt
|
Object
|
-Specifies ECS system disk configurations.
+ | Definition
+Specifies ECS system disk configurations.
For details, see Table 5.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
|
data_volumes
@@ -222,9 +301,15 @@ echo 111 > c:\aaa.txt
|
Array of objects
|
-Specifies ECS data disk configurations. Each data structure represents a data disk to be created.
-An ECS can be attached with a maximum of 59 data disks (certain flavors support only 23 data disks).
+ | Definition
+Specifies ECS data disk configurations. Each data structure represents a data disk to be created.
+Constraints
+An ECS can be attached with a maximum of 59 data disks (certain flavors support only 23 data disks).
For details, see Table 6.
+Range
+N/A
+Default Value
+N/A
|
security_groups
@@ -233,9 +318,15 @@ echo 111 > c:\aaa.txt
|
Array of objects
|
-Specifies the security groups of the ECS.
+ | Definition
+Specifies the security groups of the ECS.
+Constraints
If this parameter is left blank, the default security group is bound to the ECS by default.
For details, see Table 2.
+Range
+N/A
+Default Value
+N/A
|
availability_zone
@@ -244,10 +335,15 @@ echo 111 > c:\aaa.txt
|
String
|
-Specifies the name of the AZ where the ECS is located.
- NOTE: If this parameter is not specified, the system automatically selects an AZ.
-
+ | Definition
+Specifies the name of the AZ where the ECS is located.
See Querying AZs.
+Constraints
+- If this parameter is not specified, the system automatically selects an AZ.
+Range
+N/A
+Default Value
+N/A
|
batch_create_in_multi_az
@@ -256,11 +352,16 @@ echo 111 > c:\aaa.txt
|
Boolean
|
-Specifies whether ECSs can be deployed in multiple random AZs. The default value is false.
-- true: The batch created ECSs are deployed in multiple AZs.
- false: The batch created ECSs are deployed in a single AZ.
+ | Definition
+Specifies whether ECSs can be randomly deployed in multiple AZs.
+Constraints
This parameter is valid when availability_zone is left blank.
NOTE: When ECSs are created in batches, parameter count is mandatory.
+Range
+- true: The batch-created ECSs are deployed in multiple AZs.
- false: The batch-created ECSs are deployed in a single AZ.
+Default Value
+false
|
extendparam
@@ -269,8 +370,15 @@ echo 111 > c:\aaa.txt
|
Object
|
-Provides the supplementary information about the ECS to be created.
+ | Definition
+Provides the supplementary information about the ECS to be created.
For details, see Table 7.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
|
metadata
@@ -279,11 +387,15 @@ echo 111 > c:\aaa.txt
|
Object
|
-Specifies the metadata of the ECS to be created.
-You can use metadata to customize key-value pairs.
- NOTE: - If the metadata contains sensitive data, take appropriate measures to protect the sensitive data, for example, controlling access permissions and encrypting the data.
- A maximum of 10 key-value pairs can be injected.
- A metadata key consists of 1 to 255 characters and contains only uppercase letters, lowercase letters, spaces, digits, hyphens (-), underscores (_), colons (:), and decimal points (.).
- A metadata value consists of a maximum of 255 characters.
-
-For details about reserved key-value pairs, see Table 9.
+ | Definition
+Specifies the metadata of the ECS to be created.
+You can use metadata to customize key-value pairs. For details about reserved key-value pairs, see Table 9.
+Constraints
+If the metadata contains sensitive data, take appropriate measures to protect the sensitive data, for example, controlling access permissions and encrypting the data.
+Range
+- A maximum of 10 key-value pairs can be injected.
- A metadata key consists of 1 to 255 characters and can only contain uppercase letters, lowercase letters, spaces, digits, hyphens (-), underscores (_), colons (:), and periods (.).
- A metadata value consists of a maximum of 255 characters.
+Default Value
+N/A
|
os:scheduler_hints
@@ -292,8 +404,15 @@ echo 111 > c:\aaa.txt
|
Object
|
-Schedules ECSs, for example, by configuring an ECS group.
+ | Definition
+Schedules ECSs, for example, by configuring an ECS group.
For details, see Table 10.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
|
tags
@@ -302,12 +421,15 @@ echo 111 > c:\aaa.txt
|
Array of strings
|
-Specifies ECS tags.
-A tag is in the format of "key.value", where the maximum lengths of key and value are 36 and 43 characters, respectively.
-When adding a tag to an ECS, ensure that the tag complies with the following requirements:
-- The key of the tag can contain only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-).
- The value of the tag can contain only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-).
- NOTE: - Each ECS supports up to 10 tags during the creation.
-
+ | Definition
+Specifies ECS tags. A tag is in the format of "key.value".
+Constraints
+- Each ECS supports a maximum of 10 tags during the creation.
- The server_tags field provides the same functions as tags, but supports more keys and values, so the server_tags field is recommended.
+A tag key contains a maximum of 36 characters, and a tag value contains a maximum of 43 characters.
+Range
+- A tag key contains a maximum of 36 characters, and a tag value contains a maximum of 43 characters.
- The key of the tag can contain only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-).
- The value of the tag can contain only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-).
+Default Value
+N/A
|
description
@@ -316,8 +438,14 @@ echo 111 > c:\aaa.txt
|
String
|
-Specifies the description of an ECS, which is empty by default.
-- Can contain a maximum of 85 characters.
- Cannot contain an angle bracket < or >.
+ | Definition
+Specifies the ECS description.
+Constraints
+Angle brackets (<>) are not allowed.
+Range
+A maximum of 85 characters are allowed.
+Default Value
+Empty string
|
@@ -340,8 +468,14 @@ echo 111 > c:\aaa.txt
String
|
-Specifies the subnet of the ECS.
-The value must be the ID of the subnet created in the VPC specified by vpcid and in the format of the UUID.
+ | Definition
+Specifies the subnet of the ECS.
+Constraints
+The value must be the ID of the subnet created in the VPC specified by vpcid and in the format of the UUID.
+Range
+N/A
+Default Value
+N/A
|
ip_address
@@ -350,9 +484,14 @@ echo 111 > c:\aaa.txt
|
String
|
-Specifies the IP address of the NIC used by the ECS. The value is an IPv4 address.
-Constraints: - If this parameter is left blank or set to "", an unused IP address in the subnet is automatically assigned as the IP address of the NIC.
- If this parameter is specified, its value must be an unused IP address in the network segment of the subnet.
+ Definition
+Specifies the IP address of the NIC used by the ECS. The value is an IPv4 address.
+Constraints- If this parameter is left blank or set to "", an unused IP address in the subnet is automatically assigned as the IP address of the NIC.
- If this parameter is specified, its value must be an unused IP address in the network segment of the subnet.
+Range
+N/A
+Default Value
+N/A
|
|
binding:profile
@@ -361,7 +500,14 @@ echo 111 > c:\aaa.txt
|
Object
|
-Allows you to customize data. Configure this parameter when creating an ECS. For details, see Table 12.
+ | Definition
+Allows you to customize data. For details, see Table 12.
+Constraints
+This parameter can be specified only during the ECS creation.
+Range
+N/A
+Default Value
+N/A
|
extra_dhcp_opts
@@ -370,7 +516,14 @@ echo 111 > c:\aaa.txt
|
Array of objects
|
-Indicates extended DHCP options. For details, see Table 13.
+ | Definition
+Indicates extended DHCP options. For details, see Table 13.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
|
ipv6_enable
@@ -379,7 +532,14 @@ echo 111 > c:\aaa.txt
|
Boolean
|
-Specifies whether to support IPv6 addresses. If this parameter is set to true, the NIC supports IPv6 addresses.
+ | Definition
+Specifies whether to support IPv6 addresses.
+Constraints
+N/A
+Range
+- true: The NIC supports IPv6.
- false: The NIC does not support IPv6.
+Default Value
+false
|
ipv6_bandwidth
@@ -388,7 +548,14 @@ echo 111 > c:\aaa.txt
|
Object
|
-Specifies the bound shared bandwidth. For details, see ipv6_bandwidth Field Description.
+ | Definition
+Specifies the bound shared bandwidth. For details, see ipv6_bandwidth Field Description.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
|
@@ -411,13 +578,18 @@ echo 111 > c:\aaa.txt
String
|
-Specifies the ECS system disk type, which must be one of available disk types.
-The value can be ESSD, GPSSD2, GPSSD, SSD, SAS, or SATA. - SSD: the ultra-high I/O type
- SAS: the high I/O type
- SATA: the common I/O type
- GPSSD: the general purpose SSD type
- ESSD: the extreme SSD type
- GPSSD2: the general purpose SSD V2 type
+ Definition
+Specifies the disk type of an ECS system disk.
+For details about disk types, see "Disk Types and Performance" in Elastic Volume Service User Guide.
+Constraints
+- The disk type must match that provided by the system.
- If the specified disk type is not available in the AZ specified by availability_zone, the disk creation will fail.
- When the disk is created from a backup:
If the type of the backup's source disk is SSD, SAS, SATA, GPSSD, ESSD, or GPSSD2, you can create disks of any of these types.
+If the type of the backup's source disk is co-p1 or uh-l1, you can create disks of any of the two types.
+
+Range
+The value can be ESSD, GPSSD2, GPSSD, SSD, SAS, or SATA. - SSD: the ultra-high I/O type
- SAS: the high I/O type
- SATA: the common I/O type (end-of-sale)
- GPSSD: the general purpose SSD type
- ESSD: the extreme SSD type
- GPSSD2: the general purpose SSD V2 type
If the specified disk type is not available in the AZ, the disk will fail to be created.
- NOTE: - When the disk is created from a backup:
If the type of the backup's source disk is SSD, SAS, SATA, GPSSD, ESSD, or GPSSD2, you can create disks of any of these types.
- - For details about disk types, see Disk Types and Disk Performance in the Elastic Volume Service User Guide.
-
+Default Value
+N/A
|
size
@@ -426,11 +598,16 @@ echo 111 > c:\aaa.txt
|
Integer
|
-Specifies the system disk size in GB. The value ranges from 1 to 1024.
-Constraints:
+ | Definition
+Specifies the system disk size, in GiB.
+Constraints
- The system disk size must be greater than or equal to the minimum system disk size supported by the image (min_disk attribute of the image).
- If this parameter is not specified or is set to 0, the default system disk size is the minimum value of the system disk in the image (min_disk attribute of the image).
NOTE: To obtain the minimum system disk size (min_disk) of an image, click the image on the management console for its details. Alternatively, call the native OpenStack API for querying details about an image. For details, see "Querying Image Details (Native OpenStack)" in Image Management Service API Reference.
+Range
+1 to 1024
+Default Value
+N/A
|
hw:passthrough
@@ -439,8 +616,14 @@ echo 111 > c:\aaa.txt
|
Boolean
|
-Specifies the device type of the EVS disks to be created. - If this parameter is set to false, VBD disks are created.
- If this parameter is set to true, SCSI disks are created.
- If this parameter is not specified or set to a non-Boolean character, VBD disks are created by default.
+ Definition
+Specifies the device type of the EVS disks to be created.
+Constraints
+N/A
+Range- If this parameter is set to false, VBD disks are created.
- If this parameter is set to true, SCSI disks are created.
+Default Value
+If this parameter is not specified or set to a non-Boolean character, VBD disks are created by default.
|
|
metadata
@@ -449,9 +632,14 @@ echo 111 > c:\aaa.txt
|
Object
|
-Specifies the EVS disk metadata. Ensure that key and value in the metadata contain at most 255 bytes.
-This field is used only when an encrypted disk is created.
-For details, see metadata Field Description for Creating Disks.
+ | Definition
+Specifies the metadata of the created EVS disk. For details, see metadata Field Description for Creating Disks.
+Constraints
+This parameter is used only when an encrypted disk is created.
+Range
+The length of key and value under metadata can contain no more than 255 bytes.
+Default Value
+N/A
|
@@ -474,13 +662,18 @@ echo 111 > c:\aaa.txt
|
String
|
-Specifies the type of the ECS data disk, which must be one of available disk types.
-The value can be ESSD, GPSSD2, GPSSD, SSD, SAS, or SATA. - SSD: the ultra-high I/O type
- SAS: the high I/O type
- SATA: the common I/O type
- GPSSD: the general purpose SSD type
- ESSD: the extreme SSD type
- GPSSD2: the general purpose SSD V2 type
+ Definition
+Specifies the disk type of an ECS data disk.
+For details about disk types, see "Disk Types and Performance" in Elastic Volume Service User Guide.
+Constraints
+- The disk type must match that provided by the system.
- If the specified disk type is not available in the AZ specified by availability_zone, the disk creation will fail.
- When the disk is created from a backup:
If the type of the backup's source disk is SSD, SAS, SATA, GPSSD, ESSD, or GPSSD2, you can create disks of any of these types.
+If the type of the backup's source disk is co-p1 or uh-l1, you can create disks of any of the two types.
+
+Range
+The value can be ESSD, GPSSD2, GPSSD, SSD, SAS, or SATA. - SSD: the ultra-high I/O type
- SAS: the high I/O type
- SATA: the common I/O type (end-of-sale)
- GPSSD: the general purpose SSD type
- ESSD: the extreme SSD type
- GPSSD2: the general purpose SSD V2 type
If the specified disk type is not available in the AZ, the disk will fail to be created.
- NOTE: - When the disk is created from a backup:
If the type of the backup's source disk is SSD, SAS, SATA, GPSSD, ESSD, or GPSSD2, you can create disks of any of these types.
- - For details about disk types, see Disk Types and Disk Performance in the Elastic Volume Service User Guide.
-
+Default Value
+N/A
|
size
@@ -489,8 +682,14 @@ echo 111 > c:\aaa.txt
|
Integer
|
-Specifies the data disk size, in GB. The value ranges from 10 to 32768.
+ | Definition
+Specifies the data disk size, in GiB.
+Constraints
When you use a data disk image to create a data disk, ensure that the value of this parameter is greater than or equal to the size of the source data disk that is used to create the data disk image.
+Range
+10 to 32768
+Default Value
+N/A
|
shareable
@@ -499,9 +698,14 @@ echo 111 > c:\aaa.txt
|
Boolean
|
-Specifies whether the disk is shared. The value can be true (specifies a shared disk) or false (a common EVS disk).
- NOTE: This field has been discarded. Use multiattach.
-
+ | Definition
+Specifies whether the disk is shared.
+Constraints
+This parameter has been discarded. Use multiattach.
+Range
+- true: indicates that the created disk is a shared disk.
- false: indicates that the created disk is a common EVS disk.
+Default Value
+false
|
multiattach
@@ -510,10 +714,14 @@ echo 111 > c:\aaa.txt
|
Boolean
|
-Specifies the shared disk information.
+ | Definition
+Specifies the shared disk information.
+Constraints
+The shareable parameter is discarded. If both shareable and multiattach must be used, ensure that the values of the two parameters are the same. If this parameter is not specified, common EVS disks are created by default.
+Range
- true: indicates that the created disk is a shared disk.
- false: indicates that the created disk is a common EVS disk.
- NOTE: The shareable field is not used anymore. If both shareable and multiattach must be used, ensure that the values of the two fields are the same. If this parameter is not specified, common EVS disks are created by default.
-
+Default Value
+false
|
hw:passthrough
@@ -522,8 +730,14 @@ echo 111 > c:\aaa.txt
|
Boolean
|
-Specifies the device type of the EVS disks to be created. - If this parameter is set to false, VBD disks are created.
- If this parameter is set to true, SCSI disks are created.
- If this parameter is not specified or set to a non-Boolean character, VBD disks are created by default.
+ Definition
+Specifies the device type of the EVS disks to be created.
+Constraints
+N/A
+Range- If this parameter is set to false, VBD disks are created.
- If this parameter is set to true, SCSI disks are created.
- If this parameter is not specified or set to a non-Boolean character, VBD disks are created by default.
+Default Value
+N/A
|
|
extendparam
@@ -532,8 +746,15 @@ echo 111 > c:\aaa.txt
|
Object
|
-Provides the disk information.
+ | Definition
+Provides the disk information.
For details, see Table 6.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
|
data_image_id
@@ -542,8 +763,14 @@ echo 111 > c:\aaa.txt
|
String
|
-Specifies ID of the data image. The value is in UUID format.
+ | Definition
+Specifies ID of the data image. The value is in UUID format.
+Constraints
If data disks are created using a data disk image, this parameter is mandatory and it does not support metadata.
+Range
+N/A
+Default Value
+N/A
|
metadata
@@ -552,10 +779,45 @@ echo 111 > c:\aaa.txt
|
Object
|
-Specifies the EVS disk metadata. Ensure that key and value in the metadata contain at most 255 bytes.
-This field is used only when an encrypted disk is created.
-If data disks are created using a data disk image, this field cannot be used.
+ | Definition
+Specifies the metadata of the created EVS disk.
For details, see metadata Field Description for Creating Disks.
+Constraints
+- The length of key and value under metadata can contain no more than 255 bytes.
- This parameter is used only when an encrypted disk is created.
- If data disks are created using a data disk image, this parameter cannot be used.
+Range
+N/A
+Default Value
+N/A
+ |
+
+
+ |
+ Table 7 security_options field descriptionParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+tpm_enabled
+ |
+Yes
+ |
+Boolean
+ |
+Definition
+Specifies whether to enable TPM.
+Constraints
+Currently, the following instance types support TPM: Pi5e.
+Range
+- true: Enable TPM.
- false: Disable TPM.
+Default Value
+false
|
@@ -575,23 +837,28 @@ echo 111 > c:\aaa.txt
String
|
-Specifies the returned task ID after delivering the task. You can query the task progress using this ID. For details about how to query the task execution status based on job_id, see Task Status Management.
+ | Definition
+Specifies the returned job ID after delivering the job. You can query the job progress using this ID. For details about how to query the job execution status based on job_id, see Job Status Management.
+Range
+N/A
|
serverIds
|
Array of strings
|
-Specifies ECS IDs.
+ | Definition
+Specifies ECS IDs.
NOTE: You can query ECS details by ECS ID. If the system returns a 404 error, the ECS is being created, or creating the ECS failed.
-
+Range
+N/A
|
For details about abnormal responses, see Responses (Task).
+For details about abnormal responses, see Responses (Jobs).
Example Request- Create a pay-per-use ECS with 2 vCPUs, 16 GiB of memory, private image imageid_123, SSD disks attached, and 10 Mbit/s of bandwidth-billed EIP bound. Use the key pair for login authentication.
POST https://{endpoint}/v1/{project_id}/cloudservers
@@ -646,7 +913,7 @@ echo 111 > c:\aaa.txt
"count": 1
}
}
- - Use a full-ECS image with an encrypted system disk and two data disks attached to create an ECS. For the two data disks to be restored, one uses default settings, and the other uses the changed settings, SSD, 100 GB. Also, attach a 50 GB SSD disk to the ECS.
POST https://{endpoint}/v1/{project_id}/cloudservers
+ - Use a full-ECS image with an encrypted system disk and two data disks to create an ECS. For the two data disks to be restored, one uses default settings, and the other uses the changed settings, SSD, 100 GiB. Also, attach a 50 GiB SSD disk to the ECS.
POST https://{endpoint}/v1/{project_id}/cloudservers
{
"server": {
diff --git a/docs/ecs/api-ref/en-us_topic_0020212672.html b/docs/ecs/api-ref/en-us_topic_0020212672.html
index 22ad9aa1a..1e8e69de9 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212672.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212672.html
@@ -32,7 +32,7 @@
Yes
|
-Specifies the disk ID.
+ | Specifies the volume ID.
|
|
|---|
diff --git a/docs/ecs/api-ref/en-us_topic_0020212674.html b/docs/ecs/api-ref/en-us_topic_0020212674.html
index 730ac4a70..74a400030 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212674.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212674.html
@@ -40,7 +40,10 @@
Object
|
-Specifies tenant quotas. For details, see Table 3.
+ | Definition
+Specifies tenant quotas. For details, see Table 3.
+Range
+N/A
|
@@ -59,137 +62,194 @@
Integer
|
-Specifies the maximum number of ECSs that can be requested.
+ | Definition
+Specifies the maximum number of ECSs that can be requested.
+Range
+N/A
|
maxTotalCores
|
Integer
|
-Specifies the maximum number of CPU cores that the current tenant can apply for.
+ | Definition
+Specifies the maximum number of CPU cores that the current tenant can apply for.
+Range
+N/A
|
maxTotalRAMSize
|
Integer
|
-Specifies the maximum memory space (MB) you can use.
+ | Definition
+Specifies the maximum memory size (MiB) allowed.
+Range
+N/A
|
maxTotalKeypairs
|
Integer
|
-Specifies the maximum number of SSH key pairs you can use.
+ | Definition
+Specifies the maximum number of SSH key pairs you can use.
+Range
+N/A
|
maxServerMeta
|
Integer
|
-Specifies the maximum length of the metadata you can use.
+ | Definition
+Specifies the maximum length of the metadata you can use.
+Range
+N/A
|
maxPersonality
|
Integer
|
-Specifies the maximum number of files that can be injected.
+ | Definition
+Specifies the maximum number of files that can be injected.
+Range
+N/A
|
maxPersonalitySize
|
Integer
|
-Specifies the maximum size (byte) of the file to be injected.
+ | Definition
+Specifies the maximum size (byte) of the file to be injected.
+Range
+N/A
|
maxServerGroups
|
Integer
|
-Specifies the maximum number of server groups.
+ | Definition
+Specifies the maximum number of server groups.
+Range
+N/A
|
maxServerGroupMembers
|
Integer
|
-Specifies the maximum number of ECSs in an ECS group.
+ | Definition
+Specifies the maximum number of ECSs in an ECS group.
+Range
+N/A
|
totalServerGroupsUsed
|
Integer
|
-Specifies the number of used server groups.
+ | Definition
+Specifies the number of used server groups.
+Range
+N/A
|
maxSecurityGroups
|
Integer
|
-Specifies the maximum number of security groups you can use.
+ | Definition
+Specifies the maximum number of security groups you can use.
NOTE: The quota complies with the VPC quota limit.
+Range
+N/A
|
maxSecurityGroupRules
|
Integer
|
-Specifies the maximum number of security group rules that you can configure in a security group.
+ | Definition
+Specifies the maximum number of security group rules that you can configure in a security group.
NOTE: The quota complies with the VPC quota limit.
+Range
+N/A
|
maxTotalFloatingIps
|
Integer
|
-Specifies the maximum number of floating IP addresses you can use.
+ | Definition
+Specifies the maximum number of floating IP addresses you can use.
+Range
+N/A
|
maxImageMeta
|
Integer
|
-Specifies the maximum length of the image metadata.
+ | Definition
+Specifies the maximum length of the image metadata.
+Range
+N/A
|
totalInstancesUsed
|
Integer
|
-Specifies the number of used ECSs.
+ | Definition
+Specifies the number of used ECSs.
+Range
+N/A
|
totalCoresUsed
|
Integer
|
-Specifies the number of the used CPU cores.
+ | Definition
+Specifies the number of the used CPU cores.
+Range
+N/A
|
totalRAMUsed
|
Integer
|
-Specifies the used memory size (MB).
+ | Definition
+Specifies the used memory size (MiB).
+Range
+N/A
|
totalSecurityGroupsUsed
|
Integer
|
-Specifies the number of used security groups.
+ | Definition
+Specifies the number of used security groups.
+Range
+N/A
|
totalFloatingIpsUsed
|
Integer
|
-Specifies the number of used floating IP addresses.
+ | Definition
+Specifies the number of used floating IP addresses.
+Range
+N/A
|
diff --git a/docs/ecs/api-ref/en-us_topic_0020212676.html b/docs/ecs/api-ref/en-us_topic_0020212676.html
index 9df748b3d..f73b3fb18 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212676.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212676.html
@@ -67,7 +67,7 @@
Table 4 keypair field descriptionParameter
+Table 4 keypair field descriptionParameter
|
Type
|
diff --git a/docs/ecs/api-ref/en-us_topic_0020212678.html b/docs/ecs/api-ref/en-us_topic_0020212678.html
index c233dbf32..25cd3241f 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212678.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212678.html
@@ -131,7 +131,7 @@
|---|
Table 5 keypair field descriptionParameter
+Table 5 keypair field descriptionParameter
|
Type
|
@@ -179,7 +179,7 @@
String
|
-Specifies the key type. The value is ssh or x509.
+ | Specifies the key type. The value is ssh or x509.
This parameter is supported in microversion 2.2 and later.
|
|---|
diff --git a/docs/ecs/api-ref/en-us_topic_0020212679.html b/docs/ecs/api-ref/en-us_topic_0020212679.html
index 852215117..d8d62f4e7 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212679.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212679.html
@@ -2,7 +2,7 @@
Deleting ECSs
FunctionThis API is used to delete ECSs based on a specified ECS ID list.
- This API is an asynchronous API. After the deletion request is successfully delivered, a job ID is returned. This does not mean the deletion is complete. You need to call the API by referring to Querying Task Execution Status to query the job status. The SUCCESS status indicates that the deletion is successful.
+ This API is an asynchronous API. After the deletion request is successfully delivered, a job ID is returned. This does not mean the deletion is complete. You need to call the API by referring to Querying Job Execution Status to query the job status. The SUCCESS status indicates that the deletion is successful.
You can delete a single ECS or multiple ECSs in a batch. A maximum of 1,000 ECSs can be deleted in a batch.
URIPOST /v1/{project_id}/cloudservers/delete
@@ -44,8 +44,14 @@
Array of objects
|
- Specifies the ECSs to be deleted. For details, see Table 3.
+ | Definition
+Specifies the ECSs to be deleted. For details, see Table 3.
+Constraints
A maximum of 1,000 ECSs can be deleted at a time.
+Range
+N/A
+Default Value
+N/A
|
delete_publicip
@@ -54,12 +60,15 @@
|
Boolean
|
-Specifies whether to delete the EIP bound to the ECS when deleting the ECS. If you do not want to delete the EIP, the system only unbinds the EIP from the ECS and reserves the EIP.
-The value can be true or false.
+ | Definition
+Specifies whether to delete the EIP bound to the ECS when deleting the ECS. If you do not want to delete the EIP, the system only unbinds the EIP from the ECS and reserves the EIP.
+Constraints
+If delete_publicip is not specified, the delete_on_termination value of the EIP decides whether the EIP is released when the ECS is deleted.
+- If delete_on_termination is true and delete_public is null, the EIP is released when the ECS is deleted.
- If delete_on_termination is false and delete_public is null, the EIP is only unbound from the ECS and will not be released when the ECS is deleted.
+Range
- true: When an ECS is deleted, the EIP bound to the ECS is also released regardless of whether delete_on_termination of the EIP is true or false.
- false: When an ECS is deleted, the EIP is only unbound from the ECS and will not be released regardless of whether delete_on_termination of the EIP is true or false.
- NOTE: If delete_publicip is not specified, the delete_on_termination value of the EIP decides whether the EIP is released when the ECS is deleted.
- - If delete_on_termination is true and delete_public is null, the EIP is released when the ECS is deleted.
- If delete_on_termination is false and delete_public is null, the EIP is only unbound from the ECS and will not be released when the ECS is deleted.
-
+Default Value
+false
|
delete_volume
@@ -68,8 +77,14 @@
|
Boolean
|
-Specifies whether to delete the data disks attached to an ECS when deleting the ECS. If you set the parameter value to false, the system only detaches the disks from the ECS and reserves the disks. The default value is false.
+ | Definition
+Specifies whether to delete the data disks attached to an ECS when deleting the ECS. If you set the parameter value to false, the system only detaches the disks from the ECS and reserves the disks.
+Constraints
+N/A
+Range
- true: indicates to delete the data disks attached to the ECS when deleting the ECS.
- false: indicates only to detach the data disks attached to the ECS when deleting the ECS.
+Default Value
+false
|
@@ -92,7 +107,14 @@
String
|
- Specifies the ID of the ECS to be deleted.
+ | Definition
+Specifies the ID of the ECS to be deleted.
+Constraints
+N/A
+Range
+N/A
+Default Value
+N/A
|
@@ -100,7 +122,7 @@
ResponseSee Responses (Task).
+
Example Request- Delete the ECS whose ID is 616fb98f-46ca-475e-917e-2563e5a8cd19, unbind the EIP, and detach data disks.
POST https://{endpoint}/v1/{project_id}/cloudservers/delete
diff --git a/docs/ecs/api-ref/en-us_topic_0020212688.html b/docs/ecs/api-ref/en-us_topic_0020212688.html
index 0e466ac71..2e93e557a 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212688.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212688.html
@@ -3,7 +3,7 @@
Querying the ECS List
FunctionThis API is used to query ECSs.
- URIGET /v2.1/{project_id}/servers?changes-since={changes-since}&image={image}&flavor={flavor}&name={name}&status={status}&limit={limit}&marker={marker}¬-tags={not-tags}&reservation_id={reservation_id}&ip={ip}
+ URIGET /v2.1/{project_id}/servers?changes-since={changes-since}&image={image}&flavor={flavor}&name={name}&status={status}&limit={limit}&marker={marker}¬-tags={not-tags}&reservation_id={reservation_id}&ip={ip}
GET /v2/{project_id}/servers?changes-since={changes-since}&image={image}&flavor={flavor}&name={name}&status={status}&limit={limit}&marker={marker}¬-tags={not-tags}&reservation_id={reservation_id}&ip={ip}
Table 1 describes the parameters in the URI.
Table 1 Path parametersParameter
diff --git a/docs/ecs/api-ref/en-us_topic_0020212689.html b/docs/ecs/api-ref/en-us_topic_0020212689.html
index 15289b33e..610d18c8c 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212689.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212689.html
@@ -3,7 +3,7 @@
Querying Details About ECSs
FunctionThis API is used to query details about ECSs.
- URIGET /v2.1/{project_id}/servers/detail?changes-since={changes-since}&image={image}&flavor={flavor}&name={name}&status={status}&limit={limit}&marker={marker}¬-tags={not-tags}&reservation_id={reservation_id}&ip={ip}
+ URIGET /v2.1/{project_id}/servers/detail?changes-since={changes-since}&image={image}&flavor={flavor}&name={name}&status={status}&limit={limit}&marker={marker}¬-tags={not-tags}&reservation_id={reservation_id}&ip={ip}
GET /v2/{project_id}/servers/detail?changes-since={changes-since}&image={image}&flavor={flavor}&name={name}&status={status}&limit={limit}&marker={marker}¬-tags={not-tags}&reservation_id={reservation_id}&ip={ip}
Table 1 describes the parameters in the URI.
Table 1 Path parametersParameter
@@ -81,7 +81,7 @@
| String
|
Specifies the ECS status.
-Value range:
+Options:
ACTIVE, BUILD, ERROR, HARD_REBOOT, MIGRATING, REBOOT, REBUILD, RESIZE, REVERT_RESIZE, SHUTOFF, and VERIFY_RESIZE
In microversion 2.37, the system will return an empty list for the status field out of the preceding options. In microversion 2.38 and later, the system will return error 400.
For details, see ECS Statuses.
@@ -216,7 +216,7 @@
| String
|
Specifies the ECS status.
-Value range:
+Options:
ACTIVE, BUILD, DELETED, ERROR, HARD_REBOOT, MIGRATING, PAUSED, REBOOT, REBUILD, RESIZE, REVERT_RESIZE, SHUTOFF, SHELVED, SHELVED_OFFLOADED, SOFT_DELETED, SUSPENDED, and VERIFY_RESIZE
For details, see ECS Statuses.
|
@@ -323,7 +323,7 @@
String
|
Specifies the disk configuration mode. This is an extended attribute. This field is valid for the ECS started using an image.
-Value range:
+Options:
- AUTO: This API uses a single partition to build an ECS with the target disk size. The API automatically adjusts the file system to adapt to the entire partition.
- MANUAL: This API uses the partitioning scheme in the source image and the file system to build the ECS. If the target disk size is large, the API does not partition the remaining disk space.
|
|---|
@@ -369,7 +369,7 @@
String
|
Specifies the ECS task status. This is an extended attribute.
-For details about options, see ECS Statuses.
+For details about the value range, see table 3 in ECS Statuses.
|
OS-EXT-STS:vm_state
@@ -377,7 +377,7 @@
| String
|
Specifies the ECS status. This is an extended attribute.
-Value range:
+Options:
ACTIVE, BUILDING, STOPPED, RESIZED, PAUSED, SUSPENDED, RESCUED, ERROR, DELETED, SOFT_DELETED, SHELVED, and SHELVED_OFFLOADED
For details, see ECS Statuses.
|
@@ -574,7 +574,7 @@
Integer
|
-Specifies the memory size (MB) in the ECS flavor.
+ | Specifies the memory size (MiB) in the ECS flavor.
This parameter is supported in microversion 2.47 and later.
|
@@ -702,14 +702,14 @@
String
|
-Specifies the EVS disk ID.
+ | Specifies the volume ID.
|
delete_on_termination
|
Boolean
|
-Specifies whether to delete additional disks when deleting the ECS.
+ | Specifies whether to delete attached disks when deleting the ECS.
By default, this parameter is set to False.
This parameter is supported in microversion 2.3 and later.
|
@@ -777,7 +777,7 @@
- Table 11 image field descriptionParameter
+Table 11 image field descriptionParameter
|
Type
|
diff --git a/docs/ecs/api-ref/en-us_topic_0020212690.html b/docs/ecs/api-ref/en-us_topic_0020212690.html
index ebf0cec69..dbc5520de 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212690.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212690.html
@@ -197,7 +197,7 @@
String
|
Specifies the disk configuration mode. This is an extended attribute. This field is valid for the ECS started using an image.
-Value range:
+Range:
- AUTO: This API uses a single partition to build an ECS with the target disk size. The API automatically adjusts the file system to adapt to the entire partition.
- MANUAL: This API uses the partitioning scheme in the source image and the file system to build the ECS. If the target disk size is large, the API does not partition the remaining disk space.
|
@@ -437,7 +437,7 @@
Integer
|
-Specifies the memory size (MB) in the ECS flavor.
+ | Specifies the memory size (MiB) in the ECS flavor.
This parameter is supported in microversion 2.47 and later.
|
|---|
@@ -590,14 +590,14 @@
String
|
-Specifies the EVS disk ID.
+ | Specifies the volume ID.
|
delete_on_termination
|
Boolean
|
-Specifies whether to delete additional disks when deleting the ECS.
+ | Specifies whether to delete attached disks when deleting the ECS.
By default, this parameter is set to False.
This parameter is supported in microversion 2.3 and later.
|
diff --git a/docs/ecs/api-ref/en-us_topic_0020212692.html b/docs/ecs/api-ref/en-us_topic_0020212692.html
index 3ec1e2144..0a317f85a 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212692.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212692.html
@@ -168,7 +168,7 @@
String
|
-Specifies the time when the ECS was created. The time is in the format of "2019-05-22T03:19:19Z".
+ | Specifies the ECS creation time. The time is in the format of "2019-05-22T03:19:19Z".
|
hostId
@@ -189,14 +189,14 @@
|
String
|
-Specifies the disk configuration mode. This is an extended attribute. This field is valid for the ECS started using an image.
+ | Specifies the disk configuration mode. This is an extended attribute. This parameter is valid for the ECS booted from an image.
|
user_id
|
String
|
-Specifies the ID of the user which an ECS belongs to.
+ | Specifies the ID of the user that an ECS belongs to.
|
name
@@ -224,7 +224,7 @@
|
String
|
-Specifies the unique ID of an ECS.
+ | Specifies the unique ID of the ECS.
|
updated
@@ -255,7 +255,7 @@
|
Array of strings
|
-Specifies ECS tags.
+ | Specifies the list of ECS tags.
This parameter is supported in microversion 2.26 and later. If the microversion is not used for query, the response does not contain the tags field.
Tag functions have been upgraded on the cloud platform. After the upgrade, the tag values returned by the system comply with the following rules: - The key and value of a tag are connected using an equal sign (=), for example, key=value.
- If the value is empty, only the key is returned.
|
Integer
|
-Specifies the memory size (MB) in the ECS flavor.
+ | Specifies the memory size (MiB) in the ECS flavor.
This parameter is supported in microversion 2.47 and later.
|
diff --git a/docs/ecs/api-ref/en-us_topic_0022067713.html b/docs/ecs/api-ref/en-us_topic_0022067713.html
index 89535dacd..6e86d2d24 100644
--- a/docs/ecs/api-ref/en-us_topic_0022067713.html
+++ b/docs/ecs/api-ref/en-us_topic_0022067713.html
@@ -1,10 +1,10 @@
-Task Request Result
+Job Request Results
-- Responses (Task)
+ - Responses (Jobs)
- Returned Values
diff --git a/docs/ecs/api-ref/en-us_topic_0022067714.html b/docs/ecs/api-ref/en-us_topic_0022067714.html
index 160ca5d7c..2ba57e159 100644
--- a/docs/ecs/api-ref/en-us_topic_0022067714.html
+++ b/docs/ecs/api-ref/en-us_topic_0022067714.html
@@ -1,6 +1,6 @@
-Responses (Task)
+Responses (Jobs)
- Normal response description
Parameter
|
@@ -14,7 +14,7 @@
String
|
-Specifies the returned task ID after delivering the task. Users can query the task progress using this ID. For details about how to query the task execution status based on job_id, see Task Status Management.
+ | Specifies the returned job ID after delivering the job. Users can query the job progress using this ID. For details about how to query the job execution status based on job_id, see Job Status Management.
|
|---|
@@ -114,7 +114,7 @@
diff --git a/docs/ecs/api-ref/en-us_topic_0022067715.html b/docs/ecs/api-ref/en-us_topic_0022067715.html
index f612c758f..b7781ee23 100644
--- a/docs/ecs/api-ref/en-us_topic_0022067715.html
+++ b/docs/ecs/api-ref/en-us_topic_0022067715.html
@@ -10,17 +10,17 @@
200
|
-The task is successfully delivered.
+ | The job is delivered.
|
202
|
-After the task is successfully delivered, the task to be delivered shall be postponed because the system is busy.
+ | The job is delivered. It will be processed with a delay because the system is busy.
|
204
|
-The task is successfully delivered.
+ | The job is delivered.
|
@@ -110,7 +110,7 @@
diff --git a/docs/ecs/api-ref/en-us_topic_0022067719.html b/docs/ecs/api-ref/en-us_topic_0022067719.html
index a75ec29e6..842db4f14 100644
--- a/docs/ecs/api-ref/en-us_topic_0022067719.html
+++ b/docs/ecs/api-ref/en-us_topic_0022067719.html
@@ -148,8 +148,8 @@
InfiniBand NIC status
|
This metric is used to monitor the status of an InfiniBand NIC on a high-performance h2 ECS to ensure proper InfiniBand NIC running.
-The system periodically checks the NIC status and returns check results using value 0 or 1.
-- 0: The system is running properly. That is, the InfiniBand NIC is functional.
- 1: The system is not running properly. That is, the InfiniBand NIC malfunctions.
+The system periodically checks the NIC status and returns check results using value 0 or 1.
+- 0: The system is running properly. That is, the InfiniBand NIC is functional.
- 1: The system is not running properly. That is, the InfiniBand NIC malfunctions.
|
0 or 1
|
diff --git a/docs/ecs/api-ref/en-us_topic_0022225397.html b/docs/ecs/api-ref/en-us_topic_0022225397.html
index 6feadf91e..a62ba7c48 100644
--- a/docs/ecs/api-ref/en-us_topic_0022225397.html
+++ b/docs/ecs/api-ref/en-us_topic_0022225397.html
@@ -1,10 +1,10 @@
-Task Status Management
+Job Status Management
diff --git a/docs/ecs/api-ref/en-us_topic_0022225398.html b/docs/ecs/api-ref/en-us_topic_0022225398.html
index 8da547b87..a7c6036b1 100644
--- a/docs/ecs/api-ref/en-us_topic_0022225398.html
+++ b/docs/ecs/api-ref/en-us_topic_0022225398.html
@@ -1,10 +1,10 @@
- Querying Task Execution Status
- FunctionThis API is used to query the execution status of an asynchronous request task.
- After an asynchronous request task is issued, for example, creating or deleting an ECS, performing operations on ECSs in a batch, or performing operations on ECS NICs, a task ID (job_id) will be returned, based on which you can query the execution status of the task.
+ Querying Job Execution Status
+ FunctionThis API is used to query the execution status of an asynchronous job.
+ After an asynchronous job is issued, for example, creating or deleting an ECS, performing operations on ECSs in a batch, or performing operations on ECS NICs, a job ID (job_id) will be returned, based on which you can query the execution status of the job.
- For details about how to obtain job_id, see Responses (Task).
+ For details about how to obtain job_id, see Responses (Jobs).
URIGET /v1/{project_id}/jobs/{job_id}
Table 1 describes the parameters in the URI.
Table 1 Parameter descriptionParameter
@@ -26,7 +26,7 @@
| Yes
|
-Specifies the ID of an asynchronous request task.
+ | Specifies the ID of an asynchronous job.
|
|---|
@@ -57,8 +57,8 @@
Object
|
-Specifies the object of the task.
-The value of this parameter varies depending on the type of the task. If the task is an ECS-related operation, the value is server_id. If the task is a NIC operation, the value is nic_id. If a sub-Job is available, details about the sub-job are displayed.
+ | Specifies the object of the job.
+The value of this parameter varies depending on the type of the job. If the job is an ECS-related operation, the value is server_id. If the job is a NIC operation, the value is nic_id. If a sub-Job is available, details about the sub-job are displayed.
For details, see Table 3.
|
@@ -66,28 +66,28 @@
String
|
-Specifies the ID of an asynchronous request task.
+ | Specifies the ID of an asynchronous job.
|
job_type
|
String
|
-Specifies the type of an asynchronous request task.
+ | Specifies the type of an asynchronous job.
|
begin_time
|
String
|
-Specifies the time when the task started.
+ | Specifies the time when the job was started.
|
end_time
|
String
|
-Specifies the time when the task finished.
+ | Specifies the time when the job was finished.
|
error_code
@@ -103,21 +103,21 @@
| String
|
Specifies the cause of the job execution failure.
-After the task job executed successfully, the value of this parameter is null.
+After the job is executed successfully, the value of this parameter is null.
|
message
|
String
|
-Specifies the error message returned when an error occurs in the request to query a task.
+ | Specifies the error message returned when an error occurs in the request to query a job.
|
code
|
String
|
-Specifies the error code returned when an error occurs in the request to query a task.
+ | Specifies the error code returned when an error occurs in the request to query a job.
For details about the error code, see Returned Values for General Requests.
|
@@ -137,28 +137,28 @@
String
|
-If the task is an ECS-related operation, the value is server_id.
+ | If the job is an ECS-related operation, the value is server_id.
|
nic_id
|
String
|
-If the task is a NIC-related operation, the value is nic_id.
+ | If the job is a NIC-related operation, the value is nic_id.
|
sub_jobs_total
|
Integer
|
-Specifies the number of subtasks.
+ | Specifies the number of sub-jobs.
|
sub_jobs
|
Array of objects
|
-Specifies the execution information of a subtask.
+ | Specifies the execution information of a sub-job.
For details, see Table 4.
|
@@ -166,7 +166,7 @@
- Table 4 sub_jobs field descriptionParameter
+Table 4 sub_jobs field descriptionParameter
|
Type
|
@@ -178,66 +178,66 @@
String
|
-Specifies the task status.
-- SUCCESS: indicates the task is successfully executed.
- RUNNING: indicates that the task is in progress.
- FAIL: indicates that the task failed.
- INIT: indicates that the task is being initialized.
+ | Specifies the job status.
+- SUCCESS: indicates the job is successfully executed.
- RUNNING: indicates that the job is in progress.
- FAIL: indicates that the job failed.
- INIT: indicates that the job is being initialized.
|
|---|
entities
|
Object
|
-Specifies the object of the task. The value of this parameter varies depending on the type of the task. If the task is an ECS-related operation, the value is server_id. If the task is a NIC operation, the value is nic_id. For details, see Table 5.
+ | Specifies the object of the job. The value of this parameter varies depending on the type of the job. If the job is an ECS-related operation, the value is server_id. If the job is a NIC operation, the value is nic_id. For details, see Table 5.
|
job_id
|
String
|
-Specifies the subtask ID.
+ | Specifies the sub-job ID.
|
job_type
|
String
|
-Specify the subtask type.
+ | Specify the sub-job type.
|
begin_time
|
String
|
-Specifies the time when the task started.
+ | Specifies the time when the job was started.
|
end_time
|
String
|
-Specifies the time when the task finished.
+ | Specifies the time when the job was finished.
|
error_code
|
String
|
-Specifies the returned error code when the task execution fails.
-After the task is executed successfully, the value of this parameter is null.
+ | Specifies the returned error code when the job execution fails.
+After the job is executed successfully, the value of this parameter is null.
|
fail_reason
|
String
|
-Specifies the cause of the task execution failure.
-After the task is executed successfully, the value of this parameter is null.
+ | Specifies the cause of the job execution failure.
+After the job is executed successfully, the value of this parameter is null.
|
Table 5 sub_jobs.entities field descriptionParameter
+Table 5 sub_jobs.entities field descriptionParameter
|
Type
|
@@ -249,21 +249,21 @@
String
|
-If the task is an ECS-related operation, the value is server_id.
+ | If the job is an ECS-related operation, the value is server_id.
|
|---|
nic_id
|
String
|
-If the task is a NIC-related operation, the value is nic_id.
+ | If the job is a NIC-related operation, the value is nic_id.
|
errorcode_message
|
String
|
-Indicates the cause of a subtask execution failure.
+ | Indicates the cause of a sub-job execution failure.
|
@@ -271,7 +271,7 @@
-Example RequestQuery the execution status of a specified asynchronous request task.
+ Example RequestQuery the execution status of a specified asynchronous job.
GET https://{endpoint}/v1/{project_id}/jobs/{job_id}
Example Response{
@@ -308,7 +308,7 @@
diff --git a/docs/ecs/api-ref/en-us_topic_0022472987.html b/docs/ecs/api-ref/en-us_topic_0022472987.html
index 1f13ad214..78b7a49e9 100644
--- a/docs/ecs/api-ref/en-us_topic_0022472987.html
+++ b/docs/ecs/api-ref/en-us_topic_0022472987.html
@@ -2,7 +2,7 @@
Attaching a Disk to an ECS
FunctionThis API is used to attach a disk to an ECS.
- This API is an asynchronous API. After the attachment request is successfully delivered, a job ID is returned. This does not mean the attachment is complete. You need to call the API by referring to Querying Task Execution Status to query the job status. The SUCCESS status indicates that the attachment is successful.
+ This API is an asynchronous API. After the attachment request is successfully delivered, a job ID is returned. This does not mean the attachment is complete. You need to call the API by referring to Querying Job Execution Status to query the job status. The SUCCESS status indicates that the attachment is successful.
URIPOST /v1/{project_id}/cloudservers/{server_id}/attachvolume
Table 1 describes the parameters in the URI.
@@ -129,7 +129,7 @@
ResponseSee Responses (Task).
+
Example Request- Attach a SCSI EVS disk to device /dev/sda.
POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/attachvolume
diff --git a/docs/ecs/api-ref/en-us_topic_0022472988.html b/docs/ecs/api-ref/en-us_topic_0022472988.html
index f6fadc5ea..583b61eb4 100644
--- a/docs/ecs/api-ref/en-us_topic_0022472988.html
+++ b/docs/ecs/api-ref/en-us_topic_0022472988.html
@@ -2,9 +2,9 @@
Detaching an EVS Disk from an ECS
FunctionThis API is used to detach an EVS disk from an ECS.
- This API is an asynchronous API. After the detachment request is successfully delivered, a job ID is returned. This does not mean the detachment is complete. You need to call the API by referring to Querying Task Execution Status to query the job status. The SUCCESS status indicates that the detachment is successful.
+ This API is an asynchronous API. After the detachment request is successfully delivered, a job ID is returned. This does not mean the detachment is complete. You need to call the API by referring to Querying Job Execution Status to query the job status. The SUCCESS status indicates that the detachment is successful.
- URIDELETE /v1/{project_id}/cloudservers/{server_id}/detachvolume/{volume_id}?delete_flag=0
+ URIDELETE /v1/{project_id}/cloudservers/{server_id}/detachvolume/{volume_id}
Table 1 describes the parameters in the URI.
Table 1 Parameter descriptionParameter
|
@@ -51,7 +51,7 @@
-ResponseSee Responses (Task).
+
Example RequestDetach a specified disk from an ECS.
DELETE https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/detachvolume/{volume_id}
diff --git a/docs/ecs/api-ref/en-us_topic_0024734483.html b/docs/ecs/api-ref/en-us_topic_0024734483.html
index 80f3d8d3b..e1a468d46 100644
--- a/docs/ecs/api-ref/en-us_topic_0024734483.html
+++ b/docs/ecs/api-ref/en-us_topic_0024734483.html
@@ -463,7 +463,7 @@
2016-05-05
|
Modified the following content:
-
+
|
2016-04-14
diff --git a/docs/ecs/api-ref/en-us_topic_0028714261.html b/docs/ecs/api-ref/en-us_topic_0028714261.html
index 08bcae051..d2a773cf6 100644
--- a/docs/ecs/api-ref/en-us_topic_0028714261.html
+++ b/docs/ecs/api-ref/en-us_topic_0028714261.html
@@ -4,7 +4,7 @@
FunctionThis API is used to modify the specifications of an ECS.
For a running ECS, the system will automatically stop the ECS, copy the ECS data to the target node, which can be the source node, and then restart the ECS.
This API supports automatic rollback if the underlying resources are insufficient.
- This API must be used with the API for verifying ECS specifications modification (POST /v2.1/{project_id}/servers/{server_id}/action) or the API for rolling back ECS specifications modification (POST /v2.1/{project_id}/servers/{server_id}/action) if an ECS is detected to be in VERIFY_RESIZE state and its OS-EXT-STS:vm_state is RESIZED.
+ This API cannot be used independently. The VM status needs to be queried in polling mode. When status is VERIFY_RESIZE, OS-EXT-STS:task_state is "", and OS-EXT-STS:vm_state is RESIZED, this API must be used together with Confirming the Specifications Modification of an ECS (POST /v2.1/{project_id}/servers/{server_id}/action) or Rolling Back ECS Specifications Modification (POST /v2.1/{project_id}/servers/{server_id}/action).
URIPOST /v2.1/{project_id}/servers/{server_id}/action
POST /v2/{project_id}/servers/{server_id}/action
diff --git a/docs/ecs/api-ref/en-us_topic_0031167513.html b/docs/ecs/api-ref/en-us_topic_0031167513.html
index 98d429e45..220c17ce0 100644
--- a/docs/ecs/api-ref/en-us_topic_0031167513.html
+++ b/docs/ecs/api-ref/en-us_topic_0031167513.html
@@ -1,8 +1,7 @@
Network Management
-
+
- Querying Networks
diff --git a/docs/ecs/api-ref/en-us_topic_0031167514.html b/docs/ecs/api-ref/en-us_topic_0031167514.html
index 52e5c3b19..54e7c9e18 100644
--- a/docs/ecs/api-ref/en-us_topic_0031167514.html
+++ b/docs/ecs/api-ref/en-us_topic_0031167514.html
@@ -1,8 +1,7 @@
Security Group Management
-
+
- Adding a Security Group
diff --git a/docs/ecs/api-ref/en-us_topic_0065817680.html b/docs/ecs/api-ref/en-us_topic_0065817680.html
index 9eff89cdb..5a4ecfedc 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817680.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817680.html
@@ -1,8 +1,7 @@
Image Management (OpenStack Nova APIs)
-
+
- Querying Images (Discarded)
diff --git a/docs/ecs/api-ref/en-us_topic_0065817681.html b/docs/ecs/api-ref/en-us_topic_0065817681.html
index 8c7a411aa..f01feced8 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817681.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817681.html
@@ -1,8 +1,7 @@
Metadata Management
-
+
- Updating ECS Metadata
diff --git a/docs/ecs/api-ref/en-us_topic_0065817682.html b/docs/ecs/api-ref/en-us_topic_0065817682.html
index 8eb445ecf..7df3ba9e5 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817682.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817682.html
@@ -1,8 +1,7 @@
Floating IP Address Management (OpenStack Nova APIs)
-
+
- Binding a Floating IP Address (Discarded)
diff --git a/docs/ecs/api-ref/en-us_topic_0065817683.html b/docs/ecs/api-ref/en-us_topic_0065817683.html
index e10070b15..a2d7e7e1e 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817683.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817683.html
@@ -1,13 +1,12 @@
ECS Group Management
-
+
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|