Function
Projects are used to group and isolate OpenStack resources, which include computing, storage, and network resources. A project can be a department or a team. Multiple projects can be created for the same account.
This API is used to query all tags used by a user in a specified project.
-
This API has been discarded. Use the API described in Querying Project Tags.
+URI
GET /v1/{project_id}/servers/tags
diff --git a/docs/ecs/api-ref/en-us_topic_0020212207.html b/docs/ecs/api-ref/en-us_topic_0020212207.html index fd41d1905..1937e0f96 100644 --- a/docs/ecs/api-ref/en-us_topic_0020212207.html +++ b/docs/ecs/api-ref/en-us_topic_0020212207.html @@ -96,7 +96,30 @@Response
See Responses (Jobs).
+Response
Table 5 describes the response parameters.
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
job_id + |
+String + |
+Definition +Specifies the job ID returned after a job is delivered. The job ID can be used to query the job execution progress. For details about how to query the job execution status based on job_id, see Job Status Management. +Range +N/A + |
+
For details about abnormal responses, see Responses (Jobs).
Example Request
POST https://{endpoint}/v1/{project_id}/cloudservers/action
diff --git a/docs/ecs/api-ref/en-us_topic_0020212649.html b/docs/ecs/api-ref/en-us_topic_0020212649.html
index 06db26974..dfbbe84bb 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212649.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212649.html
@@ -107,7 +107,30 @@
Response
See Responses (Jobs).
+Response
Table 5 describes the response parameters.
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
job_id + |
+String + |
+Definition +Specifies the job ID returned after a job is delivered. The job ID can be used to query the job execution progress. For details about how to query the job execution status based on job_id, see Job Status Management. +Range +N/A + |
+
For details about abnormal responses, see Responses (Jobs).
Example Request
POST https://{endpoint}/v1/{project_id}/cloudservers/action
diff --git a/docs/ecs/api-ref/en-us_topic_0020212651.html b/docs/ecs/api-ref/en-us_topic_0020212651.html
index 08e99d422..05a7f0c37 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212651.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212651.html
@@ -107,7 +107,30 @@
Response
See Responses (Jobs).
+Response
Table 5 describes the response parameters.
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
job_id + |
+String + |
+Definition +Specifies the job ID returned after a job is delivered. The job ID can be used to query the job execution progress. For details about how to query the job execution status based on job_id, see Job Status Management. +Range +N/A + |
+
For details about abnormal responses, see Responses (Jobs).
Example Request
POST https://{endpoint}/v1/{project_id}/cloudservers/action
diff --git a/docs/ecs/api-ref/en-us_topic_0020212653.html b/docs/ecs/api-ref/en-us_topic_0020212653.html
index be41f1c94..435ddf3c7 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212653.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212653.html
@@ -116,7 +116,30 @@
Response
See Responses (Jobs).
+Response
Table 4 describes the response parameters.
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
job_id + |
+String + |
+Definition +Specifies the job ID returned after a job is delivered. The job ID can be used to query the job execution progress. For details about how to query the job execution status based on job_id, see Job Status Management. +Range +N/A + |
+
For details about abnormal responses, see Responses (Jobs).
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_0020212655.html b/docs/ecs/api-ref/en-us_topic_0020212655.html
index 2ef8bbff0..9abdbad7d 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212655.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212655.html
@@ -4,9 +4,9 @@
-- Querying ECS Flavors
+ - Listing ECS Flavors
-- Querying Details About ECS Flavors
+ - Listing Flavor Details About an ECS
- Querying Details About an ECS Flavor
diff --git a/docs/ecs/api-ref/en-us_topic_0020212656.html b/docs/ecs/api-ref/en-us_topic_0020212656.html
index dc0cc08e4..cbc3c592e 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212656.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212656.html
@@ -1,7 +1,7 @@
-Querying Details About Flavors and Extended Flavor Information
-Function
This API is used to query details about ECS flavors and extended flavor information.
+Listing Flavor Details and Extended Information
+Function
This API is used to list flavor details and extended information.
URI
GET /v1/{project_id}/cloudservers/flavors
Table 1 describes the parameters in the URI.
@@ -441,7 +441,7 @@
For more information, see "ECS Specifications and Types" in Elastic Cloud Server User Guide.
-Example Request
Query details about ECS flavors and extended flavor information.
+Example Request
List ECS flavor details and extended flavor information.
GET https://{endpoint}/v1/{project_id}/cloudservers/flavors?availability_zone=availability_value
Example Response
{
diff --git a/docs/ecs/api-ref/en-us_topic_0020212657.html b/docs/ecs/api-ref/en-us_topic_0020212657.html
index 1db9d65c3..208f2b734 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212657.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212657.html
@@ -4,13 +4,13 @@
-- Creating an ECS
+ - Creating ECSs
- Deleting ECSs
- Querying Details About an ECS
-- Querying Details About ECSs
+ - Listing Details About ECSs
- Modifying ECS Details
diff --git a/docs/ecs/api-ref/en-us_topic_0020212658.html b/docs/ecs/api-ref/en-us_topic_0020212658.html
index bcd5873bd..8d801798d 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212658.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212658.html
@@ -1,7 +1,7 @@
-Querying Details About ECS Flavors
-Function
This API is used to query details about ECS flavors.
+Listing Flavor Details About an ECS
+Function
This API is used to list flavor details about an ECS.
URI
GET /v2.1/{project_id}/flavors/detail?minDisk={minDisk}&minRam={minRam}&sort_key={sort_key}&sort_dir={sort_dir}
GET /v2/{project_id}/flavors/detail?minDisk={minDisk}&minRam={minRam}&sort_key={sort_key}&sort_dir={sort_dir}
@@ -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
Example Request
Query details about ECS flavors.
+Example Request
List flavor details about an ECS.
GET https://{endpoint}/v2/743b4c0428d94531b9f2add666642e6b/flavors/detail
GET https://{endpoint}/v2.1/743b4c0428d94531b9f2add666642e6b/flavors/detail
diff --git a/docs/ecs/api-ref/en-us_topic_0020212659.html b/docs/ecs/api-ref/en-us_topic_0020212659.html
index 2338a6108..29394af90 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212659.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212659.html
@@ -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
-- Querying NICs of an ECS
+ - Listing NICs of an ECS
- Querying Details About a Specified NIC of an ECS
- Adding a NIC to an ECS
-- Deleting a NIC from an ECS
+ - Detaching a NIC from an ECS
diff --git a/docs/ecs/api-ref/en-us_topic_0020212661.html b/docs/ecs/api-ref/en-us_topic_0020212661.html
index 932692fcd..fd2717f14 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212661.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212661.html
@@ -1,7 +1,7 @@
-Querying NICs of an ECS
-Function
This API is used to query NICs attached to an ECS.
+Listing NICs of an ECS
+Function
This API is used to list NICs attached to an ECS.
URI
GET /v2.1/{project_id}/servers/{server_id}/os-interface
GET /v2/{project_id}/servers/{server_id}/os-interface
@@ -129,7 +129,7 @@
-Example Request
Query NICs attached to an ECS.
+Example Request
List NICs attached to an ECS.
GET https://{endpoint}/v2/{project_id}/servers/{server_id}/os-interface
GET https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-interface
diff --git a/docs/ecs/api-ref/en-us_topic_0020212663.html b/docs/ecs/api-ref/en-us_topic_0020212663.html
index f6f1e19ac..908c9c5c2 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212663.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212663.html
@@ -144,7 +144,30 @@
-Response
See Responses (Jobs).
+Response
Table 5 describes the response parameters.
+
+Table 5 Response parameters Parameter
+Type
+Description
+job_id
+String
+Definition
+Specifies the job ID returned after a job is delivered. The job ID can be used to query the job execution progress. For details about how to query the job execution status based on job_id, see Job Status Management.
+Range
+N/A
+
+
+For details about abnormal responses, see Responses (Jobs).
Example Request
Add 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 67654cf15..bc16ebd26 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212665.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212665.html
@@ -85,7 +85,30 @@
-Response
See Responses (Jobs).
+Response
Table 4 describes the response parameters.
+
+Table 4 Response parameters Parameter
+Type
+Description
+job_id
+String
+Definition
+Specifies the job ID returned after a job is delivered. The job ID can be used to query the job execution progress. For details about how to query the job execution status based on job_id, see Job Status Management.
+Range
+N/A
+
+
+For details about abnormal responses, see Responses (Jobs).
Example Request
Delete 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_0020212666.html b/docs/ecs/api-ref/en-us_topic_0020212666.html
index 6b7ce7833..e57851bc4 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212666.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212666.html
@@ -1,7 +1,7 @@
-Deleting a NIC from an ECS
-Function
This API is used to delete a NIC from an ECS based on the port ID.
+Detaching a NIC from an ECS
+Function
This API is used to detach a NIC from an ECS based on the port ID.
Constraints
The primary NIC of an ECS has routing rules configured and cannot be deleted.
When an ECS NIC is detached, all NICs attached to the ECS through the OpenStack Nova API will be deleted.
@@ -58,7 +58,7 @@
Response
None
-Example Request
Delete a NIC from an ECS based on the specified port ID.
+Example Request
Detach a NIC from an ECS based on the specified port ID.
DELETE https://{endpoint}/v2/{project_id}/servers/{server_id}/os-interface/{port_id}
DELETE https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-interface/{port_id}
diff --git a/docs/ecs/api-ref/en-us_topic_0020212667.html b/docs/ecs/api-ref/en-us_topic_0020212667.html
index d9fde9a2c..4249ce0fc 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212667.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212667.html
@@ -4,7 +4,7 @@
-- Querying Disks Attached to an ECS
+ - Listing Details About Disks Attached to an ECS
- Querying a Disk Attached to an ECS
diff --git a/docs/ecs/api-ref/en-us_topic_0020212668.html b/docs/ecs/api-ref/en-us_topic_0020212668.html
index f67936bef..308670962 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212668.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212668.html
@@ -1,6 +1,6 @@
-Creating an ECS
+Creating ECSs
Function
This 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 Job Execution Status to query the job status. The SUCCESS status indicates that the creation is successful.
@@ -201,7 +201,7 @@ echo 111 > c:\aaa.txt
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).
+Keys can be created using the key creation API (Creating and Importing an SSH Key Pair) or obtained using the SSH key query API (Listing SSH Key Pairs).
Constraints
N/A
Range
@@ -337,7 +337,7 @@ echo 111 > c:\aaa.txt
Definition
Specifies the name of the AZ where the ECS is located.
-See Querying AZs.
+See Listing AZs.
Constraints
- If this parameter is not specified, the system automatically selects an AZ.
Range
@@ -471,7 +471,7 @@ echo 111 > c:\aaa.txt
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.
+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
@@ -666,7 +666,7 @@ echo 111 > c:\aaa.txt
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.
+- 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
@@ -734,7 +734,7 @@ echo 111 > c:\aaa.txt
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.
+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
diff --git a/docs/ecs/api-ref/en-us_topic_0020212671.html b/docs/ecs/api-ref/en-us_topic_0020212671.html
index 9fb26622b..e3831313f 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212671.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212671.html
@@ -1,7 +1,7 @@
-Querying Disks Attached to an ECS
-Function
This API is used to query the disks that have been and are being attached to an ECS.
+Listing Details About Disks Attached to an ECS
+Function
This API is used to list details about disks that have been and are being attached to an ECS.
URI
GET /v2.1/{project_id}/servers/{server_id}/os-volume_attachments
GET /v2/{project_id}/servers/{server_id}/os-volume_attachments
@@ -97,7 +97,7 @@
-Example Request
Query details about disks attached to an ECS.
+Example Request
List details about disks attached to an ECS.
GET https://{endpoint}/v2/{project_id}/servers/{server_id}/os-volume_attachments
GET https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-volume_attachments
diff --git a/docs/ecs/api-ref/en-us_topic_0020212675.html b/docs/ecs/api-ref/en-us_topic_0020212675.html
index 7adf9e05b..57ef7b32e 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212675.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212675.html
@@ -4,7 +4,7 @@
-- Querying SSH Key Pairs
+ - Listing SSH Key Pairs
- Querying a Specified SSH Key Pair
diff --git a/docs/ecs/api-ref/en-us_topic_0020212676.html b/docs/ecs/api-ref/en-us_topic_0020212676.html
index f73b3fb18..592b30242 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212676.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212676.html
@@ -1,7 +1,7 @@
-Querying SSH Key Pairs
-Function
This API is used to query SSH key pairs.
+Listing SSH Key Pairs
+Function
This API is used to list SSH key pairs.
URI
GET /v2.1/{project_id}/os-keypairs
GET /v2/{project_id}/os-keypairs
@@ -67,7 +67,7 @@
-Table 4 keypair field description Parameter
+Table 4 keypair field description Parameter
Type
Example Request
Query the list of SSH key pairs.
+Example Request
List SSH key pairs.
GET https://{endpoint}/v2/{project_id}/os-keypairs
GET https://{endpoint}/v2.1/{project_id}/os-keypairs
diff --git a/docs/ecs/api-ref/en-us_topic_0020212678.html b/docs/ecs/api-ref/en-us_topic_0020212678.html
index 25cd3241f..4362b31cd 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 description Parameter
+Table 5 keypair field description Parameter
Type
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.
Response
See Responses (Jobs).
+Response
Table 4 describes the response parameters.
+
+Table 4 Response parameters Parameter
+Type
+Description
+job_id
+String
+Definition
+Specifies the job ID returned after a job is delivered. The job ID can be used to query the job execution progress. For details about how to query the job execution status based on job_id, see Job Status Management.
+Range
+N/A
+
+
+For details about abnormal responses, see Responses (Jobs).
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
@@ -134,7 +157,7 @@
],
"delete_publicip": false,
"delete_volume": false
- }
+ }
- Delete ECSs whose IDs are 616fb98f-46ca-475e-917e-2563e5a8cd19, 616fb98f-46ca-475e-917e-2563e5a8ef20, and 616fb98f-46ca-475e-917e-2563e5a8gh21 in batches.
POST https://{endpoint}/v1/{project_id}/cloudservers/delete
{
@@ -151,7 +174,7 @@
"id": "616fb98f-46ca-475e-917e-2563e5a8gh21"
}
]
-}
+ }
Example Response
{
diff --git a/docs/ecs/api-ref/en-us_topic_0020212688.html b/docs/ecs/api-ref/en-us_topic_0020212688.html
index 2e93e557a..54b154aa3 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212688.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212688.html
@@ -1,7 +1,7 @@
-Querying the ECS List
-Function
This API is used to query ECSs.
+Listing ECSs
+Function
This API is used to list ECSs.
URI
GET /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}
@@ -103,7 +103,7 @@
String
Specifies the ECS ID to which the marker points. The query will start from its next ID.
+Specifies the ECS ID to which the marker points. The query will start from the next ID.
tags
@@ -248,7 +248,7 @@
-Example Request
Query a list of ECSs.
+Example Request
List ECSs.
GET https://{endpoint}/v2/{project_id}/servers
GET https://{endpoint}/v2.1/{project_id}/servers
diff --git a/docs/ecs/api-ref/en-us_topic_0020212689.html b/docs/ecs/api-ref/en-us_topic_0020212689.html
index 610d18c8c..50d521d79 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212689.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212689.html
@@ -1,7 +1,7 @@
-Querying Details About ECSs
-Function
This API is used to query details about ECSs.
+Listing ECS Details
+Function
This API is used to list ECS details.
URI
GET /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}
@@ -103,7 +103,7 @@
String
Specifies the ECS ID to which the marker points. The query will start from its next ID.
+Specifies the ECS ID to which the marker points. The query will start from the next ID.
tags
@@ -649,7 +649,7 @@
-Table 7 Data structure of the network which an ECS accesses Parameter
+
-Table 11 image field description Parameter
+
-Example Request
Query details about ECSs.
+Example Request
List ECS details.
GET https://{endpoint}/v2/{project_id}/servers/detail
GET https://{endpoint}/v2.1/{project_id}/servers/detail
diff --git a/docs/ecs/api-ref/en-us_topic_0020212690.html b/docs/ecs/api-ref/en-us_topic_0020212690.html
index dbc5520de..5d792d34b 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212690.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212690.html
@@ -149,6 +149,7 @@
String
Specifies the host ID of the ECS.
+The returned value is not the actual ID of the host where the ECS is located.
addresses
@@ -700,7 +701,7 @@
-Example Request
Query details about a specified ECS.
+Example Request
Query details about the specified ECS.
GET https://{endpoint}/v2/{project_id}/servers/{server_id}
GET https://{endpoint}/v2.1/{project_id}/servers/{server_id}
diff --git a/docs/ecs/api-ref/en-us_topic_0022067714.html b/docs/ecs/api-ref/en-us_topic_0022067714.html
index 2ba57e159..6a51df8e1 100644
--- a/docs/ecs/api-ref/en-us_topic_0022067714.html
+++ b/docs/ecs/api-ref/en-us_topic_0022067714.html
@@ -14,7 +14,7 @@
String
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.
+Specifies the job ID returned after a job is delivered. The job ID can be used to query the job execution progress. For details about how to query the job execution status based on job_id, see Job Status Management.
403 Forbidden
You are forbidden to access the page requested.
+Access to the requested page is denied.
404 Not Found
diff --git a/docs/ecs/api-ref/en-us_topic_0022067716.html b/docs/ecs/api-ref/en-us_topic_0022067716.html
index 5712d6473..ae045cea1 100644
--- a/docs/ecs/api-ref/en-us_topic_0022067716.html
+++ b/docs/ecs/api-ref/en-us_topic_0022067716.html
@@ -55,7 +55,7 @@
403 Forbidden
You are forbidden to access the page requested.
+Access to the requested page is denied.
404 Not Found
diff --git a/docs/ecs/api-ref/en-us_topic_0022067717.html b/docs/ecs/api-ref/en-us_topic_0022067717.html
index 50151cff8..c843d0944 100644
--- a/docs/ecs/api-ref/en-us_topic_0022067717.html
+++ b/docs/ecs/api-ref/en-us_topic_0022067717.html
@@ -1,7 +1,7 @@
Error Codes
-Context
- An error code returned by an API does not correspond to one error message. The following table lists only common error messages.
- Most ECS APIs are asynchronous. Some error codes are displayed in the returned messages for task viewing requests. HTTP status codes may not be accurate.
- The ECS service is strongly dependent on other services, such as network and storage. If the reported error messages contain information about ECS-depended services, contact technical support for troubleshooting.
- If the system displays an error code when you perform operations on the management console, see "How Do I Handle Error Messages Displayed on the Management Console?" in Elastic Cloud Server User Guide for troubleshooting.
+Context
- An error code returned by an API does not correspond to one error message. The following table lists only common error messages.
- Most ECS APIs are asynchronous. Some error codes are displayed in the returned messages for task viewing requests. HTTP status codes may not be accurate.
- The ECS service is strongly dependent on other services, such as network and storage. If the reported error messages contain information about ECS-dependent services, contact technical support for troubleshooting.
Error Codes
HTTP Status Code
@@ -35,7 +35,9 @@
The number of ECSs has reached the maximum allowed.
Apply for a higher quota of the corresponding resource according to the returned error message.
+Apply for higher quotas of the corresponding resources based on the returned error message.
+ NOTE: When applying for increasing ECS resource quotas, you need to evaluate the number of ECSs, vCPUs, and memory capacity (RAM) required.
+
400
@@ -123,7 +125,7 @@
The private IP address is already in use.
Change the port.
+Replace the IP address with an unused one.
400
@@ -495,7 +497,7 @@
The VPC ID in the request is inconsistent with that in the main subnet ID.
Inconsistent VPC ID in the request body from that in the primary NIC.
+Inconsistent VPC ID in the request body with that in the primary NIC.
Adjust the NIC parameter settings.
Ecs.0074
Window images do not support external users.
+Windows images do not support external users.
External users are not allowed to create Windows ECSs.
External users, including and non-third-party users, are not allowed to purchase Windows images.
+External users, including non-third-party users, are not allowed to purchase Windows images.
400
@@ -640,7 +642,7 @@
The ECS status does not meet requirements.
The ECS in the current state does not support this operation. Try again later.
+The current ECS status does not support the operation. Change the ECS status to the specified status and try again.
400
@@ -669,7 +671,7 @@
Ecs.0103
The disk can be attached to a server only if it exists and the state must be in the available. Make sure the disk state is available and try again.
+The disk can be attached to a server only when it exists and is in the Available state. Check the disk status and try again.
The disk is unavailable.
Ecs.0104
The number of EVS disks that can be attached to the ECS exceeds the maximum number allowed. Decrease the number of EVS disks to be attached and try again.
+The number of EVS disks that can be attached to the ECS has reached the maximum number allowed. Detach some disks and try again.
Insufficient ECS disk quota for attaching more disks.
Adjust the number of attached disks.
+Detach some attached disks from the ECS and try to attach new disks.
400
@@ -695,7 +697,7 @@
Failed to query the ECS system disk.
Check whether the ECS has a system disk attached.
+Attach the system disk to the ECS and try again.
400
@@ -1098,7 +1100,7 @@
Ecs.0314
The key pair does not exist. Refresh the key pair list and check key pair
+The key pair does not exist. Refresh the key pair list and check the key pair.
Failed to obtain the key pair.
Batch operation failed.
Requesting for a batch operation failed.
+Request for batch operations failed.
Rectify the fault based on the returned error information and submit the request again.
Common.0024
exceeds flow over limit
+Flow limit exceeded.
Limited by traffic control.
-Table 4 sub_jobs field description Parameter
+
-Table 5 sub_jobs.entities field description Parameter
+Table 5 sub_jobs.entities field description Parameter
Type
String
If the job 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
diff --git a/docs/ecs/api-ref/en-us_topic_0022472987.html b/docs/ecs/api-ref/en-us_topic_0022472987.html
index 78b7a49e9..9b9dee2f2 100644
--- a/docs/ecs/api-ref/en-us_topic_0022472987.html
+++ b/docs/ecs/api-ref/en-us_topic_0022472987.html
@@ -129,7 +129,30 @@
-Response
See Responses (Jobs).
+Response
Table 4 describes the response parameters.
+
+Table 4 Response parameters Parameter
+Type
+Description
+job_id
+String
+Definition
+Specifies the job ID returned after a job is delivered. The job ID can be used to query the job execution progress. For details about how to query the job execution status based on job_id, see Job Status Management.
+Range
+N/A
+
+
+For details about abnormal responses, see Responses (Jobs).
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 583b61eb4..2668a42de 100644
--- a/docs/ecs/api-ref/en-us_topic_0022472988.html
+++ b/docs/ecs/api-ref/en-us_topic_0022472988.html
@@ -51,7 +51,30 @@
Request
None
-Response
See Responses (Jobs).
+Response
Table 2 describes the response parameters.
+
+Table 2 Response parameters Parameter
+Type
+Description
+job_id
+String
+Definition
+Specifies the job ID returned after a job is delivered. The job ID can be used to query the job execution progress. For details about how to query the job execution status based on job_id, see Job Status Management.
+Range
+N/A
+
+
+For details about abnormal responses, see Responses (Jobs).
Example Request
Detach 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 e1a468d46..70043ec34 100644
--- a/docs/ecs/api-ref/en-us_topic_0024734483.html
+++ b/docs/ecs/api-ref/en-us_topic_0024734483.html
@@ -8,10 +8,18 @@
2025-07-17
+2025-12-02
+Added the following content:
+Querying Details of a Single Disk Attached to an ECS
+Modified the following content:
+Added an API in Disk Management.
+2025-07-17
Modified the following content:
-Added support for the general purpose SSD V2 (GPSSD2) disk type in Creating an ECS.
+Added support for the general purpose SSD V2 (GPSSD2) disk type in Creating ECSs.
2025-03-14
@@ -45,25 +53,25 @@
2024-07-23
Modified the following content:
-Modified the description about the parameter name and added the parameter description in Creating an ECS.
+Modified the description about the parameter name and added the parameter description in Creating ECSs.
2024-05-27
Modified the following content:
-Added the parameter serverIds in Creating an ECS.
+Added the parameter serverIds in Creating ECSs.
2024-04-26
Modified the following content:
-- Updated actions in Lifecycle Management, NIC Management, Disk Management, ECS Group Management, and Tag Management.
- Added parameter descriptions in Querying NICs of an ECS.
+- Updated actions in Lifecycle Management, NIC Management, Disk Management, ECS Group Management, and Tag Management.
- Added parameter descriptions in Listing NICs of an ECS.
2024-01-30
Added the following content:
-
+
Modified the following content:
Added the permissions to query ECS NICs in NIC Management.
2024-01-19
Modified the following content:
-Added the batch_create_in_multi_az parameter in Creating an ECS.
+Added the batch_create_in_multi_az parameter in Creating ECSs.
2023-11-03
Modified the following content:
-- Added the ipv6_enable and ipv6_bandwidth fields in Creating an ECS and Adding NICs to an ECS in a Batch.
- Added the ipv6_bandwidth field description in Data Structure for Creating ECSs.
+- Added the ipv6_enable and ipv6_bandwidth fields in Creating ECSs and Adding NICs to an ECS in a Batch.
- Added the ipv6_bandwidth field description in Data Structure for Creating ECSs.
2023-02-28
@@ -89,33 +97,33 @@
2022-12-20
Modified the following content:
-Modified the value range of volumetype and added ESSD in Creating an ECS.
+Modified the value range of volumetype and added ESSD in Creating ECSs.
2022-11-25
Modified the following content:
-Modified the value range of volumetype and deleted GPSSD and ESSD in Creating an ECS.
+Modified the value range of volumetype and deleted GPSSD and ESSD in Creating ECSs.
2022-07-12
Modified the following content:
-- Modified the description of "hw:passthrough" in Creating an ECS.
- Modified the description of the returned value 200 in Returned Values for General Requests.
+- Modified the description of "hw:passthrough" in Creating ECSs.
- Modified the description of the returned value 200 in Returned Values for General Requests.
2022-06-06
Added the following content:
-
-Modified the following content:- Added the attachableQuantity parameter in Querying Information About Disks Attached to an ECS.
- Added a response example in Detaching an EVS Disk from an ECS.
+
+Modified the following content:- Added the attachableQuantity parameter in Listing Details About Disks Attached to an ECS.
- Added a response example in Detaching an EVS Disk from an ECS.
2022-05-11
Added the following content:
-
+
2022-03-11
@@ -139,26 +147,26 @@
2021-11-20
Added description of system disk encryption in the following sections:
-
+
2021-09-11
Modified the following content:
Modified the description about Xen instances in the following sections:
-
+
2021-06-18
Modified the following content:
-- Added the metadata field for creating disks in Data Structure for Creating ECSs.
- Added __system__encrypted and __system__cmkid to the metadata field as well as one request example with system disk encrypted in Reinstalling an ECS OS (Using an Image with Cloud-Init Installed).
- Added __system__encrypted and __system__cmkid to the metadata field as well as one request example with system disk encrypted in Changing an ECS OS (Using an Image with Cloud-Init Installed).
- Modified the description of the metadata field in root_volume, added a request example for __system__encrypted, and added a request example with system disk encrypted in Creating an ECS.
+- Added the metadata field for creating disks in Data Structure for Creating ECSs.
- Added __system__encrypted and __system__cmkid to the metadata field as well as one request example with system disk encrypted in Reinstalling an ECS OS (Using an Image with Cloud-Init Installed).
- Added __system__encrypted and __system__cmkid to the metadata field as well as one request example with system disk encrypted in Changing an ECS OS (Using an Image with Cloud-Init Installed).
- Modified the description of the metadata field in root_volume, added a request example for __system__encrypted, and added a request example with system disk encrypted in Creating ECSs.
2021-04-22
Modified the following content:
-Added parameter extendparam to the data_volumes field in Creating an ECS.
+Added parameter extendparam to the data_volumes field in Creating ECSs.
2019-12-18
@@ -190,13 +198,13 @@
Added the following content:
- Added "Creating an FPGA Image".
Modified the following content:
-- Added description in Querying All API Versions and Querying a Specified API Version because microversion header "OpenStack-API-Version" is supported in microversion 2.27 and later.
- Modified description in several sections, such as Querying Details About ECSs, Querying Details About an ECS, Rebuilding an ECS, Querying Tenant Quota Limits, Querying Tenant Quotas, and Querying Default Quotas because OpenStack Queens is supported.
- Changed ECS metric names.
+- Added description in Listing API Versions and Querying a Specified API Version because microversion header "OpenStack-API-Version" is supported in microversion 2.27 and later.
- Modified description in several sections, such as Listing ECS Details, Querying Details About an ECS, Rebuilding an ECS, Querying Tenant Quota Limits, Querying Tenant Quotas, and Querying Default Quotas because OpenStack Queens is supported.
- Changed ECS metric names.
2019-01-25
Modified the following content:
-- Modified the example response in Querying Disk Attachment of an ECS.
- Modified the URL description of the response parameter in Obtaining a VNC-based Remote Login Address (Microversion 2.6 or Later).
- Added the reserve_port parameter description in Deleting a NIC from an ECS.
- Added tag constraints in Tag Types.
+- Modified the example response in Querying Disk Attachment of an ECS.
- Modified the URL description of the response parameter in Obtaining a VNC-based Remote Login Address (Microversion 2.6 or Later).
- Added the reserve_port parameter description in Detaching a NIC from an ECS.
- Added tag constraints in Tag Types.
Deleted the following content:
Deleted parameter check_resources in Creating an ECS.
Added the following content:
Modified the following content:
-- Added the reserve_port field in Deleting a NIC from an ECS.
- Added the attachableQuantity field in Querying Disk Attachment of an ECS.
- Added the final_tenant field in Creating an ECS.
+- Added the reserve_port field in Detaching a NIC from an ECS.
- Added the attachableQuantity field in Querying Disk Attachment of an ECS.
- Added the final_tenant field in Creating an ECS.
2018-12-10
@@ -249,7 +257,7 @@
Added the following content:
Modified the following content:
-- Added the description of forcible disk uninstallation in Detaching an EVS Disk from an ECS.
- Added constraints in Creating an ECS.
- Added check rules for the description parameter in Creating an ECS and Creating an ECS.
+- Added the description of forcible disk uninstallation in Detaching an EVS Disk from an ECS.
- Added constraints in Creating an ECS.
- Added check rules for the description parameter in Creating ECSs and Creating an ECS.
2018-08-17
@@ -261,7 +269,7 @@
2018-07-31
Modified the following content:
-- Modified description in Creating an ECS, allowing you to use full-ECS images to create ECSs.
- Modified constraints in Changing an ECS OS (Using an Image with Cloud-Init Installed), allowing an ECS to change its OS after reinstalling the OS on the ECS failed.
+- Modified description in Creating ECSs, allowing you to use full-ECS images to create ECSs.
- Modified constraints in Changing an ECS OS (Using an Image with Cloud-Init Installed), allowing an ECS to change its OS after reinstalling the OS on the ECS failed.
2018-07-10
@@ -278,13 +286,13 @@
2018-06-29
Modified the following content:
-- Modified Creating an ECS because the snapshotId field description has been deleted and full-ECS images have been canceled.
- Added the server field in Creating an ECS.
- Modified the example request in Creating an ECS.
- Modified constraints in Creating an Image Using an ECS.
+- Modified Creating ECSs because the snapshotId field description has been deleted and full-ECS images have been canceled.
- Added the server field in Creating ECSs.
- Modified the example request in Creating an ECS.
- Modified constraints in Creating an Image Using an ECS.
2018-06-24
Modified the following content:
-- Modified the snapshotId field description and added request examples in Creating an ECS.
- Modified and added request examples in Creating an ECS.
+- Modified the snapshotId field description and added request examples in Creating ECSs.
- Modified and added request examples in Creating an ECS.
Deleted the following content:
- Deleted the API for querying ECSs by tag.
- Deleted the API for querying project tags.
2018-06-14
Modified the following content:
-- Fixed UAT issues in Elastic Cloud Server API Reference 28.
- Modified description in Creating an ECS for adding the snapshotId field, allowing you to use CSBS backups to create full-ECS images and use the images to create ECSs.
+- Fixed UAT issues in Elastic Cloud Server API Reference 28.
- Modified description in Creating ECSs for adding the snapshotId field, allowing you to use CSBS backups to create full-ECS images and use the images to create ECSs.
Deleted the following content:
-- Deleted the API for querying tenant quotas.
- Deleted the API for querying tenant quotas.
+- Deleted the API for querying tenant quota limits.
- Deleted the API for querying tenant quotas.
2018-05-31
Modified the following content:
-- Fixed 59 UAT issues in Elastic Cloud Server API Reference 27.
+- Fixed 59 UAT issues in Elastic Cloud Server API Reference 27.
2018-05-21
Modified the following content:
-- Added FPGA Logical File Management.
- Fixed 110 UAT issues in Elastic Cloud Server API Reference 26.
+- Added FPGA Logical File Management.
- Fixed 110 UAT issues in Elastic Cloud Server API Reference 26.
2018-03-30
Added the following content:
-- Added description in Querying Disk Attachment of an ECS for querying disk device names of ECSs.
- Added description in Querying a Single Disk Attached to an ECS for querying disk device names of ECSs.
+- Added the description for querying the disk device name of the ECS in Querying Disk Attachment of an ECS.
- Added the description for querying the disk device name of the ECS in Querying a Single Disk Attached to an ECS.
Modified the following content:
- Added the dedicated_host_id field in Modifying the Specifications of an ECS, allowing ECS specifications modification on DeHs.
- Added the dedicated_host_id field in Modifying the Specifications of an ECS, allowing ECS specifications modification on DeHs.
- Added the description of forcible data disk uninstallation in Detaching a Disk from an ECS.
- Allowed native OpenStack APIs in V2.1.
2018-02-12
Modified the following content:
-- Modified the from_port, to_port, ip_range, and group field descriptions in Querying Security Groups (Discarded) and Querying Details About a Security Group (Discarded).
- Modified the description field description in Creating a Security Group (Discarded).
- Modified Querying Details About Flavors and Extended Flavor Information and added the pci_passthrough:alias field.
- Modified error messages in Error Codes.
+- Modified the from_port, to_port, ip_range, and group field descriptions in Querying Security Groups (Discarded) and Querying Details About a Security Group (Discarded).
- Modified the description field description in Creating a Security Group (Discarded).
- Modified Listing Flavor Details and Extended Information and added the pci_passthrough:alias field.
- Modified error messages in Error Codes.
2017-12-30
Modified the following content:
-- Modified the tags field description in Creating an ECS.
- Modified the os:scheduler_hints field description in Creating an ECS.
- Added the pci_passthrough:enable_gpu and pci_passthrough:gpu_specs fields in Querying Details About Flavors and Extended Flavor Information.
- Added handling method for each error code in Error Codes.
- Modified Querying Security Groups (Discarded).
- Modified Creating a Security Group (Discarded).
- Modified Querying Details About a Security Group (Discarded).
+- Modified the tags field description in Creating ECSs.
- Modified the os:scheduler_hints field description in Creating ECSs.
- Added the pci_passthrough:enable_gpu and pci_passthrough:gpu_specs fields in Listing Flavor Details and Extended Information.
- Added handling method for each error code in Error Codes.
- Modified Querying Security Groups (Discarded).
- Modified Creating a Security Group (Discarded).
- Modified Querying Details About a Security Group (Discarded).
2017-10-30
@@ -344,7 +352,7 @@
2017-09-30
Modified the following content:
-- Modified the volumetype parameter description in Creating an ECS.
- Modified constraints in Creating an ECS.
- Modified the user_data parameter description in Reinstalling an ECS OS (Using an Image with Cloud-Init Installed). The user data function is supported when the OS is reinstalled.
- Modified the user_data parameter description in Changing an ECS OS (Using an Image with Cloud-Init Installed). The user data function is supported when the OS is changed.
+- Modified the volumetype parameter description in Creating ECSs.
- Modified constraints in Creating an ECS.
- Modified the user_data parameter description in Reinstalling an ECS OS (Using an Image with Cloud-Init Installed). The user data function is supported when the OS is reinstalled.
- Modified the user_data parameter description in Changing an ECS OS (Using an Image with Cloud-Init Installed). The user data function is supported when the OS is changed.
2017-08-30
@@ -370,13 +378,13 @@
2017-06-16
Modified the following content:
-- Modified the security_groups field description in Querying Details About ECSs.
- Modified the security_groups field description in Querying Details About an ECS Flavor.
- Modified ECS metric description and added the metric ib_card_state.
+- Modified the security_groups field description in Listing ECS Details.
- Modified the security_groups field description in Querying Details About an ECS Flavor.
- Modified ECS metric description and added the metric ib_card_state.
2017-04-28
Modified the following content:
-- Modified metadata field description in Creating an ECS.
- Changed the field name attachment_id to volume_id in Detaching an EVS Disk from an ECS.
- Modified the ecs:virtualization_env_types field description in Querying Details About Flavors and Extended Flavor Information.
- Modified description of inst_sys_status_error in ECS metrics.
+- Modified metadata field description in Creating ECSs.
- Changed the field name attachment_id to volume_id in Detaching an EVS Disk from an ECS.
- Modified the ecs:virtualization_env_types field description in Listing Flavor Details and Extended Information.
- Modified description of inst_sys_status_error in ECS metrics.
Deleted the following content:
- Deleted the tags field in Response in Querying Details About an ECS.
2017-03-30
Modified the following content:
-- Added the ecs:generation and ecs:virtualization_env_types fields in Querying Details About Flavors and Extended Flavor Information.
- Changed key and value lengths and tag naming rules for the tags field in Creating an ECS.
- Added the shareable, multiattach, and hw:passthrough fields to the data_volumes field in Creating an ECS.
- Modified ECS metric description and added the metric inst_sys_status_error.
+- Added the ecs:generation and ecs:virtualization_env_types fields in Listing Flavor Details and Extended Information.
- Changed key and value lengths and tag naming rules for the tags field in Creating ECSs.
- Added the shareable, multiattach, and hw:passthrough fields to the data_volumes field in Creating ECSs.
- Modified ECS metric description and added the metric inst_sys_status_error.
2017-02-28
Modified the following content:
-Modified the tags field description in Creating an ECS (a maximum of 10 tags can be added to an ECS).
+Modified the tags field description in Creating ECSs (a maximum of 10 tags can be added to an ECS).
2017-02-08
Modified the following content:
-- Added the tags field description in Creating an ECS.
+- Added the tags field description in Creating ECSs.
2017-01-20
@@ -404,38 +412,38 @@
Added the following content:
- Added error code "Ecs.0219 Failed to create the ECS."
Modified the following content:
-- Added the tenancy and dedicated_host_id fields to the os:scheduler_hints field description in Creating an ECS.
- Added the tenancy and dedicated_host_id fields to the os:scheduler_hints field description in Creating an ECS.
+- Added the tenancy and dedicated_host_id fields to the os:scheduler_hints field description in Creating ECSs.
- Added the tenancy and dedicated_host_id fields to the os:scheduler_hints field description in Creating an ECS.
2016-11-30
Modified the following content:
-- Added password complexity requirements on adminpass in Creating an ECS and Creating an ECS.
+- Added password complexity requirements on adminpass in Creating ECSs and Creating an ECS.
2016-09-30
This issue is the tenth official release.
Modified the following content:
-- Added optional parameters in Querying Details About ECS Flavors for querying ECS specifications.
- Added the fixed_ips field in Adding a NIC to an ECS.
- Modified description of maxSecurityGroups and maxSecurityGroupRules in Querying Tenant Quotas.
- Added the large-memory ECS specification in Querying Details About Flavors and Extended Flavor Information.
+- Added optional parameters in Listing Flavor Details About an ECS for querying ECS specifications.
- Added the fixed_ips field in Adding a NIC to an ECS.
- Modified description of maxSecurityGroups and maxSecurityGroupRules in Querying Tenant Quotas.
- Added the large-memory ECS specification in Listing Flavor Details and Extended Information.
2016-08-25
Modified the following content:
-- Modified ECS metric description.
- Added binding:profile and extra_dhcp_opts to table [2] nics field description in Creating an ECS.
+- Modified ECS metric description.
- Added binding:profile and extra_dhcp_opts to table [2] nics field description in Creating ECSs.
2016-08-09
Modified the following content:
-- Modified ECS metric description and added metrics Outband Incoming Rate and Outband Outgoing Rate.
- Modified the description of ECS metric CPU Usage.
- Changed the maximum user data length to 32 KB in Creating an ECS and Creating an ECS.
+- Modified ECS metric description and added metrics Outband Incoming Rate and Outband Outgoing Rate.
- Modified the description of ECS metric CPU Usage.
- Changed the maximum user data length to 32 KB in Creating ECSs and Creating an ECS.
2016-07-15
Modified the following content:
-- Added the os:scheduler_hints field in Creating an ECS.
- Modified description of parameter group in table [7] os:scheduler_hints field description in Creating an ECS.
- Added disk-intensive ECS specifications and fields in Querying Details About Flavors and Extended Flavor Information.
- Added the maxServerGroups, maxServerGroupMembers, and totalServerGroupsUsed fields in table [1] absolute field description in Querying Tenant Quotas.
+- Added the os:scheduler_hints field in Creating ECSs.
- Modified description of parameter group in table [7] os:scheduler_hints field description in Creating an ECS.
- Added disk-intensive ECS specifications and fields in Listing Flavor Details and Extended Information.
- Added the maxServerGroups, maxServerGroupMembers, and totalServerGroupsUsed fields in table [1] absolute field description in Querying Tenant Quotas.
2016-06-30
@@ -455,7 +463,7 @@
Added the following content:
- Added Network Management.
- Added Security Group Management.
- Added Attaching an ECS Data Disk.
- Added Obtaining the Password of an ECS.
- Added Deleting the Password of an ECS.
Modified the following content:
-- Added the user_data field in Creating an ECS.
- Added the user_data field in Creating an ECS.
+- Added the user_data field in Creating ECSs.
- Added the user_data field in Creating an ECS.
Deleted the following content:
- Deleted Configuring ECS Metadata (Native OpenStack API).
- Deleted Querying the VNC Link of an ECS (Native OpenStack API).
2016-05-05
Modified the following content:
-- Modified parameter description in Creating an ECS.
- Modified parameter description in Creating an ECS.
- Modified parameter description in Deleting ECSs.
- Modified parameter description in Querying the ECS List.
- Modified the metadata field in Querying Details About ECSs.
- Modified the metadata field in Querying Details About an ECS.
- Modified the os-stop field in Stopping ECSs in a Batch.
- Modified the os-stop field in Disabling an ECS.
- Modified parameter description in Querying Details About Flavors and Extended Flavor Information.
- Modified response examples in Querying Job Execution Status.
- Modified Error Codes.
+- Modified parameter description in Creating ECSs.
- Modified parameter description in Creating an ECS.
- Modified parameter description in Deleting ECSs.
- Modified parameter description in Listing ECSs.
- Modified the metadata field in Listing ECS Details.
- Modified the metadata field in Querying Details About an ECS.
- Modified the os-stop field in Stopping ECSs in a Batch.
- Modified the os-stop field in Disabling an ECS.
- Modified parameter description in Listing Flavor Details and Extended Information.
- Modified response examples in Querying Job Execution Status.
- Modified Error Codes.
2016-04-14
diff --git a/docs/ecs/api-ref/en-us_topic_0031167514.html b/docs/ecs/api-ref/en-us_topic_0031167514.html
index 54e7c9e18..cc4b311fb 100644
--- a/docs/ecs/api-ref/en-us_topic_0031167514.html
+++ b/docs/ecs/api-ref/en-us_topic_0031167514.html
@@ -8,7 +8,7 @@
- Removing a Security Group
-- Querying Security Groups of a Specified ECS
+ - Listing Security Groups of a Specified ECS
diff --git a/docs/ecs/api-ref/en-us_topic_0065792792.html b/docs/ecs/api-ref/en-us_topic_0065792792.html
index a850cfd21..52a82e0e6 100644
--- a/docs/ecs/api-ref/en-us_topic_0065792792.html
+++ b/docs/ecs/api-ref/en-us_topic_0065792792.html
@@ -4,7 +4,7 @@
-- Querying All API Versions
+ - Listing API Versions
- Querying a Specified API Version
diff --git a/docs/ecs/api-ref/en-us_topic_0065792793.html b/docs/ecs/api-ref/en-us_topic_0065792793.html
index d7f0ea464..a6bfa1a69 100644
--- a/docs/ecs/api-ref/en-us_topic_0065792793.html
+++ b/docs/ecs/api-ref/en-us_topic_0065792793.html
@@ -1,7 +1,7 @@
-Querying All API Versions
-Function
This API is used to query all available Nova versions.
+Listing API Versions
+Function
This API is used to list all available Nova versions.
To support function extension, Nova APIs can be distinguished by version. There are two types of versions:
- Major version: Independent URL
- Microversion: Used by the HTTP request header X-OpenStack-Nova-API-Version. Since microversion 2.27, the new microversion header OpenStack-API-Version has been supported.
@@ -113,7 +113,7 @@
-Example Request
Query all API versions.
+Example Request
List supported API versions.
GET https://{endpoint}/
Example Response
{
diff --git a/docs/ecs/api-ref/en-us_topic_0065817683.html b/docs/ecs/api-ref/en-us_topic_0065817683.html
index a2d7e7e1e..1e80aae07 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817683.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817683.html
@@ -6,7 +6,7 @@
- Creating an ECS Group
-- Querying the List of ECS Groups
+ - Listing ECS Groups
- Querying Details About an ECS Group
diff --git a/docs/ecs/api-ref/en-us_topic_0065817684.html b/docs/ecs/api-ref/en-us_topic_0065817684.html
index c00537736..ea7ed04e1 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817684.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817684.html
@@ -4,7 +4,7 @@
diff --git a/docs/ecs/api-ref/en-us_topic_0065817692.html b/docs/ecs/api-ref/en-us_topic_0065817692.html
index 4bc275741..61215edaa 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817692.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817692.html
@@ -1,7 +1,7 @@
-Querying Operations on an ECS
-Function
This API is used to query all historical operations on an ECS.
+Listing Actions on an ECS
+Function
This API is used to list all historical actions on an ECS.
URI
GET /v2.1/{project_id}/servers/{server_id}/os-instance-actions?limit={limit}&marker={marker}
GET /v2/{project_id}/servers/{server_id}/os-instance-actions?limit={limit}&marker={marker}
@@ -79,7 +79,7 @@
Array of Object
Specifies operations performed on the ECS. For details, see Table 4.
+Specifies the list of actions performed on the ECS. For details, see Table 4.
String
Specifies the result status of the operation.
+Specifies the result status of the action.
project_id
@@ -165,7 +165,7 @@
-Example Request
Query all historical operations on a specified ECS.
+Example Request
List all historical actions on a specified ECS.
GET https://{endpoint}/v2/89655fe61c4c4a08b9f3e7f9095441b8/servers/e723eb40-f56e-40f9-8c8c-caa517fe06ba/os-instance-actions
GET https://{endpoint}/v2.1/89655fe61c4c4a08b9f3e7f9095441b8/servers/e723eb40-f56e-40f9-8c8c-caa517fe06ba/os-instance-actions
diff --git a/docs/ecs/api-ref/en-us_topic_0065817694.html b/docs/ecs/api-ref/en-us_topic_0065817694.html
index 1fd776f06..e6ccad19b 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817694.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817694.html
@@ -5,9 +5,9 @@
Images created using an ECS are stored on storage nodes as snapshots.
This API is a native OpenStack API that is not applicable to the images on the cloud platform.
-- To create a system disk image or data disk image, use the IMS API (POST /v2/cloudimages/action). For details, see "Creating an Image" in Image Management Service API Reference.
- To create a full-ECS image, use the IMS API (POST /v1/cloudimages/wholeimages/action). For details, see "Creating a Full-ECS Image" in Image Management Service API Reference.
+- To create a system disk image or data disk image, use the IMS API (POST /v2/cloudimages/action). For details, see "Creating an Image" in Image Management Service API Reference.
- To create a full-ECS image, use the IMS API (POST /v1/cloudimages/wholeimages/action). For details, see "Creating a Full-ECS Image" in Image Management Service API Reference.
-Constraints
- An ECS in the error state cannot be used to create an image.
- If an image created using an ECS is used to create a new ECS, the new ECS must be located in the same AZ as the original ECS.
- After an ECS is deleted, the images and snapshots created using this ECS will not be automatically deleted. You must manually delete them.
- After an image created using an ECS is deleted, the associated snapshots will not be automatically deleted (this function is implemented by native OpenStack). You must manually delete such snapshots.
- The image created using an ECS cannot be used to create data disks.
- The images created using the API described in this section (URI: POST /v2/{project_id}/servers/{server_id}/action or POST /v2.1/{project_id}/servers/{server_id}/action) cannot be exported to OBS buckets. If such images must be exported, use the IMS API (POST /v2/cloudimages/action). For details, see "Creating an Image" in Image Management Service API Reference.
+Constraints
- An ECS in the error state cannot be used to create an image.
- If an image created using an ECS is used to create a new ECS, the new ECS must be located in the same AZ as the original ECS.
- After an ECS is deleted, the images and snapshots created using this ECS will not be automatically deleted. You must manually delete them.
- After an image created using an ECS is deleted, the associated snapshots will not be automatically deleted (this function is implemented by native OpenStack). You must manually delete such snapshots.
- The image created using an ECS cannot be used to create data disks.
- The images created using the API described in this section (URI: POST /v2/{project_id}/servers/{server_id}/action or POST /v2.1/{project_id}/servers/{server_id}/action) cannot be exported to OBS buckets. If such images must be exported, use the IMS API (POST /v2/cloudimages/action). For details, see "Creating an Image" in Image Management Service API Reference.
URI
POST /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_0065817700.html b/docs/ecs/api-ref/en-us_topic_0065817700.html
index 5f253ebc8..651f934a5 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817700.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817700.html
@@ -257,7 +257,7 @@
-Table 7 ip_range objects Parameter
+
-Table 4 security_group_rule objects Parameter
+Table 4 security_group_rule objects Parameter
Mandatory
Integer
Specifies the stop port number. The value ranges from 1 to 65,535 and cannot be less than from_port.
+Specifies the stop port number. The value ranges from 1 to 65,535 and cannot be less than from_port.
When ip_protocol is icmp, it specifies the code. The value ranges from 0 to 255. If both from_port and to_port are -1, any ICMP packet can be transmitted.
Object
Specifies the name of the peer security group and the ID of the tenant in the peer security group. For details, see Table 6.
-The value of ip_range or group must be empty.
+The value of ip_range or group must be empty.
id
@@ -201,7 +201,7 @@
-
-Example Request
Query available ECS flavors.
+Example Request
List available ECS flavors.
GET https://{endpoint}/v2/743b4c0428d94531b9f2add666642e6b/flavors
GET https://{endpoint}/v2.1/743b4c0428d94531b9f2add666642e6b/flavors
diff --git a/docs/ecs/api-ref/en-us_topic_0065817720.html b/docs/ecs/api-ref/en-us_topic_0065817720.html
index c0c62b957..dc6e5676f 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817720.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817720.html
@@ -110,7 +110,7 @@
-
-Example Request
Query a list of AZs.
+Example Request
List AZs.
GET https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/os-availability-zone
GET https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/os-availability-zone
diff --git a/docs/ecs/api-ref/en-us_topic_0065962597.html b/docs/ecs/api-ref/en-us_topic_0065962597.html
index e1ee0df24..863f65b87 100644
--- a/docs/ecs/api-ref/en-us_topic_0065962597.html
+++ b/docs/ecs/api-ref/en-us_topic_0065962597.html
@@ -149,7 +149,7 @@
String
Specifies the FPGA image status. Options:
-- saving: indicates that the FPGA image file is being uploaded to the backend storage.
- deleting: indicates that the FPGA image is being deleted.
- error: indicates that creating the FPGA image failed.
- active: indicates that the FPGA image is available for use.
+- saving: indicates that the FPGA image file is being uploaded to the backend storage.
- deleting: indicates that the FPGA image is being deleted.
- error: indicates that creating the FPGA image failed.
- active: indicates that the FPGA image is available for use.
No
Specifies the maximum records displayed on a page in a pagination query.
-- Must be a decimal integer.
- Ranges from 1 (inclusive) to 100 (inclusive).
- Cannot contain +.
+- Must be a decimal integer.
- Ranges from 1 (inclusive) to 100 (inclusive).
- Cannot contain +.
- - Pagination query takes effect only if parameters page and size both have a value. If only one of them has a value, an error message indicating invalid parameter will be displayed.
- If fpga_image_id is used, pagination query specified by page and size does not take effect.
+ - Pagination query takes effect only if parameters page and size both have a value. If only one of them has a value, an error message indicating invalid parameter will be displayed.
- If fpga_image_id is used, the pagination query specified by page and size does not take effect.
Request
None
@@ -115,7 +115,7 @@
String
Specifies the FPGA image status. Options:
-- initiating: indicates that the task of creating an FPGA image is being initialized.
- scheduling: indicates that the task of creating an FPGA image is waiting for scheduling.
- creating: indicates that the FPGA image is being created.
- saving: indicates that the FPGA image file is being uploaded to the backend storage.
- deleting: indicates that the FPGA image is being deleted.
- error: indicates that creating the FPGA image failed.
- active: indicates that the FPGA image is available for use.
+- initiating: indicates that the task of creating an FPGA image is being initialized.
- scheduling: indicates that the task of creating an FPGA image is waiting for scheduling.
- creating: indicates that the FPGA image is being created.
- saving: indicates that the FPGA image file is being uploaded to the backend storage.
- deleting: indicates that the FPGA image is being deleted.
- error: indicates that creating the FPGA image failed.
- active: indicates that the FPGA image is available for use.
size
diff --git a/docs/ecs/api-ref/en-us_topic_0067876349.html b/docs/ecs/api-ref/en-us_topic_0067876349.html
index 5c9918062..8512bb985 100644
--- a/docs/ecs/api-ref/en-us_topic_0067876349.html
+++ b/docs/ecs/api-ref/en-us_topic_0067876349.html
@@ -223,7 +223,30 @@ echo 111 > c:\aaa.txt
-Response parameters
See Responses (Jobs).
+Response parameters
Table 5 describes the response parameters.
+
+Table 5 Response parameters Parameter
+Type
+Description
+job_id
+String
+Definition
+Specifies the job ID returned after a job is delivered. The job ID can be used to query the job execution progress. For details about how to query the job execution status based on job_id, see Job Status Management.
+Range
+N/A
+
+
+For details about abnormal responses, see Responses (Jobs).
Example Request
- After the ECS OS is reinstalled, use the password for login authentication. For security purposes, store the password in ciphertext in configuration files or environment variables.
POST https://{endpoint}/v2/{project_id}/cloudservers/{server_id}/reinstallos
diff --git a/docs/ecs/api-ref/en-us_topic_0067876971.html b/docs/ecs/api-ref/en-us_topic_0067876971.html
index de3ae1497..517bafcf0 100644
--- a/docs/ecs/api-ref/en-us_topic_0067876971.html
+++ b/docs/ecs/api-ref/en-us_topic_0067876971.html
@@ -5,7 +5,7 @@
This API is an asynchronous API. After the OS change request is successfully delivered, a job ID is returned. This does not mean the OS change 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 OS change is successful.
After this API is called, the system uninstalls the system disk, uses the new image to create a system disk, and attaches it to the ECS. In this way, the OS is changed.
-Constraints
- You can only use an image with Cloud-Init or Cloudbase-Init installed.
- Only a stopped ECS or an ECS on which reinstalling or changing the OS failed supports changing OS.
- Only an ECS with a system disk supports changing OS.
- You are not allowed to perform other operations when changing the OS. Otherwise, changing the OS will fail.
+Constraints
- This API only supports images with Cloud-Init or Cloudbase-Init installed.
- OS changes are only supported on stopped ECSs or on ECSs where OS reinstallation or change has failed.
- ECSs without system disks do not support OS changes.
- You are not allowed to perform other operations when changing the OS, or the OS change may fail.
URI
POST /v2/{project_id}/cloudservers/{server_id}/changeos
Table 1 describes the parameters in the URI.
@@ -240,7 +240,30 @@ echo 111 > c:\aaa.txt
-Response
See Responses (Jobs).
+Response
Table 5 describes the response parameters.
+
+Table 5 Response parameters Parameter
+Type
+Description
+job_id
+String
+Definition
+Specifies the job ID returned after a job is delivered. The job ID can be used to query the job execution progress. For details about how to query the job execution status based on job_id, see Job Status Management.
+Range
+N/A
+
+
+For details about abnormal responses, see Responses (Jobs).
Example Request
- After the ECS OS is switched, use the password for login authentication. For security purposes, store the password in ciphertext in configuration files or environment variables.
POST https://{endpoint}/v2/{project_id}/cloudservers/{server_id}/changeos
diff --git a/docs/ecs/api-ref/en-us_topic_0068473331.html b/docs/ecs/api-ref/en-us_topic_0068473331.html
index 3b75602c5..4c41d10eb 100644
--- a/docs/ecs/api-ref/en-us_topic_0068473331.html
+++ b/docs/ecs/api-ref/en-us_topic_0068473331.html
@@ -3,7 +3,7 @@
Creating an ECS
Function
This API is used to create ECS.
-This API does not support automatic rollback after creating an ECS failed. If automatic rollback is required, call the API POST /v1/{project_id}/cloudservers. For details, see Creating an ECS.
+This API does not support automatic rollback after creating an ECS failed. If automatic rollback is required, call the API POST /v1/{project_id}/cloudservers. For details, see Creating ECSs.
URI
POST /v2.1/{project_id}/servers
POST /v2/{project_id}/servers
Table 1 describes the parameters in the URI.
@@ -27,17 +27,17 @@
Alias of the API for creating ECSs: /v2/{project_id}/os-volumes_boot
-This calling mode can only be used in OpenStack client.
+This calling mode can only be used in OpenStack client and is not recommended.
-Constraints
- This API is native, which does not support the creation of ECSs using full-ECS images. To use full-ECS images to create ECSs, refer to Creating an ECS.
- When using this API to create an ECS, you cannot bind an EIP to the ECS during the creation process. To do so, see Creating an ECS.
- Parameter port in the three network parameters (port, uuid, and fixed_ip) has the highest priority. If parameter fixed_ip is set, you must specify the UUID.
- A file injection failure will result in the ECS creation failure.
- The following restrictions apply when you create ECSs using an image:
- You cannot create an ECS on a specified host.
- If a tenant backs up a disk in an ECS, the disk can be deleted only after the tenant deletes all the snapshots of the disk.
- The flavors with different resource types cannot be adjusted if you adjust the specifications of an ECS created using an image.
+Constraints
- This API is native, which does not support the creation of ECSs using full-ECS images. To use full-ECS images to create ECSs, refer to Creating ECSs.
- When using this API to create an ECS, you cannot bind an EIP to the ECS during the creation process. To do so, see Creating ECSs.
- Parameter port in the three network parameters (port, uuid, and fixed_ip) has the highest priority. If parameter fixed_ip is set, you must specify the UUID.
- A file injection failure will result in the ECS creation failure.
- The following restrictions apply when you create ECSs using an image:
- You cannot create an ECS on a specified host.
- If a tenant backs up a disk in an ECS, the disk can be deleted only after the tenant deletes all the snapshots of the disk.
- The flavors with different resource types cannot be adjusted if you adjust the specifications of an ECS created using an image.
- Native APIs /v2/{project_id}/servers and /v2.1/{project_id}/servers provided by the cloud platform is developed based on and compatible with the community-version native OpenStack API.Compared with the community-version native API, this API has the following restrictions when you create an ECS using a specified image:
- Community-version native OpenStack API: creates an ECS using the local disk by default.
- Native API provided by the cloud platform: creates an ECS using the shared storage as the system disk for reliability.
Specifically, when you use the native API to create an ECS:- You can query information about the system disks attached to the ECS.
- The ECS system disk uses the EVS disk quota.
- You cannot query ECSs created based on a specified image using the image filtering function.
- When you create an ECS with a specified disk, ensure that the disk and the ECS are in the same AZ (specified by availability_zone).
- The device_name field configured in block_device_mapping_v2 during the ECS creation does not take effect. The system generates a device name by default.
- ECSs cannot be created in networks with provider:network_type set to geneve.
provider:network_type being set to geneve indicates the internal high-speed network for BMSs.
- - If your ECS is remotely logged in using a key, use the key_name parameter. If your ECS is remotely accessed using a password, use the adminPass parameter. Linux ECSs support user_data for injection. Windows ECSs support admin_pass for injection.
- If the image based on which the ECS is created uses the native OpenStack API, ensure that the specified AZ and system disk capacity and type used when the ECS is created are the same as those used when the image is created. Otherwise, the ECS creation will fail.
+- If your ECS is remotely logged in using a key, use the key_name parameter. If your ECS is remotely accessed using a password, use the adminPass parameter. Linux ECSs support user_data for injection. Windows ECSs support admin_pass for injection.
- If the image used to create the ECS uses the native OpenStack API, ensure that the AZ and the system disk capacity and type specified during the ECS creation are the same as those of the image. Otherwise, the ECS creation will fail.
Request
Table 2 describes the request parameters.
@@ -475,7 +475,7 @@ echo 111 > c:\aaa.txt
String
Specifies the fixed IP address. Parameter port in the three network parameters (port, uuid, and fixed_ip) has the highest priority. If parameter fixed_ip is set, you must specify the UUID.
+Specifies the fixed IP address. Parameter port in the three network parameters (port, uuid, and fixed_ip) has the highest priority. If parameter fixed_ip is set, you must specify the UUID.
No
Specifies the maximum records displayed on a page in a pagination query.
-- Must be a decimal integer.
- Ranges from 1 (inclusive) to 100 (inclusive).
- Cannot contain +.
+- Must be a decimal integer.
- Ranges from 1 (inclusive) to 100 (inclusive).
- Cannot contain +.
- - You can obtain the association only after specifying either fpga_image_id or image_id. Otherwise, only one empty list is returned.
- Pagination query takes effect only if parameters page and size both have a value. If only one of them has a value, an error message indicating invalid parameter will be displayed. If both image_id and fpga_image_id are used, pagination query specified by page and size does not take effect.
+ - You can obtain the association only after specifying either fpga_image_id or image_id. Otherwise, only one empty list is returned.
- Pagination query takes effect only if parameters page and size both have a value. If only one of them has a value, an error message indicating invalid parameter will be displayed. If both image_id and fpga_image_id are used, the pagination query specified by page and size does not take effect.
Request
None
diff --git a/docs/ecs/api-ref/en-us_topic_0090187679.html b/docs/ecs/api-ref/en-us_topic_0090187679.html
index 485a6f4b9..e0c2f7f03 100644
--- a/docs/ecs/api-ref/en-us_topic_0090187679.html
+++ b/docs/ecs/api-ref/en-us_topic_0090187679.html
@@ -99,7 +99,7 @@
-Table 4 security_group_rule objects Parameter
+Table 4 security_group_rule objects Parameter
Type
Integer
Specifies the stop port number. The value ranges from 1 to 65535 and cannot be less than from_port.
-When ip_protocol is icmp, this parameter indicates the ICMP code field with a length from 0 to 255 characters.
- NOTE: The ICMP message type is determined by the type field and code field in the packet. For details, see Appendix > ICMP-Port Range Relationship Table in Virtual Private Cloud API Reference. port_range_min indicates the ICMP type, and port_range_max indicates the ICMP code.
+Specifies the stop port number. The value ranges from 1 to 65535 and cannot be less than from_port.
+When ip_protocol is icmp, this parameter indicates the ICMP code field with a length from 0 to 255 characters.
+ NOTE: The ICMP message type is determined by the type field and code field in the packet. For details, see Appendix > ICMP-Port Range Relationship Table in Virtual Private Cloud API Reference. port_range_min indicates the ICMP type, and port_range_max indicates the ICMP code.
-Table 5 ip_range objects Parameter
+Table 5 ip_range objects Parameter
Type
-Table 4 security_group_rule objects Parameter
+Table 4 security_group_rule objects Parameter
Type
Integer
Specifies the stop port number. The value ranges from 1 to 65535 and cannot be less than from_port.
-When ip_protocol is icmp, this parameter indicates the ICMP code field with a length from 0 to 255 characters.
- NOTE: The ICMP message type is determined by the type field and code field in the packet. For details, see Appendix > ICMP-Port Range Relationship Table in Virtual Private Cloud API Reference. port_range_min indicates the ICMP type, and port_range_max indicates the ICMP code.
+When ip_protocol is icmp, this parameter indicates the ICMP code field with a length from 0 to 255 characters.
+ NOTE: The ICMP message type is determined by the type field and code field in the packet. For details, see Appendix > ICMP-Port Range Relationship Table in Virtual Private Cloud API Reference. port_range_min indicates the ICMP type, and port_range_max indicates the ICMP code.
Object
Specifies the name of the peer security group and the ID of the tenant in the peer security group. For details, see Table 6.
-Specify either ip_range or group.
+Specify either ip_range or group.
id
@@ -175,7 +175,7 @@
-Table 5 ip_range objects Parameter
+Table 5 ip_range objects Parameter
Type
String
Definition
-Specifies the name of the host on which the ECS is deployed. This is an extended attribute.
+Specifies the name of the host where the ECS is deployed. This is an extended attribute.
Range
N/A
Definition
Specifies the ECS failure cause.
Range
-- If the ECS status is normal, NULL is displayed.
- If the ECS status is faulty, fault message or details are returned.
- message: specifies the fault message.
- code: specifies the fault code.
- details: specifies the fault details.
- created: specifies the time when the fault occurred. The time is in ISO8601 format.
+- If the ECS status is normal, NULL is displayed.
- If the ECS status is abnormal, the fault message or details are returned.
- message: specifies the fault message.
- code: specifies the fault code.
- details: specifies the fault details.
- created: specifies the time when the fault occurred. The time is in ISO8601 format.
Definition
Specifies the status of the host accommodating the ECS.
Range
-- UP: The nova-compute status is normal.
- UNKNOWN: The nova-compute status is unknown.
- DOWN: the nova-compute status is abnormal.
- MAINTENANCE: The nova-compute is in maintenance state.
- Empty string: There is no host information.
+- UP: The nova-compute status is normal.
- UNKNOWN: The nova-compute status is unknown.
- DOWN: The nova-compute status is abnormal.
- MAINTENANCE: The nova-compute is in maintenance state.
- Empty string: There is no host information.
OS-EXT-SRV-ATTR:hostname
@@ -586,30 +586,23 @@
-Table 5 security_options field description Parameter
+Table 5 security_options field description Parameter
Mandatory
+Type
Type
-Description
+Description
tpm_enabled
+tpm_enabled
Yes
+Boolean
Boolean
-Definition
+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
+Range
+- true: Enable TPM.
- false: Disable TPM.
Querying Details About ECSs
-Function
This API is used to query details about ECSs according to search criteria.
+Listing Details About ECSs
+Function
This API is used to list details about ECSs based on search criteria.
The information that can be queried includes the ECS billing mode and whether the ECS is frozen.
URI
GET /v1/{project_id}/cloudservers/detail?flavor={flavor}&name={name}&status={status}&limit={limit}&offset={offset}¬-tags={not-tags}&reservation_id={reservation_id}&&tags={tags}&ip={ip}
@@ -244,7 +244,7 @@
Definition
Specifies the ECS status.
Range
-ACTIVE, BUILD, ERROR, HARD_REBOOT, MIGRATING, REBOOT, REBUILD, RESIZE, REVERT_RESIZE, SHUTOFF, VERIFY_RESIZE, DELETED, SHELVED, SHELVED_OFFLOADED, and UNKNOWN
+ACTIVE, BUILD, ERROR, HARD_REBOOT, MIGRATING, REBOOT, REBUILD, RESIZE, REVERT_RESIZE, SHUTOFF, VERIFY_RESIZE, DELETED, SHELVED, SHELVED_OFFLOADED, and UNKNOWN
For details, see ECS Statuses.
Definition
Specifies the status of the host where the ECS resides.
Range
-- UP: The status is normal.
- UNKNOWN: The status is unknown.
- DOWN: the status is abnormal.
- MAINTENANCE: The status is maintenance.
- Empty string: There is no host information.
+- UP: The status is normal.
- UNKNOWN: The status is unknown.
- DOWN: The status is abnormal.
- MAINTENANCE: The status is maintenance.
- Empty string: There is no host information.
OS-EXT-SRV-ATTR:hostname
@@ -773,7 +773,7 @@
-Example Request
Query details about ECSs. Ten records are displayed on each page, starting from the first page.
+Example Request
List details about ECSs. Ten records are displayed on each page, starting from the first page.
GET https://{endpoint}/v1/{project_id}/cloudservers/detail?offset=1&limit=10
Example Response
{
diff --git a/docs/ecs/api-ref/en-us_topic_0103071514.html b/docs/ecs/api-ref/en-us_topic_0103071514.html
index 4e8e4f6c9..ac53a730b 100644
--- a/docs/ecs/api-ref/en-us_topic_0103071514.html
+++ b/docs/ecs/api-ref/en-us_topic_0103071514.html
@@ -39,6 +39,16 @@
-
+
+GET /v1/{project_id}/cloudservers/{server_id}/block_device/{volume_id}
+ecs:cloudServers:get
+ecs:cloudServers:showServerBlockDevice
+-
+
POST /v2/{project_id}/servers/{server_id}/os-volume_attachments
diff --git a/docs/ecs/api-ref/en-us_topic_0108433461.html b/docs/ecs/api-ref/en-us_topic_0108433461.html
index aea4c2ac2..2e5d81bc0 100644
--- a/docs/ecs/api-ref/en-us_topic_0108433461.html
+++ b/docs/ecs/api-ref/en-us_topic_0108433461.html
@@ -12,7 +12,7 @@
- Querying ECSs by Tag
-- Querying Project Tags
+ - Listing Project Tags
- Querying Tags of an ECS
diff --git a/docs/ecs/api-ref/en-us_topic_0111860831.html b/docs/ecs/api-ref/en-us_topic_0111860831.html
index 6fa2fbd8d..2a1b1daad 100644
--- a/docs/ecs/api-ref/en-us_topic_0111860831.html
+++ b/docs/ecs/api-ref/en-us_topic_0111860831.html
@@ -4,7 +4,9 @@
-- Querying Information About Disks Attached to an ECS
+ - Querying Details of a Single Disk Attached to an ECS
+
+- Listing Details About Disks Attached to an ECS
- Attaching a Disk to an ECS
diff --git a/docs/ecs/api-ref/en-us_topic_0112708160.html b/docs/ecs/api-ref/en-us_topic_0112708160.html
index 6dcd2a460..8d34bb2c8 100644
--- a/docs/ecs/api-ref/en-us_topic_0112708160.html
+++ b/docs/ecs/api-ref/en-us_topic_0112708160.html
@@ -4,7 +4,7 @@
-- Querying Details About Flavors and Extended Flavor Information
+ - Listing Flavor Details and Extended Information
- Querying the Target Flavors to Which an ECS Flavor Can Be Changed
diff --git a/docs/ecs/api-ref/en-us_topic_0118308527.html b/docs/ecs/api-ref/en-us_topic_0118308527.html
index 77e6503c0..fad7907c6 100644
--- a/docs/ecs/api-ref/en-us_topic_0118308527.html
+++ b/docs/ecs/api-ref/en-us_topic_0118308527.html
@@ -418,7 +418,7 @@
-Table 7 Data structure of the network which an ECS accesses Parameter
+Table 7 Data structure of the network that an ECS accesses Parameter
Type
Querying NICs of an ECS
-Function
This API is used to query NICs of an ECS.
+Listing NICs of an ECS
+Function
This API is used to list NICs of an ECS.
URI
GET /v1/{project_id}/cloudservers/{server_id}/os-interface
Table 1 describes the parameters in the URI.
@@ -246,7 +246,7 @@
-Example Request
Query NICs of an ECS.
+Example Request
List NICs of an ECS.
GET https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/os-interface
Example Response
{
diff --git a/docs/ecs/api-ref/en-us_topic_0122107473.html b/docs/ecs/api-ref/en-us_topic_0122107473.html
index 0b1c87d2a..4d1d46052 100644
--- a/docs/ecs/api-ref/en-us_topic_0122107473.html
+++ b/docs/ecs/api-ref/en-us_topic_0122107473.html
@@ -1,7 +1,7 @@
-Querying Information About Disks Attached to an ECS
-Function
This API is used to query information about disks attached to an ECS.
+Listing Details About Disks Attached to an ECS
+Function
This API is used to list details about disks attached to an ECS.
URI
GET /v1/{project_id}/cloudservers/{server_id}/block_device
Table 1 describes the parameters in the URI.
@@ -166,7 +166,7 @@
-Example Request
Query information about disks attached to an ECS.
+Example Request
List details about disks attached to an ECS.
GET https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/block_device
Example Response
{
diff --git a/docs/ecs/api-ref/en-us_topic_0124385012.html b/docs/ecs/api-ref/en-us_topic_0124385012.html
index 3bbafafae..2688c786f 100644
--- a/docs/ecs/api-ref/en-us_topic_0124385012.html
+++ b/docs/ecs/api-ref/en-us_topic_0124385012.html
@@ -8,7 +8,7 @@
- Deleting NICs from an ECS in a Batch
-- Querying NICs of an ECS
+ - Listing NICs of an ECS
diff --git a/docs/ecs/api-ref/en-us_topic_0124385015.html b/docs/ecs/api-ref/en-us_topic_0124385015.html
index 1b4b17d33..f9b5cc248 100644
--- a/docs/ecs/api-ref/en-us_topic_0124385015.html
+++ b/docs/ecs/api-ref/en-us_topic_0124385015.html
@@ -10,9 +10,9 @@
- Deleting an ECS
-- Querying the ECS List
+ - Listing ECSs
-- Querying Details About ECSs
+ - Listing ECS Details
- Querying Details About an ECS
diff --git a/docs/ecs/api-ref/en-us_topic_0132905656.html b/docs/ecs/api-ref/en-us_topic_0132905656.html
index a71299938..7fb92a39d 100644
--- a/docs/ecs/api-ref/en-us_topic_0132905656.html
+++ b/docs/ecs/api-ref/en-us_topic_0132905656.html
@@ -100,7 +100,30 @@
-Response
See Responses (Jobs).
+Response
Table 4 describes the response parameters.
+
+Table 4 Response parameters Parameter
+Type
+Description
+job_id
+String
+Definition
+Specifies the job ID returned after a job is delivered. The job ID can be used to query the job execution progress. For details about how to query the job execution status based on job_id, see Job Status Management.
+Range
+N/A
+
+
+For details about abnormal responses, see Responses (Jobs).
Example Request
Migrate the ECS from the public resource pool to the DeH whose ID is 459a2b9d-804a-4745-ab19-a113bb1b4ddc.
POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/migrate
diff --git a/docs/ecs/api-ref/en-us_topic_0133622595.html b/docs/ecs/api-ref/en-us_topic_0133622595.html
index 3829873e6..a171b3555 100644
--- a/docs/ecs/api-ref/en-us_topic_0133622595.html
+++ b/docs/ecs/api-ref/en-us_topic_0133622595.html
@@ -1,7 +1,7 @@
Adding an ECS to an ECS Group
-Function
This API is used to add an ECS to an ECS group. The system automatically deploys the newly added ECS to a host that is different from the ones accommodating other ECSs in the ECS group.
+Function
This API is used to add an ECS to an ECS group. ECSs in the same group are automatically deployed on different hosts if possible.
Constraints
- The ECS to be added has been stopped.
- Only KVM ECSs can be added.
- Only the anti-affinity policy is supported. ECSs in the same ECS group are deployed on different hosts, improving service reliability.
diff --git a/docs/ecs/api-ref/en-us_topic_0133622596.html b/docs/ecs/api-ref/en-us_topic_0133622596.html
index f7ed83f9e..ecc5d885f 100644
--- a/docs/ecs/api-ref/en-us_topic_0133622596.html
+++ b/docs/ecs/api-ref/en-us_topic_0133622596.html
@@ -1,7 +1,7 @@
Removing an ECS from an ECS Group
-Function
This API is used to remove an ECS from an ECS group. After being removed, the anti-affinity policy will not take effect on this ECS and other ECSs in the same ECS group.
+Function
This API is used to remove an ECS from an ECS group. The anti-affinity policy will not be applied to the ECS after it is removed from the group.
Constraints
Only the anti-affinity policy is supported. ECSs in the same ECS group are deployed on different hosts, improving service reliability.
diff --git a/docs/ecs/api-ref/en-us_topic_0161097717.html b/docs/ecs/api-ref/en-us_topic_0161097717.html
index 48aea3633..ba7c1bd43 100644
--- a/docs/ecs/api-ref/en-us_topic_0161097717.html
+++ b/docs/ecs/api-ref/en-us_topic_0161097717.html
@@ -12,7 +12,7 @@
- Removing an ECS from an ECS Group
-- Querying ECS Groups
+ - Listing ECS Groups
- Querying Details About an ECS Group
diff --git a/docs/ecs/api-ref/en-us_topic_0167809633.html b/docs/ecs/api-ref/en-us_topic_0167809633.html
index 9feb1ab15..4bdec6fef 100644
--- a/docs/ecs/api-ref/en-us_topic_0167809633.html
+++ b/docs/ecs/api-ref/en-us_topic_0167809633.html
@@ -4,7 +4,7 @@
-- Querying Operations on an ECS
+ - Listing Actions on an ECS
- Querying ECS Operations by Request ID
diff --git a/docs/ecs/api-ref/en-us_topic_0167811961.html b/docs/ecs/api-ref/en-us_topic_0167811961.html
new file mode 100644
index 000000000..8f76ede04
--- /dev/null
+++ b/docs/ecs/api-ref/en-us_topic_0167811961.html
@@ -0,0 +1,163 @@
+
+
+Querying Details of a Single Disk Attached to an ECS
+Function
This API is used to query details of a single disk attached to an ECS.
+This API supports checking fine-grained permissions for enterprise projects. For details, see ecs:cloudServers:showServerBlockDevice.
+
+URI
GET /v1/{project_id}/cloudservers/{server_id}/block_device/{volume_id}
+Table 1 describes the parameters in the URI.
+
+
+
+Request
None
+
+Response
Table 2 describes the response parameters.
+Table 2 Response parameters Parameter
+Type
+Description
+volumeAttachment
+Object
+Specifies the disk attached to an ECS. For details, see Table 3.
+
+
+
+Table 3 volumeAttachment parameters Parameter
+Type
+Description
+serverId
+String
+Specifies the ECS ID in UUID format.
+volumeId
+String
+Specifies the EVS disk ID in UUID format.
+id
+String
+Specifies the mount ID, which is the same as the EVS disk ID.
+The value is in UUID format.
+size
+Integer
+Specifies the EVS disk size, in GiB.
+device
+String
+Specifies the drive letter of the EVS disk, displayed as the device name on the console.
+pciAddress
+String
+Specifies the PCI address.
+bootIndex
+Integer
+Specifies the EVS disk boot sequence.
+- 0 indicates the system disk.
- Non-0 indicates a data disk.
+bus
+String
+Specifies the disk bus type.
+Options: virtio and scsi
+
+
+
+
+Example Request
Query information about a specified disk attached to an ECS.
+GET https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/block_device/{volume_id}
+
+Example Response
{
+ "volumeAttachment": {
+ "pciAddress": "0000:02:01.0",
+ "volumeId": "a26887c6-c47b-4654-abb5-asdf234r234r",
+ "device": "/dev/vda",
+ "serverId": "4d8c3732-a248-40ed-bebc-539a6ffd25c0",
+ "id": "a26887c6-c47b-4654-abb5-asdf234r234r",
+ "size": "40",
+ "bootIndex": 0,
+ "bus":"virtio"
+ }
+}
+
+Returned Values
+
+Error Codes
See Error Codes.
+
+
+
+
+Parent topic: Disk Management
+
+
+
diff --git a/docs/ecs/api-ref/en-us_topic_0167811966.html b/docs/ecs/api-ref/en-us_topic_0167811966.html
index 3155459b5..748e1b259 100644
--- a/docs/ecs/api-ref/en-us_topic_0167811966.html
+++ b/docs/ecs/api-ref/en-us_topic_0167811966.html
@@ -1,8 +1,8 @@
-Querying Project Tags
+Listing Project Tags
Function
Projects are used to group and isolate OpenStack resources, which include computing, storage, and network resources. A project can be a department or a team. Multiple projects can be created for the same account.
-This API is used to query all tags used by a user in a specified project.
+This API is used to list all tags attached to a specified project.
URI
GET /v1/{project_id}/cloudservers/tags
Table 1 describes the parameters in the URI.
@@ -77,7 +77,7 @@
-Example Request
Query all tags used in a specified project.
+Example Request
List all tags attached to a specified project.
GET https://{endpoint}/v1/{project_id}/cloudservers/tags
Example Response
{
diff --git a/docs/ecs/api-ref/en-us_topic_0167957246.html b/docs/ecs/api-ref/en-us_topic_0167957246.html
index 4e1d8e7d5..edf11678a 100644
--- a/docs/ecs/api-ref/en-us_topic_0167957246.html
+++ b/docs/ecs/api-ref/en-us_topic_0167957246.html
@@ -223,7 +223,7 @@
-ipv6_bandwidth Field Description
This field is used by the following APIs:- Creating ECSs /v1/{project_id}/cloudservers
+ipv6_bandwidth Field Description
This field is used by the following APIs:- Creating ECSs /v1/{project_id}/cloudservers
Table 5 ipv6_bandwidth field description Parameter
extendparam Field Description for Creating Disks
This field is used by the following APIs:
- Creating ECSs /v1/{project_id}/cloudservers
-Table 6 extendparam field description for creating disks Parameter
+Table 6 extendparam field description for creating disks Parameter
Mandatory
String
Definition
-Specifies the IAM agency name.
+Specifies the agency name.
An agency is created by a tenant administrator on Identity and Access Management (IAM) to provide temporary credentials for ECSs to access cloud services.
Constraints
N/A
@@ -530,7 +530,7 @@
Definition
Specifies the ECS group ID in UUID format.
-Obtain the parameter value from the console or by referring to Querying the List of ECS Groups.
+Obtain the parameter value from the console or by referring to Listing ECS Groups.
Constraints
Ensure that the ECS group uses the anti-affinity policy.
The anti-affinity policy is not supported for ECSs created on a specified DeH.
@@ -591,7 +591,7 @@
Definition
Specifies the ECS group ID in UUID format.
-Obtain the parameter value from the console or by referring to Querying the List of ECS Groups
+Obtain the parameter value from the console or by referring to Listing ECS Groups
Constraints
N/A
Range
@@ -669,7 +669,7 @@
extra_dhcp_opts Field Description
This field is used by the following APIs:- Creating ECSs: /v1/{project_id}/cloudservers
-Table 13 extra_dhcp_opts field description Parameter
+Table 13 extra_dhcp_opts field description Parameter
Mandatory
Querying ECS Groups
-Function
This API is used to query ECS groups.
+Listing ECS Groups
+Function
This API is used to list ECS groups.
URI
GET /v1/{project_id}/cloudservers/os-server-groups
Table 1 describes the parameters in the URI.
@@ -155,7 +155,7 @@
-Example Request
Query ECS groups.
+Example Request
List ECS groups.
GET https://{endpoint}/v1/{project_id}/cloudservers/os-server-groups
Example Response
diff --git a/docs/ecs/api-ref/en-us_topic_0175597847.html b/docs/ecs/api-ref/en-us_topic_0175597847.html
index 62b639e4f..d280ec6cd 100644
--- a/docs/ecs/api-ref/en-us_topic_0175597847.html
+++ b/docs/ecs/api-ref/en-us_topic_0175597847.html
@@ -1,7 +1,7 @@
Querying Details About an ECS Group
-Function
This API is used to query details bout an ECS group.
+Function
This API is used to query details about an ECS group.
URI
GET /v1/{project_id}/cloudservers/os-server-groups/{server_group_id}
Table 1 describes the parameters in the URI.
@@ -102,7 +102,7 @@
-Example Request
Query details about a specified ECS group.
+Example Request
Query details about the specified ECS group.
GET https://{endpoint}/v1/{project_id}/cloudservers/os-server-groups/{server_group_id}
Example Response
{
diff --git a/docs/ecs/api-ref/en-us_topic_0178420672.html b/docs/ecs/api-ref/en-us_topic_0178420672.html
index 773a141df..4fec4f478 100644
--- a/docs/ecs/api-ref/en-us_topic_0178420672.html
+++ b/docs/ecs/api-ref/en-us_topic_0178420672.html
@@ -72,12 +72,12 @@
SHELVED
The ECS boot from an image is shelved.
+The ECS booting from an image is shelved.
SHELVED_OFFLOADED
The ECS boot from a volume is shelved.
+The ECS booting from a volume is shelved.
UNKNOWN
@@ -97,7 +97,7 @@
building
The ECS has been created but is not running.
+The ECS is being built after being created.
active
@@ -127,19 +127,19 @@
shelved
The ECS boot from an image is shelved.
+The ECS booting from an image is shelved.
shelved_offloaded
The ECS boot from a volume is shelved.
+The ECS booting from a volume is shelved.
-Table 3 OS-EXT-STS:task_state statuses Status
+Table 3 OS-EXT-STS:task_state statuses Status
Description
scheduling
The ECS is being created.
+The system is scheduling resources when the ECS is being created.
block_device_mapping
@@ -172,7 +172,7 @@
reboot_pending
A restarting command has been issued to an ECS, and the ECS is to be restarted.
+The ECS is pending a restart.
reboot_started
@@ -187,7 +187,7 @@
reboot_pending_hard
A forcible restarting command has been issued to an ECS, and the ECS is to be restarted.
+The ECS is pending a force restart.
reboot_started_hard
@@ -207,42 +207,42 @@
rebuild_spawning
The ECS is being rebuilt.
+The ECS is being rebuilt internally.
migrating
The ECS is being live migrated.
+The ECS is undergoing live migration.
resize_prep
The ECS specifications are to be modified, and resources are being prepared for the ECS.
+The ECS is preparing for being resized.
resize_migrating
The specifications of the ECS are being modified, and it is being migrated.
+The ECS is being resized and is currently in the migration phase.
resize_migrated
The specifications of the ECS are being modified, and it has been migrated.
+The ECS is being resized and the migration is complete.
resize_finish
The specifications of the ECS are being modified.
+The ECS is being resized and is currently completing the adjustment.
resize_reverting
The specifications modification of the ECS is being rolled back.
+The instance is being resized and is currently reverting the adjustment.
powering-off
The ECS is stopped.
+The ECS is being stopped.
powering-on
@@ -257,22 +257,22 @@
shelving
The ECS boot from an image is being shelved.
+The ECS booting from an image is being shelved.
shelving_offloading
The ECS boot from a volume is being shelved.
+The ECS booting from a volume is being shelved.
shelving_image_pending_upload
A shelving image is pending uploaded.
+A shelving image is pending upload.
shelving_image_uploading
A shelving image is pending uploaded.
+A shelving image is being uploaded.
unshelving