Example Request
GET https://{endpoint}/v2/{project_id}/servers/{server_id}/os-interface
+Example Request
Query 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
Example Response
{
diff --git a/docs/ecs/api-ref/en-us_topic_0020212662.html b/docs/ecs/api-ref/en-us_topic_0020212662.html
index b462fec68..bad11ffa6 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212662.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212662.html
@@ -1,10 +1,10 @@
-Querying NICs of an ECS
-Function
This API is used to query NICs of an ECS based on the NIC ID.
+
Querying Details About a Specified NIC of an ECS
+
Function
This API is used to query details about an NIC based on the NIC ID.
-
URI
GET /v2.1/{project_id}/servers/{server_id}/os-interface/{id}
-
GET /v2/{project_id}/servers/{server_id}/os-interface/{id}
+
URI
GET /v2.1/{project_id}/servers/{server_id}/os-interface/{port_id}
+
GET /v2/{project_id}/servers/{server_id}/os-interface/{port_id}
Table 1 describes the parameters in the URI.
Table 1 Parameter descriptionParameter
|
@@ -28,7 +28,7 @@
Specifies the ECS ID.
|
|---|
-id
+ |
port_id
|
Yes
|
@@ -109,7 +109,7 @@
-
Table 4 fixed_ips field descriptionParameter
+Table 4 fixed_ips field descriptionParameter
|
Type
|
@@ -136,8 +136,9 @@
-Example RequestGET https://{endpoint}/v2/{project_id}/servers/{server_id}/os-interface/{id}
-GET https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-interface/{id}
+ Example RequestQuery details about an NIC based on the specified NIC ID.
+ GET https://{endpoint}/v2/{project_id}/servers/{server_id}/os-interface/{port_id}
+GET https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-interface/{port_id}
Example Response{
"interfaceAttachment":
diff --git a/docs/ecs/api-ref/en-us_topic_0020212663.html b/docs/ecs/api-ref/en-us_topic_0020212663.html
index c6acbb20c..e2020afb7 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212663.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212663.html
@@ -2,6 +2,7 @@
Adding NICs to an ECS in a Batch
FunctionThis API is used to add one or multiple NICs to an ECS.
+ This API is an asynchronous API. After the NIC adding request is successfully delivered, a job ID is returned. This does not mean the NIC adding is complete. You need to call the API by referring to Querying Task Execution Status to query the job status. The SUCCESS status indicates that the NIC adding is successful.
URIPOST /v1/{project_id}/cloudservers/{server_id}/nics
Table 1 describes the parameters in the URI.
@@ -56,7 +57,7 @@
|---|
Table 3 nics field descriptionParameter
+Table 3 nics field descriptionParameter
|
Mandatory
|
@@ -94,6 +95,25 @@
Specifies the IP address. If this parameter is unavailable, the IP address is automatically assigned.
|
|---|
+ipv6_enable
+ |
+No
+ |
+Boolean
+ |
+Indicates whether to support IPv6 addresses.
+If this parameter is set to true, the NIC supports IPv6 addresses.
+ |
+
+ipv6_bandwidth
+ |
+No
+ |
+Object
+ |
+Specifies the bound shared bandwidth. For details, see ipv6_bandwidth Field Description.
+ |
+
Example RequestPOST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/nics
- {
+Example RequestAdd the NIC whose ID is d32019d3-bc6e-4319-9c1d-6722fc136a23 and security group ID is f0ac4394-7e4a-4409-9701-ba8be283dbc3 to an ECS.
+ POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/nics
+
+{
"nics": [
{
"subnet_id": "d32019d3-bc6e-4319-9c1d-6722fc136a23",
@@ -139,7 +161,7 @@
}
Example Response{
- "job_id": "70a599e0-31e7-49b7-b260-868f441e862b"
+ "job_id": "ff80808288d41e1b018990260955686a"
}
Returned ValuesSee Returned Values for General Requests.
diff --git a/docs/ecs/api-ref/en-us_topic_0020212664.html b/docs/ecs/api-ref/en-us_topic_0020212664.html
index b6c493ba4..b73ef09f6 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212664.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212664.html
@@ -57,7 +57,7 @@
|
|---|
Table 3 interfaceAttachment field descriptionParameter
+Table 3 interfaceAttachment field descriptionParameter
|
Mandatory
|
@@ -74,7 +74,7 @@
String
|
Specifies the port ID.
-Either port_id or net_id is used each time.
+The port_id and net_id cannot be specified at the same time.
|
|---|
net_id
@@ -84,7 +84,7 @@
| String
|
Specifies the network ID.
-Either port_id or net_id is used each time.
+The port_id and net_id cannot be specified at the same time.
|
fixed_ips
@@ -103,7 +103,7 @@
|
Table 4 fixed_ips field descriptionParameter
+Table 4 fixed_ips field descriptionParameter
|
Mandatory
|
@@ -194,7 +194,7 @@
|---|
Table 7 fixed_ips field descriptionParameter
+Table 7 fixed_ips field descriptionParameter
|
Type
|
@@ -221,9 +221,10 @@
-Example RequestPOST https://{endpoint}/v2/{project_id}/servers/{server_id}/os-interface
-POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-interface
- {
+Example Request- Add a NIC whose network ID is 3cb9bc59-5699-4588-a4b1-b87f96708bc6.
POST https://{endpoint}/v2/{project_id}/servers/{server_id}/os-interface
+POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-interface
+
+{
"interfaceAttachment" : {
"fixed_ips" : [
{
@@ -233,11 +234,20 @@ POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-interface
"net_id" : "3cb9bc59-5699-4588-a4b1-b87f96708bc6"
}
}
-{
+ - Add a NIC whose port ID is ce531f90-199f-48c0-816c-13e38010b442.
POST https://{endpoint}/v2/{project_id}/servers/{server_id}/os-interface
+POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-interface
+
+{
"interfaceAttachment" : {
+ "fixed_ips" : [
+ {
+ "ip_address" : "192.168.1.3"
+ }
+ ],
"port_id" : "ce531f90-199f-48c0-816c-13e38010b442"
}
}
+
Example Response{
"interfaceAttachment": {
diff --git a/docs/ecs/api-ref/en-us_topic_0020212665.html b/docs/ecs/api-ref/en-us_topic_0020212665.html
index f8c1e9e83..5bfd3cc48 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212665.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212665.html
@@ -2,6 +2,7 @@
Deleting NICs from an ECS in a Batch
FunctionThis API is used to uninstall and delete one or multiple NICs from an ECS.
+ This API is an asynchronous API. After the deletion request is successfully delivered, a job ID is returned. This does not mean the deletion is complete. You need to call the API by referring to Querying Task Execution Status to query the job status. The SUCCESS status indicates that the deletion is successful.
ConstraintsThe primary NIC of an ECS has routing rules configured and cannot be deleted.
@@ -58,7 +59,7 @@
|---|
Table 3 nics field descriptionParameter
+Table 3 nics field descriptionParameter
|
Mandatory
|
@@ -86,8 +87,10 @@
-Example RequestPOST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/nics/delete
- {
+Example RequestDelete the NIC whose ID is d32019d3-bc6e-4319-9c1d-6722fc136a23 from an ECS.
+ POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/nics/delete
+
+{
"nics": [
{
"id": "d32019d3-bc6e-4319-9c1d-6722fc136a23"
@@ -96,7 +99,7 @@
}
Example Response{
- "job_id": "70a599e0-31e7-49b7-b260-868f441e862b"
+ "job_id": "ff80808288d41e1b018990260955686a"
}
Returned ValuesSee Returned Values for General Requests.
diff --git a/docs/ecs/api-ref/en-us_topic_0020212666.html b/docs/ecs/api-ref/en-us_topic_0020212666.html
index f4269b8b4..6b7ce7833 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212666.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212666.html
@@ -58,7 +58,8 @@
Example RequestDELETE https://{endpoint}/v2/{project_id}/servers/{server_id}/os-interface/{port_id}
+Example RequestDelete 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}
Example ResponseNone
diff --git a/docs/ecs/api-ref/en-us_topic_0020212667.html b/docs/ecs/api-ref/en-us_topic_0020212667.html
index 83c0bfe50..b7750cf37 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212667.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212667.html
@@ -15,7 +15,7 @@
Creating an ECS
FunctionThis API is used to create one or more ECSs.
- This is an asynchronous API. After the ECS creation request is issued, the system will return job_id. The ECS creation is still in progress. Therefore, you need to call the API described in Querying Task Execution Status to obtain the task status. When the status changes to SUCCESS, the ECS has been created.
+ This API is an asynchronous API. After the creation request is successfully delivered, a job ID is returned. This does not mean the creation is complete. You need to call the API by referring to Querying Task Execution Status to query the job status. The SUCCESS status indicates that the creation is successful.
Before calling this API, you need to obtain Regions and Endpoints.
Logging in to an ECS can be authenticated using either a key pair or password. For security purposes, you are advised to use key pair authentication.
- Key pair
A key pair is used for ECS login authentication.
Method of calling APIs: Use the key_name field to specify the key file used for logging in to the ECS.
- - Password
If you choose the initial password for authentication in an ECS, you can log in to the ECS using the username and its initial password. The initial password of user root is used for authentication in Linux, while that of user Administrator is used for authentication in Windows.
+ - Password
If you choose the initial password for authentication in an ECS, you can log in to the ECS using the username and its initial password. The initial password of user root is used for authentication in Linux, while that of user Administrator is used for authentication in Windows.
Method of calling APIs: Use the adminPass field to specify the initial login password of the administrator account. For details about how to use the adminPass field, see Table 3. If an encrypted password is required for logging in to a Linux ECS that is created using an image with Cloud-Init installed, you can use the user_data field to inject the password. For details, see Table 3.  If the user_data field is specified for a Linux ECS that is created using an image with Cloud-Init installed, the adminPass field becomes invalid.
RequestRequest parameters
+ RequestRequest parameters
Table 2 describes the request parameters.
Table 2 Request parametersParameter
@@ -66,8 +66,8 @@
| Boolean
|
Specifies whether to check the request and create the ECS. The default value is false.
-- true: indicates that only the request is sent, but the ECS will not be created. Check items include mandatory parameters and request format.
- If the check fails, the system returns an error.
- If the check is successful, the system returns status code 202.
- - false: indicates that the request is sent and the ECS will be created if the check result is as expected.
+- true: The request is sent, but the ECS will not be created. Check items include mandatory parameters and request format.
- If the check fails, the system returns an error.
- If the check is successful, the system returns status code 202.
+ - false: The request is sent and the ECS will be created after the check is passed.
|
|---|
@@ -91,7 +91,7 @@
String
|
Specifies the ID of the system image used for creating ECSs. The ID is in Universally Unique Identifier (UUID) format.
- NOTE: - Certain ECS flavors cannot support all public images provided on the cloud service platform. To obtain the images supported by an ECS flavor, log in to the management console, view the images displayed on the Create ECS page, and obtain the image IDs on the Image Management Service page.
- If the creation fails, modify the parameter settings.
+ NOTE: - Certain ECS flavors cannot support all public images provided on the cloud platform. To obtain the images supported by an ECS flavor, log in to the management console, view the images displayed on the Create ECS page, and obtain the image IDs on the Image Management Service page.
- If the creation fails, modify the parameter settings.
|
@@ -102,7 +102,7 @@
String
|
Specifies the flavor ID of the ECS to be created.
-For details about the flavors that have been released, see "ECS Specifications and Types" in the Elastic Cloud Server User Guide.
+For details about the flavors that have been released, see "ECS Specifications and Types" in Elastic Cloud Server User Guide.
|
name
@@ -113,7 +113,7 @@
|
Specifies the ECS name.
Value requirements:
-- Consists of 1 to 64 characters, including letters, digits, underscores (_), and hyphens (-).
- If more than one ECS is to be created (the count value is greater than 1), the system automatically adds a hyphen followed by a four-digit incremental number, such as -0000, to the end of each ECS name. If you specify a number, the name of the first new ECS will start from the specified number. In this case, the ECS name contains a maximum of 59 characters.
NOTE: ECS hostnames comply with RFC952 and RFC1123 naming rules. It is recommended that you configure hostnames using digits, lower-case letters, and hyphens (-). Underscores (_) are converted into hyphens (-) by default.
+ - The parameter value consists of 1 to 128 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
- If more than one ECS is to be created (the count value is greater than 1), the system automatically adds a hyphen followed by a four-digit incremental number, such as -0000, to the end of each ECS name. If you specify a number, the name of the first new ECS will start from the specified number. In this case, the ECS name contains a maximum of 59 characters.
NOTE: ECS hostnames comply with RFC952 and RFC1123 naming rules. It is recommended that you configure hostnames using digits, lower-case letters, and hyphens (-). Underscores (_) are converted into hyphens (-) by default.
|
@@ -130,13 +130,13 @@
For more information about the user data to be injected, see "Injecting User Data into ECSs" in Elastic Cloud Server User Guide.
Examples
Before base64 encoding:
-
+batch_create_in_multi_az
+ |
+No
+ |
+Boolean
+ |
+Specifies whether ECSs can be deployed in multiple random AZs. The default value is false.
+- true: The batch created ECSs are deployed in multiple AZs.
- false: The batch created ECSs are deployed in a single AZ.
+This parameter is valid when availability_zone is left blank.
+ NOTE: When ECSs are created in batches, parameter count is mandatory.
+
+ |
+
extendparam
|
No
@@ -257,7 +270,7 @@ echo 111 > c:\aaa.txt
| Object
|
Provides the supplementary information about the ECS to be created.
-For details, see Table 6.
+For details, see Table 7.
|
metadata
@@ -268,9 +281,9 @@ echo 111 > c:\aaa.txt
|
Specifies the metadata of the ECS to be created.
You can use metadata to customize key-value pairs.
- NOTE: - A maximum of 10 key-value pairs can be injected.
- A metadata key consists of 1 to 255 characters and contains only uppercase letters, lowercase letters, spaces, digits, hyphens (-), underscores (_), colons (:), and decimal points (.).
- A metadata value consists of a maximum of 255 characters.
+ NOTE: - If the metadata contains sensitive data, take appropriate measures to protect the sensitive data, for example, controlling access permissions and encrypting the data.
- A maximum of 10 key-value pairs can be injected.
- A metadata key consists of 1 to 255 characters and contains only uppercase letters, lowercase letters, spaces, digits, hyphens (-), underscores (_), colons (:), and decimal points (.).
- A metadata value consists of a maximum of 255 characters.
- For details about reserved key-value pairs, see Table 8.
+ For details about reserved key-value pairs, see Table 9.
|
os:scheduler_hints
@@ -280,7 +293,7 @@ echo 111 > c:\aaa.txt
| Object
|
Schedules ECSs, for example, by configuring an ECS group.
-For details, see Table 9.
+For details, see Table 10.
|
tags
@@ -318,7 +331,7 @@ echo 111 > c:\aaa.txt
| String
|
Specifies the subnet of the ECS.
-The value must be the ID of the subnet created in the VPC specified by vpcid and in the format of the UUID.
+The value must be the ID of the subnet created in the VPC specified by vpcid and in the format of the UUID.
|
ip_address
@@ -328,8 +341,8 @@ echo 111 > c:\aaa.txt
| String
|
Specifies the IP address of the NIC used by the ECS. The value is an IPv4 address.
-Constraints:
-- If this parameter is left blank or set to "", an unused IP address in the subnet is automatically assigned as the IP address of the NIC.
- If this parameter is specified, its value must be an unused IP address in the network segment of the subnet.
+Constraints: - If this parameter is left blank or set to "", an unused IP address in the subnet is automatically assigned as the IP address of the NIC.
- If this parameter is specified, its value must be an unused IP address in the network segment of the subnet.
+ |
binding:profile
@@ -338,8 +351,7 @@ echo 111 > c:\aaa.txt
|
Object
|
-Allows you to customize data. Configure this parameter when creating a HANA ECS.
-For details, see Table 11.
+ | Allows you to customize data. Configure this parameter when creating an ECS. For details, see Table 12.
|
extra_dhcp_opts
@@ -348,8 +360,25 @@ echo 111 > c:\aaa.txt
|
Array of objects
|
-Indicates extended DHCP options.
-For details, see Table 12.
+ | Indicates extended DHCP options. For details, see Table 13.
+ |
+
+ipv6_enable
+ |
+No
+ |
+Boolean
+ |
+Specifies whether to support IPv6 addresses. If this parameter is set to true, the NIC supports IPv6 addresses.
+ |
+
+ipv6_bandwidth
+ |
+No
+ |
+Object
+ |
+Specifies the bound shared bandwidth. For details, see ipv6_bandwidth Field Description.
|
@@ -373,8 +402,7 @@ echo 111 > c:\aaa.txt
String
|
Specifies the ECS system disk type, which must be one of available disk types.
-The value can be ESSD, SSD, SAS, SATA, co-p1, or uh-l1.
+ The value can be ESSD, GPSSD, SSD, SAS, or SATA. - SSD: the ultra-high I/O type
- SAS: the high I/O type
- SATA: the common I/O type
- GPSSD: the general purpose SSD type
- ESSD: the extreme SSD type
If the specified disk type is not available in the AZ, the disk will fail to be created.
NOTE: - When the disk is created from a backup:
If the type of the backup's source disk is SSD, SAS, or SATA, you can create disks of any of these types.
@@ -389,11 +417,11 @@ echo 111 > c:\aaa.txt
|
Integer
|
-Specifies the system disk size, in GB. The value ranges from 1 to 1024.
+ | Specifies the system disk size in GB. The value ranges from 1 to 1024.
Constraints:
-- The system disk size must be greater than or equal to the minimum system disk size supported by the image (min_disk attribute of the image).
- If this parameter is not specified or is set to 0, the default system disk size is the minimum value of the system disk in the image (min_disk attribute of the image).
NOTE: To obtain the minimum system disk size (min_disk) of an image, click the image on the management console for its details. Alternatively, call the native OpenStack API for querying details about an image. For details, see "Querying Image Details (Native OpenStack)" in Image Management Service API Reference.
+ - The system disk size must be greater than or equal to the minimum system disk size supported by the image (min_disk attribute of the image).
- If this parameter is not specified or is set to 0, the default system disk size is the minimum value of the system disk in the image (min_disk attribute of the image).
+ NOTE: To obtain the minimum system disk size (min_disk) of an image, click the image on the management console for its details. Alternatively, call the native OpenStack API for querying details about an image. For details, see "Querying Image Details (Native OpenStack)" in Image Management Service API Reference.
-
|
hw:passthrough
@@ -438,8 +466,7 @@ echo 111 > c:\aaa.txt
| String
|
Specifies the type of the ECS data disk, which must be one of available disk types.
-The value can be ESSD, SSD, SAS, SATA, co-p1, or uh-l1.
+ The value can be ESSD, GPSSD, SSD, SAS, or SATA. - SSD: the ultra-high I/O type
- SAS: the high I/O type
- SATA: the common I/O type
- GPSSD: the general purpose SSD type
- ESSD: the extreme SSD type
If the specified disk type is not available in the AZ, the disk will fail to be created.
NOTE: - When the disk is created from a backup:
If the type of the backup's source disk is SSD, SAS, or SATA, you can create disks of any of these types.
@@ -477,7 +504,7 @@ echo 111 > c:\aaa.txt
|
Specifies the shared disk information.
- true: indicates that the created disk is a shared disk.
- false: indicates that the created disk is a common EVS disk.
- NOTE: - If this parameter is set to true, the type of the shared disk is SCSI.
- The shareable field is not used anymore. If both shareable and multiattach must be used, ensure that the values of the two fields are the same. If this parameter is not specified, common EVS disks are created by default.
+ NOTE: The shareable field is not used anymore. If both shareable and multiattach must be used, ensure that the values of the two fields are the same. If this parameter is not specified, common EVS disks are created by default.
|
@@ -498,7 +525,7 @@ echo 111 > c:\aaa.txt
Object
|
Provides the disk information.
-For details, see Table 5.
+For details, see Table 6.
|
data_image_id
@@ -517,7 +544,7 @@ echo 111 > c:\aaa.txt
|
Object
|
-Specifies the EVS disk metadata. Ensure that key and value in the metadata contain at most 255 bytes.
+ | Specifies the EVS disk metadata. Ensure that key and value in the metadata contain at most 255 bytes.
This field is used only when an encrypted disk is created.
If data disks are created using a data disk image, this field cannot be used.
For details, see metadata Field Description for Creating Disks.
@@ -549,11 +576,9 @@ echo 111 > c:\aaa.txt
For details about abnormal responses, see Responses (Task).
-Example RequestThe cloud service platform provides various ECS types. The flavor name/ID varies depending on ECS types and specifications. When you use APIs to create ECSs with different specifications, the request bodies are the same. You only need to change the parameter values in the following request example based on the parameters described in Request.
-
- - An ECS with flavor ID m3.larger is to be created, where the image ID is imageid_123, disk type is SSD, and VPC ID is 0dae26c9-9a70-4392-93f3-87d53115d171. An example request is as follows:
{
+Example Request- Create a pay-per-use ECS with 2 vCPUs, 16 GiB of memory, SSD disks attached, and 10 Mbit/s of bandwidth-billed EIP bound. Use the key pair for login authentication.
POST https://{endpoint}/v1/{project_id}/cloudservers
+
+{
"server": {
"availability_zone":"az1-dc1",
"name": "newserver",
@@ -573,7 +598,7 @@ echo 111 > c:\aaa.txt
"hw:passthrough": true
}
],
- "flavorRef": "m3.larger",
+ "flavorRef": "m3.large.8",
"vpcid": "0dae26c9-9a70-4392-93f3-87d53115d171",
"security_groups": [
{
@@ -604,9 +629,9 @@ echo 111 > c:\aaa.txt
"count": 1
}
}
-
- - An ECS is to be created using a full-ECS image, in which two data disks are contained. The disk settings of the newly created ECS are as follows:
- The system disk is encrypted.
- For the two data disks to be restored, one uses default settings, and the other uses the changed settings, SSD, 100 GB.
- In addition to the two data disks to be restored, a new data disk is to be attached to the ECS, and the settings of the disk are SSD, 50 GB.
-An example request is as follows: {
+- Use a full-ECS image with an encrypted system disk and two data disks attached to create an ECS. For the two data disks to be restored, one uses default settings, and the other uses the changed settings, SSD, 100 GB. Also, attach a 50 GB SSD disk to the ECS.
POST https://{endpoint}/v1/{project_id}/cloudservers
+
+{
"server": {
"availability_zone":"az1-dc1",
"name": "wholeImageServer",
@@ -646,8 +671,9 @@ echo 111 > c:\aaa.txt
"key_name": "sshkey-123"
}
}
- - An example pre-verification request body is as follows:
{
+ - Send a pre-verification request to check whether mandatory parameters are configured in the request and whether the request format is correct.
POST https://{endpoint}/v1/{project_id}/cloudservers
+
+{
"dry_run": true,
"server": {
"availability_zone":"az1-dc1",
@@ -681,6 +707,7 @@ echo 111 > c:\aaa.txt
}
}
+ Example Response{
"job_id": "93c82933d6b7827d3016b8771f2070873"
}
diff --git a/docs/ecs/api-ref/en-us_topic_0020212671.html b/docs/ecs/api-ref/en-us_topic_0020212671.html
index f36a48cfc..e35abd54c 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212671.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212671.html
@@ -2,6 +2,7 @@
Querying Disks Attached to an ECS
FunctionThis API is used to query the disks attached to an ECS.
+ Disks that have been successfully attached and are being attached are to be queried.
URIGET /v2.1/{project_id}/servers/{server_id}/os-volume_attachments
GET /v2/{project_id}/servers/{server_id}/os-volume_attachments
@@ -56,7 +57,7 @@
|
- Table 3 volumeAttachments field descriptionParameter
+Table 3 volumeAttachments field descriptionParameter
|
Type
|
@@ -97,7 +98,8 @@
-Example RequestGET https://{endpoint}/v2/{project_id}/servers/{server_id}/os-volume_attachments
+Example RequestQuery 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
Example Response{
diff --git a/docs/ecs/api-ref/en-us_topic_0020212672.html b/docs/ecs/api-ref/en-us_topic_0020212672.html
index 974dd2170..22ad9aa1a 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212672.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212672.html
@@ -103,7 +103,8 @@
Example RequestGET https://{endpoint}/v2/{project_id}/servers/{server_id}/os-volume_attachments/{volume_id}
+Example RequestQuery details about a disk attached to an ECS based on the specified disk ID.
+ GET https://{endpoint}/v2/{project_id}/servers/{server_id}/os-volume_attachments/{volume_id}
GET https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-volume_attachments/{volume_id}
Example Response{
diff --git a/docs/ecs/api-ref/en-us_topic_0020212674.html b/docs/ecs/api-ref/en-us_topic_0020212674.html
index 029fd31dc..0fbc34779 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212674.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212674.html
@@ -66,7 +66,7 @@
Integer
|
-Specifies the maximum number of CPU cores you can use.
+ | Specifies the maximum number of CPU cores that the current tenant can apply for.
|
|---|
maxTotalRAMSize
@@ -197,29 +197,30 @@
-Example RequestGET https://{endpoint}/v1/{project_id}/cloudservers/limits
+ Example RequestQuery the quotas of all resources in a project for a tenant.
+ GET https://{endpoint}/v1/{project_id}/cloudservers/limits
- Example ResponseExample response {
- "absolute": {
- "maxServerMeta": 128,
- "maxPersonality": 5,
- "maxImageMeta": 128,
- "maxPersonalitySize": 10240,
- "maxSecurityGroupRules": 20,
- "maxTotalKeypairs": -1,
- "totalRAMUsed": 75776,
- "totalInstancesUsed": 21,
- "maxSecurityGroups": 10,
- "totalFloatingIpsUsed": 0,
- "maxTotalCores": 20480,
- "totalSecurityGroupsUsed": 1,
- "maxTotalFloatingIps": 10,
- "maxTotalInstances": 2048,
- "totalCoresUsed": 40,
- "maxTotalRAMSize": 25165824,
- "maxServerGroups": 10,
- "maxServerGroupMembers": 16,
- "totalServerGroupsUsed": 2
+Example ResponseExample response {
+ "absolute":{
+ "maxServerMeta":128,
+ "maxPersonality":5,
+ "maxImageMeta":128,
+ "maxPersonalitySize":10240,
+ "maxSecurityGroupRules":20,
+ "maxTotalKeypairs":-1,
+ "totalRAMUsed":75776,
+ "totalInstancesUsed":21,
+ "maxSecurityGroups":10,
+ "totalFloatingIpsUsed":0,
+ "maxTotalCores":20480,
+ "totalSecurityGroupsUsed":1,
+ "maxTotalFloatingIps":10,
+ "maxTotalInstances":2048,
+ "totalCoresUsed":40,
+ "maxTotalRAMSize":25165824,
+ "maxServerGroups":10,
+ "maxServerGroupMembers":16,
+ "totalServerGroupsUsed":2
}
}
diff --git a/docs/ecs/api-ref/en-us_topic_0020212675.html b/docs/ecs/api-ref/en-us_topic_0020212675.html
index df764aed3..c42dbe6d7 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212675.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212675.html
@@ -19,7 +19,7 @@
|
Table 4 keypair field descriptionParameter
+Table 4 keypair field descriptionParameter
|
Type
|
@@ -109,17 +109,18 @@
-Example RequestGET https://{endpoint}/v2/{project_id}/os-keypairs
+Example RequestQuery the list of SSH key pairs.
+ GET https://{endpoint}/v2/{project_id}/os-keypairs
GET https://{endpoint}/v2.1/{project_id}/os-keypairs
Example Response{
"keypairs": [
{
"keypair": {
- "fingerprint": "15:b0:f8:b3:f9:48:63:71:cf:7b:5b:38:6d:44:2d:4a",
+ "fingerprint": "15:b0:f8:b3:f9:48:63:**:**:**:**:**:**:**:**:**",
"name": "keypair-601a2305-4f25-41ed-89c6-2a966fc8027a",
"type": "ssh",
- "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC+Eo/RZRngaGTkFs7I62ZjsIlO79KklKbMXi8F+KITD4bVQHHn+kV+4gRgkgCRbdoDqoGfpaDFs877DYX9n4z6FrAIZ4PES8TNKhatifpn9NdQYWA+IkU8CuvlEKGuFpKRi/k7JLos/gHi2hy7QUwgtRvcefvD/vgQZOVw/mGR9Q== Generated-by-Nova\n"
+ "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC+Eo/RZRngaGTkFs7I62ZjsIlO79Kkl****************************************************************************************************************************************************** Generated-by-Nova\n"
}
}
]
diff --git a/docs/ecs/api-ref/en-us_topic_0020212677.html b/docs/ecs/api-ref/en-us_topic_0020212677.html
index 4c04baa97..ee60a0f20 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212677.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212677.html
@@ -140,7 +140,8 @@
Example RequestGET https://{endpoint}/v2/{project_id}/os-keypairs/{keypair_name}
+Example RequestQuery details of a specified SSH key pair.
+ GET https://{endpoint}/v2/{project_id}/os-keypairs/{keypair_name}
GET https://{endpoint}/v2.1/{project_id}/os-keypairs/{keypair_name}
Example Response{
@@ -148,10 +149,10 @@ GET https://{endpoint}/v2.1/{project_id}/os-keypairs/{keypair_name}
"created_at": "2014-05-07T12:06:13.681238",
"deleted": false,
"deleted_at": null,
- "fingerprint": "9d:00:f4:d7:26:6e:52:06:4c:c1:d3:1d:fd:06:66:01",
+ "fingerprint": "9d:00:f4:d7:26:6e:52:**:**:**:**:**:**:**:**:**",
"id": 1,
"name": "keypair-3582d8b7-e588-4aad-b7f7-f4e76f0e4314",
- "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDYJrTVpcMwFqQy/oMvtUSRofZdSRHEwrsX8AYkRvn2ZnCXM+b6+GZ2NQuuWj+ocznlnwiGFQDsL/yeE+/kurqcPJFKKp60mToXIMyzioFxW88fJtwEWawHKAclbHWpR1t4fQ4DS+/sIbX/Yd9btlVQ2tpQjodGDbM9Tr9/+/3i6rcR+EoLqmbgCgAiGiVV6VbM2Zx79yUwd+GnQejHX8BlYZoOjCnt3NREsITcmWE9FVFy6TnLmahs3FkEO/QGgWGkaohAJlsgaVvSWGgDn2AujKYwyDokK3dXyeX3m2Vmc3ejiqPa/C4nRrCOlko5nSgV/9IXRx1ERImsqZnE9usB Generated-by-Nova\n",
+ "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDYJrTVpcMwFqQy/oMvtUSRofZdSRHEwrsX8AYkRvn2ZnCXM+b6+GZ2NQuuWj+ocznlnwiGFQDsL/yeE+/kurqcPJFKKp60mToXIMyzioFxW88fJtw*************************************************************************************************************************************************************************************************************************** Generated-by-Nova\n",
"updated_at": null,
"user_id": "fake"
}
diff --git a/docs/ecs/api-ref/en-us_topic_0020212678.html b/docs/ecs/api-ref/en-us_topic_0020212678.html
index 1cc69f895..15a599ec4 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212678.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212678.html
@@ -131,7 +131,7 @@
|---|
Table 5 keypair field descriptionParameter
+Table 5 keypair field descriptionParameter
|
Type
|
@@ -179,7 +179,7 @@
String
|
-Specifies the key type. The value is ssh or x509.
+ | Specifies the key type. The value is ssh or x509.
This parameter is supported in microversion 2.2 and later.
|
|---|
@@ -188,44 +188,46 @@
-Example RequestImporting an SSH Key
- POST https://{endpoint}/v2/{project_id}/os-keypairs
-POST https://{endpoint}/v2.1/{project_id}/os-keypairs
- {
+Example Request- Import an SSH key.
POST https://{endpoint}/v2/{project_id}/os-keypairs
+POST https://{endpoint}/v2.1/{project_id}/os-keypairs
+
+{
"keypair": {
- "public_key": "ssh-rsaAAAAB3NzaC1yc2EAAAADAQABAAABAQDWNgTxQYeBzK9LYy4IakX7IsIl5j5zqR6BU2GJaEg3RK6dlS7rKFQhvy/V/1emK+GT/7P8up9VsMZ9Dx6PBOLow5p+2/wGsMlwDJpWiQ8zNnEMg+u/Ar/ZhYHAMyKEAOOJxIcnPoUgxfNdj/eiXV98AabsBdUA7QD30Og8F4Bmn2lii/WD9KbQQVjb7kbB3gNIJpGTUcoX73arorqkq/ppaLRmmwMJ7bTIGl8/0MWU2Dy+eTByOaDMb2htbB+j8ZXyEu7Oooy0NaSd+PNHv3PZ9OIVO7gd1lyoTRvCMK/F346+zmZtk5EASSOx5RifnSwk3NtugVjXs9GMJfFLBRibGenerated-by-Nova\\n\n",
+ "public_key": "ssh-rsaAAAAB3NzaC1yc2EAAAADAQABAAABAQDWNgTxQYeBzK9LYy4IakX7IsIl5j5zqR6BU2GJaEg3RK6dlS7rKFQhvy/V/1emK+GT/7P8up9VsMZ9Dx6PBOLow5p+2/wGsMlwDJpW*************************************************************************************************************************************************************************************************************************** Generated-by-Nova\\n\n",
"type": "ssh",
"name": "demo1",
"user_id": "fake"
}
}
-Creating an SSH Key
-POST https://{endpoint}/v2/{project_id}/os-keypairs
-POST https://{endpoint}/v2.1/{project_id}/os-keypairs
-{
+
+
Example responseImporting an SSH Key
{
"keypair": {
- "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDWNgTxQYeBzK9LYy4IakX7IsIl5j5zqR6BU2GJaEg3RK6dlS7rKFQhvy/V/1emK+GT/7P8up9VsMZ9Dx6PBOLow5p+2/wGsMlwDJpWiQ8zNnEMg+u/Ar/ZhYHAMyKEAOOJxIcnPoUgxfNdj/eiXV98AabsBdUA7QD30Og8F4Bmn2lii/WD9KbQQVjb7kbB3gNIJpGTUcoX73arorqkq/ppaLRmmwMJ7bTIGl8/0MWU2Dy+eTByOaDMb2htbB+j8ZXyEu7Oooy0NaSd+PNHv3PZ9OIVO7gd1lyoTRvCMK/F346+zmZtk5EASSOx5RifnSwk3NtugVjXs9GMJfFLBRib Generated-by-Nova\\n\n",
+ "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDWNgTxQYeBzK9LYy4IakX7IsIl5j5zqR6BU2GJaEg3RK6dlS7rKFQhvy/V/1emK+GT/7P8up9VsMZ9Dx6PBOLow5p+2/wGsMlwDJpWiQ8zNnE********************************************************************************************************************************************************************************************************************************************* Generated-by-Nova\\n\n",
"user_id": "6fc0d2cbbfab40b199874b97097e913d",
"name": "demo1",
- "fingerprint": "fc:47:b5:c3:7d:25:32:d5:d2:0c:19:f9:62:ac:8c:5a"
+ "fingerprint": "fc:47:b5:c3:7d:25:32:**:**:**:**:**:**:**:**:**"
}
}
Creating an SSH Key
{
"keypair": {
- "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDWNgTxQYeBzK9LYy4IakX7IsIl5j5zqR6BU2GJaEg3RK6dlS7rKFQhvy/V/1emK+GT/7P8up9VsMZ9Dx6PBOLow5p+2/wGsMlwDJpWiQ8zNnEMg+u/Ar/ZhYHAMyKEAOOJxIcnPoUgxfNdj/eiXV98AabsBdUA7QD30Og8F4Bmn2lii/WD9KbQQVjb7kbB3gNIJpGTUcoX73arorqkq/ppaLRmmwMJ7bTIGl8/0MWU2Dy+eTByOaDMb2htbB+j8ZXyEu7Oooy0NaSd+PNHv3PZ9OIVO7gd1lyoTRvCMK/F346+zmZtk5EASSOx5RifnSwk3NtugVjXs9GMJfFLBRib Generated-by-Nova\n",
- "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpQIBAAKCAQEA1jYE8UGHgcyvS2MuCGpF+yLCJeY+c6kegVNhiWhIN0SunZUu\n6yhUIb8v1f9Xpivhk/+z/LqfVbDGfQ8ejwTi6MOaftv8BrDJcAyaVokPMzZxDIPr\nvwK/2YWBwDMihADjicSHJz6FIMXzXY/3ol1ffAGm7AXVAO0A99DoPBeAZp9pYov1\ng/Sm0EFY2+5Gwd4DSCaRk1HKF+92q6K6pKv6aWi0ZpsDCe20yBpfP9DFlNg8vnkw\ncjmgzG9obWwfo/GV8hLuzqKMtDWknfjzR79z2fTiFTu4HdZcqE0bwjCvxd+Ovs5m\nbZORAEkjseUYn50sJNzbboFY17PRjCXxSwUYmwIDAQABAoIBADNKQ+ywUA3YQLDA\nUqlZKOB09h+0/YccG13D5TrNaV0yaMz6h31u7pYV/RI0TXxQTXbuZt5AoR4Xca9I\nC30bImmxTDDL45CGi/T0T5AgyS7t/iuM+smFkwI2YVbv53fL7q9yCxpucdnjC95/\nNj/+M3qxupIQ42uRVAYCU1jwF6J6YLy/9UamrmVd4bWFRtT19O7uszUhHLqJOZXq\n3ItqnMyD5bSMkzMN+RxmZVXAPkBOonGVeBBInCjvHv23REkngX38zcUSc543H3Di\n4673helqSdMnI0/TgyfLQcNuOsfQcD02ABWlGBe0nCTqP8pTRo86nzK1+AoCUp72\nIsTeviECgYEA8yHKeo/eZw25eDb3YTJovbgzA61n6AYQlDQv7rBGQDwKKQHdEqhR\nP0PbScaoT7wSeLtYV0vxxA6qjEEuHhZIk/t2wEILu+AH4AK88SUbUn6ZoYu+XmTA\nx26e2QRo8Ngi/KtIfeOGXx1PM/H2/OjEN3XjkfwJsj5bB+HjpF/wsnUCgYEA4Yxg\nWJYNrvSkmvXmDgxHwdxfUpVAcp40bvomNgYpKn9R2TyjMCSDIw8vVC6cGCFB9/Pc\nG0pr8RN2SvbTaPo/96DkKdHz7NAWkzUSChD4Oy7ZNXw6GK3x1tGwMWeTs1hQDHhO\nrjS+E3bV2jC4EIvLLBxCNCbhtmQwlGUj7ZhgHM8CgYEA14UGpWpOrW8/D086LpCu\nxC46GnJmfwiRPa6dJqpfO6V9JCigvV8y1i/ifR16KWP/w8HeZ1PMtgyCJd3JcaYz\nI+pus7JYEGxgzrPepKxN8eyDZu4nDCmnsaFfceQ02fnd2bhDhERh4oJqqRM966ax\n+K+p0MhoF/aqXuxgDF93T9kCgYEAw7TsfLFnGiJJGfS4NARP11UCmUPMcif4UztX\nIJVj7u4e9SJ6bvGfoDIy3Ra8duuUtDOzDzMaSkqa4B0f//z0uEew8uCsiRVeIUlx\nZ66l1aSm8JPkTTnRmJbGDXhUXtAIVWmmy94T+AurL/IKJMFH//RdNadvPrXcuUax\nUB5hd10CgYEA3JBuX4BriSk6Bii0kYniqFM/1tEgVelAP6DT6uePvzTFdSJ0dMQo\nzwgWNmm43CyoKW/rw8yIbtIQZKBfHudSNx72nSmnBKaf3QPB40xsCip90ZUTfZdn\nLJzX1t4clg1wNsN4mJDwiYM9k3rB/8EY1fh9gUYI84X6xFAHllkv0To=\n-----END RSA PRIVATE KEY-----\n",
+ "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDWNgTxQYeBzK9LYy4IakX7IsIl5j5zqR6BU2GJaEg3RK6dlS7rKFQhvy/V/1emK+GT/7P8up9VsMZ9Dx6PBOLow5p+2/wGsMlwDJpWiQ8zNnE********************************************************************************************************************************************************************************************************************************************* Generated-by-Nova\n",
+ "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpQIBAAKCAQEA1jYE8UGHgcyvS2MuCGpF+yLCJeY+c6kegVNhiWhIN0SunZUu\n6yhUIb8v1f9Xpivhk/+z/LqfVbDGfQ8ejwTi6MOaftv8BrDJcAyaVokPMzZxDIPr\nvwK/2YWBwDMihADjicSHJz6FIMXzXY/3ol1ffAGm7AXVAO0A99DoPBeAZp9pYov1\ng/Sm0EFY2+5Gwd4DSCaRk1HKF+92q6K6pKv6aWi0ZpsDCe20yBpfP9DFlNg8vnkw\ncjmgzG9obWwfo/GV8hLuzqKMtDWknfjzR79z2fTiFTu4HdZcqE0bwjCvxd+Ovs5m\nbZORAEkjseUYn50sJNzbboFY17PRjCXxSwUYmwIDAQABAoIBADNKQ+ywUA3YQLDA\nUqlZKOB09h+0/YccG13D5TrNaV0yaMz6h31u7pYV/RI0TXxQTXbuZt5AoR4Xca9I\nC30bImmxTDDL45CGi/T0T5AgyS7t/iuM+smFkwI2YVbv53fL7q9yCxpucdnjC95/\nNj/+M3qxupIQ42uRVAYCU1jwF6J6YLy/9UamrmVd4bWFRtT19O7uszUhHLqJOZXq\n3ItqnMyD5bSMkzMN+RxmZVXAPkBOonGVeBBInCjvHv23REkngX38zcUSc543H3Di\n4673helqSdMnI0/TgyfLQcNuOsfQcD02A**********************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************\n-----END RSA PRIVATE KEY-----\n",
"user_id": "6fc0d2cbbfab40b199874b97097e913d",
"type": "ssh",
"name": "demo",
- "fingerprint": "fc:47:b5:c3:7d:25:32:d5:d2:0c:19:f9:62:ac:8c:5a"
+ "fingerprint": "fc:47:b5:c3:7d:25:32:**:**:**:**:**:**:**:**:**"
}
}
Deleting ECSs
FunctionThis API is used to delete ECSs based on a specified ECS ID list.
- You can delete a single ECS or multiple ECSs in a batch. A maximum of 1000 ECSs can be deleted in a batch.
+ This API is an asynchronous API. After the deletion request is successfully delivered, a job ID is returned. This does not mean the deletion is complete. You need to call the API by referring to Querying Task Execution Status to query the job status. The SUCCESS status indicates that the deletion is successful.
+ You can delete a single ECS or multiple ECSs in a batch. A maximum of 1,000 ECSs can be deleted in a batch.
URIPOST /v1/{project_id}/cloudservers/delete
Table 1 describes the parameters in the URI.
@@ -74,7 +75,7 @@
Table 3 servers field descriptionParameter
+Table 3 servers field descriptionParameter
|
Mandatory
|
@@ -100,8 +101,9 @@
-Example RequestExample request POST https://{endpoint}/v1/{project_id}/cloudservers/delete
- {
+Example RequestDelete 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
+
+{
"servers": [
{
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19"
@@ -113,7 +115,7 @@
Example Response{
- "job_id": "70a599e0-31e7-49b7-b260-868f441e862b"
+ "job_id": "ff80808288d415d80189901d8eb81cbb"
}
Or
{
diff --git a/docs/ecs/api-ref/en-us_topic_0020212680.html b/docs/ecs/api-ref/en-us_topic_0020212680.html
index 4c02566e6..9b32c5331 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212680.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212680.html
@@ -37,8 +37,9 @@
Example RequestDELETE https://{endpoint}/v2/{project_id}/os-keypairs/{keypair_name}
-DELETE https://{endpoint}/v2.1/{project_id}/os-keypairs/{keypair_name}
+ Example RequestDelete the SSH key pair named KeyPair-123.
+ DELETE https://{endpoint}/v2/{project_id}/os-keypairs/KeyPair-123
+DELETE https://{endpoint}/v2.1/{project_id}/os-keypairs/KeyPair-123
diff --git a/docs/ecs/api-ref/en-us_topic_0020212688.html b/docs/ecs/api-ref/en-us_topic_0020212688.html
index 8dc58e00e..28f6cfb3a 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212688.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212688.html
@@ -62,7 +62,7 @@
String
|
- Specifies the ECS type ID, which is fuzzy matched.
+ | Specifies the ECS type ID, which is fuzzy-matched.
|
|---|
name
@@ -71,7 +71,7 @@
|
String
|
-Specifies the ECS name, which is fuzzy matched.
+ | Specifies the ECS name, which is fuzzy-matched.
|
status
@@ -94,7 +94,7 @@
| Integer
|
Specifies the upper limit on the number of returned results.
-The default value on each page is 25, and the information of a maximum of 1000 ECSs is displayed on each page.
+The default value on each page is 25, and the information of a maximum of 1,000 ECSs is displayed on each page.
|
marker
@@ -123,7 +123,7 @@
|
Queries ECSs with tags not containing the specified value. The value is the tag key.
For details about key rules, see Tag Types.
- NOTE: Tag functions have been upgraded on the cloud service platform. If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key".
+ NOTE: Tag functions have been upgraded on the cloud platform. If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key".
For example, an existing tag is a.b. After the tag function upgrade, query the tag using "not-tags=a".
|
@@ -153,7 +153,7 @@
String
|
-Indicates the filtering result for IPv4 addresses, which are fuzzy matched.
+ | Indicates the filtering result for IPv4 addresses, which are fuzzy-matched.
|
@@ -248,7 +248,8 @@
Example RequestGET https://{endpoint}/v2/{project_id}/servers
+Example RequestQuery a list of ECSs.
+ GET https://{endpoint}/v2/{project_id}/servers
GET https://{endpoint}/v2.1/{project_id}/servers
Example Response{
diff --git a/docs/ecs/api-ref/en-us_topic_0020212689.html b/docs/ecs/api-ref/en-us_topic_0020212689.html
index d8d81db6c..2f5224515 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212689.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212689.html
@@ -62,7 +62,7 @@
String
|
-Specifies the ECS flavor ID, which is fuzzy matched.
+ | Specifies the ECS flavor ID, which is fuzzy-matched.
|
|
|---|
name
@@ -71,7 +71,7 @@
|
String
|
-Specifies the ECS name, which is fuzzy matched.
+ | Specifies the ECS name, which is fuzzy-matched.
|
status
@@ -94,7 +94,7 @@
| Integer
|
Specifies the upper limit on the number of returned results.
-Each page contains 25 ECSs by default, and a maximum of 1000 ECSs are returned. For large volumes of data, you are advised to set the value to 100.
+Each page contains 25 ECSs by default, and a maximum of 1,000 ECSs are returned. For large data volumes, you are advised to set this parameter to 100.
|
marker
@@ -123,7 +123,7 @@
|
Queries ECSs with tags not containing the specified value. The value is the tag key.
For details about key rules, see Tag Types.
- NOTE: Tag functions have been upgraded on the cloud service platform. If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key".
+ NOTE: Tag functions have been upgraded on the cloud platform. If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key".
For example, an existing tag is a.b. After the tag function upgrade, query the tag using "not-tags=a".
|
@@ -153,7 +153,7 @@
String
|
-Indicates the filtering result for IPv4 addresses, which are fuzzy matched.
+ | Indicates the filtering result for IPv4 addresses, which are fuzzy-matched.
|
@@ -292,7 +292,7 @@
Specifies the network addresses of an ECS.
The structure is Map<String, Object>.
-- The key indicates the VPC subnet ID.
- The value indicates the network attributes specified in Table 7.
+- The key indicates the network name, for example, demo_net.
- The value indicates the network attribute specified in Table 7.
|
security_groups
@@ -493,7 +493,7 @@
|
Specifies ECS tags.
This parameter is supported in microversion 2.26 and later. If the microversion is not used for query, the response does not contain the tags field.
-Tag functions have been upgraded on the cloud service platform. After the upgrade, the tag values returned by the system comply with the following rules: - The key and value of a tag are connected using an equal sign (=), for example, key=value.
- If the value is empty, only the key is returned.
+ Tag functions have been upgraded on the cloud platform. After the upgrade, the tag values returned by the system comply with the following rules: - The key and value of a tag are connected using an equal sign (=), for example, key=value.
- If the value is empty, only the key is returned.
For more details about upgraded tag functions, see Tag Types.
|
@@ -615,7 +615,7 @@
Object
|
Extended flavor field
-For details, see Data Structure for Query Details About Specifications.
+For details, see Data Structure for Querying Details About Specifications.
This parameter is supported in microversion 2.47 and later.
|
@@ -777,7 +777,7 @@
Table 11 image field descriptionParameter
+Table 11 image field descriptionParameter
|
Type
|
@@ -837,7 +837,8 @@
|---|
Example RequestGET https://{endpoint}/v2/{project_id}/servers/detail
+Example RequestQuery details about ECSs.
+ GET https://{endpoint}/v2/{project_id}/servers/detail
GET https://{endpoint}/v2.1/{project_id}/servers/detail
Example Response{
diff --git a/docs/ecs/api-ref/en-us_topic_0020212690.html b/docs/ecs/api-ref/en-us_topic_0020212690.html
index d24ca5e2f..2db1fa9dc 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212690.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212690.html
@@ -157,7 +157,7 @@
Specifies the network addresses of an ECS.
The structure is Map<String, Object>.
-- The key indicates the VPC subnet ID.
- The value indicates the network attributes specified in Table 7.
+- The key indicates the network name, for example, demo_net.
- The value indicates the network attribute specified in Table 7.
|
|
|---|
security_groups
@@ -180,7 +180,7 @@
|
Specifies ECS tags.
This parameter is supported in microversion 2.26 and later. If the microversion is not used for query, the response does not contain the tags field.
-Tag functions have been upgraded on the cloud service platform. After the upgrade, the tag values returned by the system comply with the following rules: - The key and value of a tag are connected using an equal sign (=), for example, key=value.
- If the value is empty, only the key is returned.
+ Tag functions have been upgraded on the cloud platform. After the upgrade, the tag values returned by the system comply with the following rules: - The key and value of a tag are connected using an equal sign (=), for example, key=value.
- If the value is empty, only the key is returned.
For more details about upgraded tag functions, see Tag Types.
|
@@ -511,7 +511,7 @@
Table 6 links field descriptionParameter
+Table 6 links field descriptionParameter
|
Type
|
@@ -578,7 +578,7 @@
|---|
Table 8 os-extended-volumes:volumes_attached field descriptionParameter
+Table 8 os-extended-volumes:volumes_attached field descriptionParameter
|
Type
|
@@ -626,7 +626,7 @@
-Table 10 fault field descriptionParameter
+Table 10 fault field descriptionParameter
|
Type
|
@@ -700,7 +700,8 @@
|---|
Example RequestGET https://{endpoint}/v2/{project_id}/servers/{server_id}
+Example RequestQuery details about a specified ECS.
+ GET https://{endpoint}/v2/{project_id}/servers/{server_id}
GET https://{endpoint}/v2.1/{project_id}/servers/{server_id}
Example Response{
diff --git a/docs/ecs/api-ref/en-us_topic_0020212691.html b/docs/ecs/api-ref/en-us_topic_0020212691.html
index 2bb63054e..7743a95e9 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212691.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212691.html
@@ -12,7 +12,7 @@
Modifying the Specifications of an ECS
- Adding an ECS to the Monitoring List
+Adding an ECS to the Monitoring List
diff --git a/docs/ecs/api-ref/en-us_topic_0020212692.html b/docs/ecs/api-ref/en-us_topic_0020212692.html
index 248c0bf8d..06e41f949 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212692.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212692.html
@@ -1,7 +1,7 @@
- Modifying ECS Information
- FunctionThis API is used to modify ECS information. Only the name and description of an ECS can be modified.
+ Modifying ECS Details
+ FunctionThis API is used to modify ECS details. Only the name and description of an ECS can be modified.
URIPUT /v2.1/{project_id}/servers/{server_id}
PUT /v2/{project_id}/servers/{server_id}
@@ -57,7 +57,7 @@
|
|---|
Table 3 server field descriptionParameter
+Table 3 server field descriptionParameter
|
Mandatory
|
@@ -73,8 +73,7 @@
String
|
-Specifies the name of the modified ECS.
-The length is greater than 0 and less than 256
+ | Specifies the ECS new name. The value is a string of 1 to 255 characters.
|
|---|
description
@@ -113,7 +112,7 @@
|
Table 5 server field descriptionParameter
+Table 5 server field descriptionParameter
|
Type
|
@@ -258,7 +257,7 @@
Specifies ECS tags.
This parameter is supported in microversion 2.26 and later. If the microversion is not used for query, the response does not contain the tags field.
-Tag functions have been upgraded on the cloud service platform. After the upgrade, the tag values returned by the system comply with the following rules: - The key and value of a tag are connected using an equal sign (=), for example, key=value.
- If the value is empty, only the key is returned.
+ Tag functions have been upgraded on the cloud platform. After the upgrade, the tag values returned by the system comply with the following rules: - The key and value of a tag are connected using an equal sign (=), for example, key=value.
- If the value is empty, only the key is returned.
- The key and value of a tag are connected using an equal sign (=), for example, key=value.
- If the value is empty, only the key is returned.
For more details about upgraded tag functions, see Tag Types.
@@ -415,9 +414,11 @@
|
|---|
Example RequestPUT https://{endpoint}/v2/{project_id}/servers/{server_id}
-PUT https://{endpoint}/v2.1/{project_id}/servers/{server_id}
- {
+Example RequestChange the name of a specified ECS to new-server-test.
+ PUT https://{endpoint}/v2/{project_id}/servers/{server_id}
+PUT https://{endpoint}/v2.1/{project_id}/servers/{server_id}
+
+{
"server": {
"name": "new-server-test"
}
diff --git a/docs/ecs/api-ref/en-us_topic_0022067714.html b/docs/ecs/api-ref/en-us_topic_0022067714.html
index 24edf1f8a..f8176592f 100644
--- a/docs/ecs/api-ref/en-us_topic_0022067714.html
+++ b/docs/ecs/api-ref/en-us_topic_0022067714.html
@@ -106,7 +106,7 @@
- Example response
Normal response
{
- "job_id": "70a599e0-31e7-49b7-b260-868f441e862b"
+ "job_id": "ff80808288d41e1b018990260955686a"
}
Abnormal response
diff --git a/docs/ecs/api-ref/en-us_topic_0022067717.html b/docs/ecs/api-ref/en-us_topic_0022067717.html
index 63e4cf3fa..9e2954365 100644
--- a/docs/ecs/api-ref/en-us_topic_0022067717.html
+++ b/docs/ecs/api-ref/en-us_topic_0022067717.html
@@ -57,7 +57,7 @@
You do not have permission or your balance is insufficient.
|
-Check whether the account balance is insufficient and the account is frozen according to the returned error message.
+ | Check whether the account balance is insufficient or the account is frozen according to the returned error message.
|
|
|---|
400
@@ -621,6 +621,17 @@
| Replace a NIC.
|
+400
+ |
+Ecs.0090
+ |
+Image license type is BYOL, the BYOL feature is not supported at this time.
+ |
+BYOL image features are not supported in this region.
+ |
+Change the image or contact technical support.
+ |
+
400
|
Ecs.0100
@@ -951,6 +962,17 @@
| For details, see the returned error message or contact technical support.
|
+400
+ |
+Ecs.0227
+ |
+Failed to reboot.
+ |
+Failed to restart the ECS.
+ |
+Modify according to the returned error message or contact technical support.
+ |
+
400
|
Ecs.0301
@@ -1122,7 +1144,7 @@
|
Console logs query failed.
|
-Failed to query ECS console logs.
+ | Failed to query ECS console logs.
|
For details, see the returned error message or contact technical support.
|
@@ -1403,17 +1425,6 @@
Change the flavor or disk type.
|
-400
- |
-Ecs.0910
- |
-Invalid NIC settings for creating a HANA ECS.
- |
-Invalid NIC parameters for creating a HANA ECS.
- |
-Adjust the NIC parameter settings.
- |
-
400
|
Ecs.0911
@@ -1510,7 +1521,8 @@
|
OpenStack access timed out.
|
-Internal system processing timed out. For details, contact technical support.
+ | If you are switching a VPC, attaching or detaching a NIC or disk, or changing or reinstalling an OS, stop the process first and try again.
+If the retry timed out, contact technical support.
|
400
@@ -1561,7 +1573,7 @@
|
Pdp.0001
|
-Policy doesn't allow %s to be performed.
+ | Policy does not allow %s to be performed.
|
API authentication failed.
|
diff --git a/docs/ecs/api-ref/en-us_topic_0022067719.html b/docs/ecs/api-ref/en-us_topic_0022067719.html
index c85bcd871..0cf97288e 100644
--- a/docs/ecs/api-ref/en-us_topic_0022067719.html
+++ b/docs/ecs/api-ref/en-us_topic_0022067719.html
@@ -148,8 +148,8 @@
InfiniBand NIC status
|
This metric is used to monitor the status of an InfiniBand NIC on a high-performance h2 ECS to ensure proper InfiniBand NIC running.
-The system periodically checks the NIC status and returns check results using value 0 or 1.
-- 0: The system is running properly. That is, the InfiniBand NIC is functional.
- 1: The system is not running properly. That is, the InfiniBand NIC malfunctions.
+The system periodically checks the NIC status and returns check results using value 0 or 1.
+- 0: The system is running properly. That is, the InfiniBand NIC is functional.
- 1: The system is not running properly. That is, the InfiniBand NIC malfunctions.
|
0 or 1
|
diff --git a/docs/ecs/api-ref/en-us_topic_0022225398.html b/docs/ecs/api-ref/en-us_topic_0022225398.html
index bc35e5621..4d09fe3ad 100644
--- a/docs/ecs/api-ref/en-us_topic_0022225398.html
+++ b/docs/ecs/api-ref/en-us_topic_0022225398.html
@@ -133,7 +133,21 @@
-sub_jobs_total
+ | server_id
+ |
+String
+ |
+If the task is an ECS-related operation, the value is server_id.
+ |
+
+nic_id
+ |
+String
+ |
+If the task is a NIC-related operation, the value is nic_id.
+ |
+
+sub_jobs_total
|
Integer
|
@@ -152,7 +166,7 @@
Table 4 sub_jobs field descriptionParameter
+Table 4 sub_jobs field descriptionParameter
|
Type
|
@@ -165,7 +179,7 @@
String
|
Specifies the task status.
-- SUCCESS: indicates the task is successfully executed.
- RUNNING: indicates that the task is in progress.
- FAIL: indicates that the task failed.
- INIT: indicates that the task is being initialized.
+- SUCCESS: indicates the task is successfully executed.
- RUNNING: indicates that the task is in progress.
- FAIL: indicates that the task failed.
- INIT: indicates that the task is being initialized.
|
|---|
entities
@@ -223,7 +237,7 @@
|
Table 5 entities field descriptionParameter
+Table 5 sub_jobs.entities field descriptionParameter
|
Type
|
@@ -235,7 +249,7 @@
String
|
-If the task is an ECS-related operation, the value is server_id.
+ | If the task is an ECS-related operation, the value is server_id.
|
|---|
nic_id
@@ -257,7 +271,8 @@
-Example RequestGET https://{endpoint}/v1/{project_id}/jobs/{job_id}
+ Example RequestQuery the execution status of a specified asynchronous request task.
+ GET https://{endpoint}/v1/{project_id}/jobs/{job_id}
Example Response{
"status": "SUCCESS",
diff --git a/docs/ecs/api-ref/en-us_topic_0022472987.html b/docs/ecs/api-ref/en-us_topic_0022472987.html
index 02fd18184..597784da2 100644
--- a/docs/ecs/api-ref/en-us_topic_0022472987.html
+++ b/docs/ecs/api-ref/en-us_topic_0022472987.html
@@ -2,6 +2,7 @@
Attaching a Disk to an ECS
FunctionThis API is used to attach a disk to an ECS.
+ This API is an asynchronous API. After the attachment request is successfully delivered, a job ID is returned. This does not mean the attachment is complete. You need to call the API by referring to Querying Task Execution Status to query the job status. The SUCCESS status indicates that the attachment is successful.
URIPOST /v1/{project_id}/cloudservers/{server_id}/attachvolume
Table 1 describes the parameters in the URI.
@@ -93,7 +94,7 @@
String
|
Indicates the disk device name.
- NOTE: - The new disk device name cannot be the same as an existing one.
- For KVM ECSs, set the parameter value to /dev/vda for system disks. The device names for data disks of KVM ECSs are optional. If the device names of data disks are required, set them in alphabetical order. For example, if there are two data disks, set the device names of the two data disks to /dev/vdb and /dev/vdc, respectively. If you set a device name starting with /dev/sd, the system uses /dev/vd by default.
+ NOTE: - The new disk device name cannot be the same as an existing one.
- For KVM ECSs, set the parameter value to /dev/vda for system disks. The device names for data disks of KVM ECSs are optional. If the device names of data disks are required, set them in alphabetical order. For example, if there are two data disks, set the device names of the two data disks to /dev/vdb and /dev/vdc, respectively. If you set a device name starting with /dev/sd, the system uses /dev/vd by default.
- For ECSs that only support SCSI disks, set the device name of the system disk to /dev/sda and the device names of data disks in alphabetical order, for example, /dev/sdb and /dev/sdc. The system will not change the default device names.
|
|
@@ -133,8 +134,10 @@
-Example RequestPOST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/attachvolume
- {
+Example RequestAttach a SCSI EVS disk to the device /dev/sda.
+ POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/attachvolume
+
+{
"volumeAttachment": {
"volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803",
"device": "/dev/sda",
@@ -146,7 +149,7 @@
}
Example Response{
- "job_id": "70a599e0-31e7-49b7-b260-868f441e862b"
+ "job_id": "ff80808288d41e1b018990260955686a"
}
Returned ValuesSee Returned Values for General Requests.
diff --git a/docs/ecs/api-ref/en-us_topic_0022472988.html b/docs/ecs/api-ref/en-us_topic_0022472988.html
index da55a86d9..f6fadc5ea 100644
--- a/docs/ecs/api-ref/en-us_topic_0022472988.html
+++ b/docs/ecs/api-ref/en-us_topic_0022472988.html
@@ -2,6 +2,7 @@
Detaching an EVS Disk from an ECS
FunctionThis API is used to detach an EVS disk from an ECS.
+ This API is an asynchronous API. After the detachment request is successfully delivered, a job ID is returned. This does not mean the detachment is complete. You need to call the API by referring to Querying Task Execution Status to query the job status. The SUCCESS status indicates that the detachment is successful.
URIDELETE /v1/{project_id}/cloudservers/{server_id}/detachvolume/{volume_id}?delete_flag=0
Table 1 describes the parameters in the URI.
@@ -52,10 +53,11 @@
- Example RequestDELETE https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/detachvolume/{volume_id}
+ Example RequestDetach a specified disk from an ECS.
+ DELETE https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/detachvolume/{volume_id}
Example Response{
- "job_id": "70a599e0-31e7-49b7-b260-868f441e862b"
+ "job_id": "ff80808288d41e1b018990260955686a"
}
Returned ValuesSee Returned Values for General Requests.
diff --git a/docs/ecs/api-ref/en-us_topic_0024734483.html b/docs/ecs/api-ref/en-us_topic_0024734483.html
index c479fb6b5..40c288517 100644
--- a/docs/ecs/api-ref/en-us_topic_0024734483.html
+++ b/docs/ecs/api-ref/en-us_topic_0024734483.html
@@ -8,7 +8,33 @@
2023-02-28
+ | 2024-04-26
+ |
+Modified the following content:
+
+ |
+
+2024-01-30
+ |
+Added the following content:
+Querying NICs of an ECS
+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.
+ |
+
+2023-11-03
+ |
+Modified the following content:
+
+ |
+
+2023-02-28
|
Added the following content:
@@ -35,7 +61,7 @@
| 2022-06-06
|
Added the following content:
-
+
Modified the following content:
|
@@ -195,7 +221,7 @@
2018-07-10
|
Added the following content:
-
+
|
2018-07-05
@@ -228,13 +254,13 @@
| 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:
-
+
|
2018-03-30
@@ -278,13 +304,13 @@
| 2017-08-30
|
Modified the following content:
-
+
|
2017-07-31
|
Modified the following content:
-
+
Deleted the following content:
- Deleted the adminPass field.
|
diff --git a/docs/ecs/api-ref/en-us_topic_0025560296.html b/docs/ecs/api-ref/en-us_topic_0025560296.html
index 2427119e2..81aabfa25 100644
--- a/docs/ecs/api-ref/en-us_topic_0025560296.html
+++ b/docs/ecs/api-ref/en-us_topic_0025560296.html
@@ -39,7 +39,8 @@
-Example RequestDELETE https://{endpoint}/v2/{project_id}/servers/{server_id}
+Example RequestDelete a specified ECS.
+ DELETE https://{endpoint}/v2/{project_id}/servers/{server_id}
DELETE https://{endpoint}/v2.1/{project_id}/servers/{server_id}
Example ResponseNone
diff --git a/docs/ecs/api-ref/en-us_topic_0025560298.html b/docs/ecs/api-ref/en-us_topic_0025560298.html
index f581bf5e2..294a415bc 100644
--- a/docs/ecs/api-ref/en-us_topic_0025560298.html
+++ b/docs/ecs/api-ref/en-us_topic_0025560298.html
@@ -86,9 +86,11 @@
Example RequestPOST https://{endpoint}/v2/{project_id}/servers/{server_id}/metadata
-POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/metadata
- {
+Example RequestUpdate the metadata of a specified ECS to the user-defined metadata key-value pair.
+ POST https://{endpoint}/v2/{project_id}/servers/{server_id}/metadata
+POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/metadata
+
+{
"metadata": {
"key": "value"
}
diff --git a/docs/ecs/api-ref/en-us_topic_0025560299.html b/docs/ecs/api-ref/en-us_topic_0025560299.html
index cfe74bb7e..5dbe639f0 100644
--- a/docs/ecs/api-ref/en-us_topic_0025560299.html
+++ b/docs/ecs/api-ref/en-us_topic_0025560299.html
@@ -46,7 +46,8 @@
Example RequestDELETE https://{endpoint}/v2/{project_id}/servers/{server_id}/metadata/{key}
+Example RequestDelete the metadata from a specified ECS.
+ DELETE https://{endpoint}/v2/{project_id}/servers/{server_id}/metadata/{key}
DELETE https://{endpoint}/v2.1/{project_id}/servers/{server_id}/metadata/{key}
Example ResponseNone
diff --git a/docs/ecs/api-ref/en-us_topic_0025567413.html b/docs/ecs/api-ref/en-us_topic_0025567413.html
index 99fd2760b..b8622ef68 100644
--- a/docs/ecs/api-ref/en-us_topic_0025567413.html
+++ b/docs/ecs/api-ref/en-us_topic_0025567413.html
@@ -93,9 +93,11 @@
Example RequestPUT https://{endpoint}/v2/{project_id}/servers/{server_id}/metadata/{key}
-PUT https://{endpoint}/v2.1/{project_id}/servers/{server_id}/metadata/{key}
- {
+Example RequestSet the metadata with a specified key of an ECS.
+ PUT https://{endpoint}/v2/{project_id}/servers/{server_id}/metadata/{key}
+PUT https://{endpoint}/v2.1/{project_id}/servers/{server_id}/metadata/{key}
+
+{
"meta":{
"key":"value"
}
diff --git a/docs/ecs/api-ref/en-us_topic_0028714261.html b/docs/ecs/api-ref/en-us_topic_0028714261.html
index fc5edd9a3..b71940217 100644
--- a/docs/ecs/api-ref/en-us_topic_0028714261.html
+++ b/docs/ecs/api-ref/en-us_topic_0028714261.html
@@ -53,7 +53,7 @@
Object
|
-For details about how to modify ECS specifications, see Table 3.
+ | For details about how to modify specifications, see Table 3.
|
@@ -86,9 +86,11 @@
-Example RequestPOST https://{endpoint}/v2/{project_id}/servers/{server_id}/action
-POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action
- {
+Example RequestChange the flavor of a specified ECS to s3.medium.2.
+ POST https://{endpoint}/v2/{project_id}/servers/{server_id}/action
+POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action
+
+{
"resize" : {
"flavorRef" : "s3.medium.2"
}
diff --git a/docs/ecs/api-ref/en-us_topic_0028714262.html b/docs/ecs/api-ref/en-us_topic_0028714262.html
index f5658ec56..7dde1369d 100644
--- a/docs/ecs/api-ref/en-us_topic_0028714262.html
+++ b/docs/ecs/api-ref/en-us_topic_0028714262.html
@@ -65,9 +65,11 @@
Example RequestPOST https://{endpoint}/v2/{project_id}/servers/{server_id}/action
-POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action
- {
+Example RequestConfirm the modifications to the specifications of a specified ECS.
+ POST https://{endpoint}/v2/{project_id}/servers/{server_id}/action
+POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action
+
+{
"confirmResize" : null
}
Example RequestPOST https://{endpoint}/v2/{project_id}/servers/{server_id}/action
-POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action
- {
+Example RequestRoll back modifications to the specifications of a specified ECS.
+ POST https://{endpoint}/v2/{project_id}/servers/{server_id}/action
+POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action
+
+{
"revertResize" : null
}
Table 3 volumeAttachment field descriptionParameter
+Table 3 volumeAttachment field descriptionParameter
|
Mandatory
|
@@ -157,9 +157,11 @@
-Example RequestPOST https://{endpoint}/v2/{project_id}/servers/{server_id}/os-volume_attachments
-POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-volume_attachments
- {
+Example RequestAttach the disk whose ID is 54667652-3029-4af8-9222-2d53066fd61c to /dev/sdb of a specified ECS.
+ POST https://{endpoint}/v2/{project_id}/servers/{server_id}/os-volume_attachments
+POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-volume_attachments
+
+{
"volumeAttachment": {
"volumeId": "54667652-3029-4af8-9222-2d53066fd61c",
"device": "/dev/sdb"
diff --git a/docs/ecs/api-ref/en-us_topic_0031167513.html b/docs/ecs/api-ref/en-us_topic_0031167513.html
index 90040c335..98d429e45 100644
--- a/docs/ecs/api-ref/en-us_topic_0031167513.html
+++ b/docs/ecs/api-ref/en-us_topic_0031167513.html
@@ -14,7 +14,7 @@
|---|
-Name of the network where the ECS accesses
+ | Network address of the ECS
|
Yes
|
@@ -129,12 +129,13 @@
Example RequestGET https://{endpoint}/v2/{project_id}/servers/{server_id}/ips
+Example RequestQuery the networks of a specified ECS.
+ GET https://{endpoint}/v2/{project_id}/servers/{server_id}/ips
GET https://{endpoint}/v2.1/{project_id}/servers/{server_id}/ips
Example Response{
"addresses": {
- "Name of the network where the ECS accesses": [
+ "Network address of the ECS": [
{
"version": 4,
"addr": "10.176.42.16"
diff --git a/docs/ecs/api-ref/en-us_topic_0031169059.html b/docs/ecs/api-ref/en-us_topic_0031169059.html
index 3e90d845f..7a5d39666 100644
--- a/docs/ecs/api-ref/en-us_topic_0031169059.html
+++ b/docs/ecs/api-ref/en-us_topic_0031169059.html
@@ -72,7 +72,7 @@
|
|---|
-Name of the network where the ECS accesses
+ | Network address of the ECS
|
List(Dict)
|
@@ -127,11 +127,12 @@
Example RequestGET https://{endpoint}/v2/{project_id}/servers/{server_id}/ips/{networkName}
+Example RequestQuery the specified network of a specified ECS.
+ GET https://{endpoint}/v2/{project_id}/servers/{server_id}/ips/{networkName}
GET https://{endpoint}/v2.1/{project_id}/servers/{server_id}/ips/{networkName}
Example Response{
- "Name of the network where the ECS accesses": [
+ "Network address of the ECS": [
{
"version": 4,
"addr": "10.0.0.4"
diff --git a/docs/ecs/api-ref/en-us_topic_0031169828.html b/docs/ecs/api-ref/en-us_topic_0031169828.html
index 2e42a6999..4f92e25ba 100644
--- a/docs/ecs/api-ref/en-us_topic_0031169828.html
+++ b/docs/ecs/api-ref/en-us_topic_0031169828.html
@@ -177,7 +177,8 @@
Example RequestGET https://{endpoint}/v2/{project_id}/os-networks
+Example RequestQuery the networks available to a tenant.
+ GET https://{endpoint}/v2/{project_id}/os-networks
GET https://{endpoint}/v2.1/{project_id}/os-networks
Example Response{
diff --git a/docs/ecs/api-ref/en-us_topic_0031176553.html b/docs/ecs/api-ref/en-us_topic_0031176553.html
index 410065725..4bfd6704d 100644
--- a/docs/ecs/api-ref/en-us_topic_0031176553.html
+++ b/docs/ecs/api-ref/en-us_topic_0031176553.html
@@ -1,7 +1,7 @@
Obtaining the Password for Logging In to an ECS
-FunctionThis API is used to obtain the random password generated during initial Windows ECS installation for user Administrator or the configured Cloudbase-init user when you use an image that supports Cloudbase-Init to create a Windows ECS.
+ FunctionThis API is used to obtain the random password generated during initial Windows ECS installation for user Administrator or the configured Cloudbase-init user when you use an image that supports Cloudbase-Init to create a Windows ECS.
After starting an ECS, wait for 5 to 10 minutes and ensure that the password is injected. Then, you can use this API to query the password.
Linux ECSs do not use this API to obtain a password.
@@ -58,11 +58,12 @@
Example RequestGET https://{endpoint}/v2/{project_id}/servers/{server_id}/os-server-password
+Example RequestObtain a random password of the administrator account (administrator or the account configured in Cloudbase-Init) generated by the system during the initial installation of a specified Windows ECS.
+ GET https://{endpoint}/v2/{project_id}/servers/{server_id}/os-server-password
GET https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-server-password
Example Response{
- "password": "UHC9+YW1xDC1Yu8Mg9n+tnOp7euEO/cW//9KgdJKWhr5w=="
+ "password": "UHC9+YW1xDC1Yu8Mg*************************"
}
Returned ValuesSee Returned Values for General Requests.
diff --git a/docs/ecs/api-ref/en-us_topic_0031176554.html b/docs/ecs/api-ref/en-us_topic_0031176554.html
index 7f9db076c..a2f341d46 100644
--- a/docs/ecs/api-ref/en-us_topic_0031176554.html
+++ b/docs/ecs/api-ref/en-us_topic_0031176554.html
@@ -1,7 +1,7 @@
Deleting the Password for Logging In to an ECS
- FunctionThis API is used to delete the recorded random password generated during initial Windows ECS installation. After the password is deleted, you can still use your password to log in to your ECS. However, you cannot use the Get Password function to recover the ECS initial password.
+ FunctionThis API is used to delete the random password records generated during initial installation of a Windows ECS. After the password is deleted, you can still use your password to log in to your ECS. However, you cannot use the Get Password function to recover the ECS initial password.
Linux ECSs do not use this API to delete a password.
URIDELETE /v2.1/{project_id}/servers/{server_id}/os-server-password
@@ -38,7 +38,8 @@
- Example RequestDELETE https://{endpoint}/v2/{project_id}/servers/{server_id}/os-server-password
+Example RequestDelete the password records generated during initial installation of a Windows ECS.
+ DELETE https://{endpoint}/v2/{project_id}/servers/{server_id}/os-server-password
DELETE https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-server-password
Example ResponseNone
diff --git a/docs/ecs/api-ref/en-us_topic_0065792792.html b/docs/ecs/api-ref/en-us_topic_0065792792.html
index f19f9beb7..a850cfd21 100644
--- a/docs/ecs/api-ref/en-us_topic_0065792792.html
+++ b/docs/ecs/api-ref/en-us_topic_0065792792.html
@@ -11,7 +11,7 @@
|
|---|
Example RequestGET https://{endpoint}/
+ Example RequestQuery all API versions.
+ GET https://{endpoint}/
Example Response{
- "versions": [{
- "links": [{
- "rel": "self",
- "href": "https://ecs.service.domain.com:443/v2/"
- }],
- "id": "v2.0",
- "updated": "2001-09-21T12:33:21Z",
- "status": "SUPPORTED"
- }]
+ "versions":[
+ {
+ "min_version":"",
+ "links":[
+ {
+ "rel":"self",
+ "href":"https://{endpoint}/v2/"
+ }
+ ],
+ "id":"v2.0",
+ "updated":"2011-01-21T11:33:21Z",
+ "version":"",
+ "status":"SUPPORTED"
+ },
+ {
+ "min_version":"2.1",
+ "links":[
+ {
+ "rel":"self",
+ "href":"https://{endpoint}/v2.1/"
+ }
+ ],
+ "id":"v2.1",
+ "updated":"2013-07-23T11:33:21Z",
+ "version":"2.60",
+ "status":"CURRENT"
+ }
+ ]
}
Returned ValuesSee Returned Values for General Requests.
diff --git a/docs/ecs/api-ref/en-us_topic_0065792794.html b/docs/ecs/api-ref/en-us_topic_0065792794.html
index 2170b31a9..d9924c19d 100644
--- a/docs/ecs/api-ref/en-us_topic_0065792794.html
+++ b/docs/ecs/api-ref/en-us_topic_0065792794.html
@@ -168,29 +168,34 @@
|
|---|
Example RequestGET https://{endpoint}/v2
+ Example RequestQuery information about a specified API version.
+ GET https://{endpoint}/v2.1
Example Response{
- "version": {
- "min_version": "",
- "media-types": [{
- "type": "application/vnd.openstack.compute+json;version=2",
- "base": "application/json"
- }],
- "links": [{
- "rel": "self",
- "href": "https://ecs.service.domain.com:443/v2/"
- },
- {
- "rel": "describedby",
- "href": "http://docs.openstack.org/",
- "type": "text/html"
- }],
- "id": "v2.0",
- "updated": "1999-02-20T11:33:21Z",
- "version": "",
- "status": "SUPPORTED"
- }
+ "version":{
+ "min_version":"2.1",
+ "media-types":[
+ {
+ "type":"application/vnd.openstack.compute+json;version=2.1",
+ "base":"application/json"
+ }
+ ],
+ "links":[
+ {
+ "rel":"self",
+ "href":"https://{endpoint}/v2.1/"
+ },
+ {
+ "rel":"describedby",
+ "href":"http://docs.openstack.org/",
+ "type":"text/html"
+ }
+ ],
+ "id":"v2.1",
+ "updated":"2013-07-23T11:33:21Z",
+ "version":"2.60",
+ "status":"CURRENT"
+ }
}
Returned ValuesSee Returned Values for General Requests.
diff --git a/docs/ecs/api-ref/en-us_topic_0065817681.html b/docs/ecs/api-ref/en-us_topic_0065817681.html
index c95dd4f38..8c7a411aa 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817681.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817681.html
@@ -20,7 +20,7 @@
diff --git a/docs/ecs/api-ref/en-us_topic_0065817683.html b/docs/ecs/api-ref/en-us_topic_0065817683.html
index 28ce65ebb..e10070b15 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817683.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817683.html
@@ -16,7 +16,7 @@
For more information about the user data to be injected, see "Injecting User Data into ECSs" in Elastic Cloud Server User Guide.
Examples
Before base64 encoding:
- |
|---|
Example RequestPOST https://{endpoint}/v2/{project_id}/servers/{server_id}/action
-POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action
- {
+Example RequestUse the 3ed456f5-3d8f-4383-a6c9-312032afcd1a image to rebuild an ECS.
+ POST https://{endpoint}/v2/{project_id}/servers/{server_id}/action
+POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action
+
+{
"rebuild" : {
"imageRef" : "3ed456f5-3d8f-4383-a6c9-312032afcd1a",
"name" : "rebuildName",
diff --git a/docs/ecs/api-ref/en-us_topic_0065817689.html b/docs/ecs/api-ref/en-us_topic_0065817689.html
index bef903f93..a10e0f324 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817689.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817689.html
@@ -97,16 +97,18 @@
String
|
-Specifies the ECS console logs.
+ | ECS console log results
|
|---|
Example RequestPOST https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/servers/47e9be4e-a7b9-471f-92d9-ffc83814e07a/action
-POST https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/servers/47e9be4e-a7b9-471f-92d9-ffc83814e07a/action
- {
+Example RequestObtain console logs of a specified ECS.
+ POST https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/servers/47e9be4e-a7b9-471f-92d9-ffc83814e07a/action
+POST https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/servers/47e9be4e-a7b9-471f-92d9-ffc83814e07a/action
+
+{
"os-getConsoleOutput" : {
"length" : "50"
}
diff --git a/docs/ecs/api-ref/en-us_topic_0065817690.html b/docs/ecs/api-ref/en-us_topic_0065817690.html
index 19a920a5a..f9530cda3 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817690.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817690.html
@@ -61,9 +61,11 @@
Example RequestPOST https://{endpoint}/v2/{project_id}/servers/{server_id}/action
-POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action
- {
+Example RequestLock a specified ECS.
+ POST https://{endpoint}/v2/{project_id}/servers/{server_id}/action
+POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action
+
+{
"lock": null
}
Example RequestPOST https://{endpoint}/v2/{project_id}/servers/{server_id}/action
-POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action
- {
+Example RequestUnlock a specified ECS.
+ POST https://{endpoint}/v2/{project_id}/servers/{server_id}/action
+POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action
+
+{
"unlock": null
}
Specifies the action.
Options:
-create , delete , evacuate , restore , stop , start , reboot , rebuild , revertResize , confirmResize , detach_volume , attach_volume , attach_interface , detach_interface , lock , unlock , resize , migrate , pause , unpause , rescue , unrescue , changePassword , shelve ,unshelve , live-migration , live_migration_cancel , live_migration_force_complete , trigger_crash_dump, extend_volume
+create, delete, evacuate, restore, stop, start, reboot, rebuild, revertResize, confirmResize, detach_volume, attach_volume, attach_interface, detach_interface, lock, unlock, resize, migrate, pause, unpause, rescue, unrescue, changePassword, shelve, unshelve, live-migration, live_migration_cancel, live_migration_force_complete, trigger_crash_dump, extend_volume
|
|
|---|
instance_uuid
@@ -165,7 +165,8 @@
|
Example RequestGET https://{endpoint}/v2/89655fe61c4c4a08b9f3e7f9095441b8/servers/e723eb40-f56e-40f9-8c8c-caa517fe06ba/os-instance-actions
+Example RequestQuery all historical operations 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
Example Response{
diff --git a/docs/ecs/api-ref/en-us_topic_0065817693.html b/docs/ecs/api-ref/en-us_topic_0065817693.html
index bcccae4bd..6a2c15aae 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817693.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817693.html
@@ -208,7 +208,8 @@
|
|---|
Example RequestGET https://{endpoint}/v2/89655fe61c4c4a08b9f3e7f9095441b8/servers/e723eb40-f56e-40f9-8c8c-caa517fe06ba/os-instance-actions/req-5a429946-c9cc-45cc-b5bd-68864209e5c
+Example RequestQuery a request on a specified ECS.
+ GET https://{endpoint}/v2/89655fe61c4c4a08b9f3e7f9095441b8/servers/e723eb40-f56e-40f9-8c8c-caa517fe06ba/os-instance-actions/req-5a429946-c9cc-45cc-b5bd-68864209e5c
GET https://{endpoint}/v2.1/89655fe61c4c4a08b9f3e7f9095441b8/servers/e723eb40-f56e-40f9-8c8c-caa517fe06ba/os-instance-actions/req-5a429946-c9cc-45cc-b5bd-68864209e5c
Example Response{
diff --git a/docs/ecs/api-ref/en-us_topic_0065817694.html b/docs/ecs/api-ref/en-us_topic_0065817694.html
index 6fb9487bb..ddc5bfdc4 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817694.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817694.html
@@ -4,10 +4,10 @@
FunctionThis API is used to create an image using an ECS. After the creation, you can use this image to create ECSs.
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 cloud service 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.
+ 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.
- 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.
URIPOST /v2.1/{project_id}/servers/{server_id}/action
POST /v2/{project_id}/servers/{server_id}/action
@@ -131,9 +131,11 @@
|
|---|
Example RequestPOST https://{endpoint}/v2/{project_id}/servers/{server_id}/action
-POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action
- {
+Example RequestUse a specified ECS to create a private image named new-image-name.
+ POST https://{endpoint}/v2/{project_id}/servers/{server_id}/action
+POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action
+
+{
"createImage" : {
"name" : "new-image-name",
"metadata": {
diff --git a/docs/ecs/api-ref/en-us_topic_0065817700.html b/docs/ecs/api-ref/en-us_topic_0065817700.html
index eb7420af2..621fdb708 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 objectsParameter
+Table 7 ip_range objectsParameter
|
Mandatory
|
diff --git a/docs/ecs/api-ref/en-us_topic_0065817702.html b/docs/ecs/api-ref/en-us_topic_0065817702.html
index f8909427e..6d870069d 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817702.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817702.html
@@ -1,7 +1,7 @@
-Querying Security Groups for a Specified ECS
-FunctionThis API is used to query security groups for a specified ECS.
+ Querying Security Groups of a Specified ECS
+ FunctionThis API is used to query security groups of a specified ECS.
URIGET /v2.1/{project_id}/servers/{server_id}/os-security-groups
GET /v2/{project_id}/servers/{server_id}/os-security-groups
@@ -120,7 +120,7 @@
|---|
Table 4 security_group_rule objectsParameter
+Table 4 security_group_rule objectsParameter
|
Mandatory
|
@@ -164,7 +164,7 @@
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.
|
|---|
@@ -185,7 +185,7 @@
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 @@
|
Table 5 ip_range objectsParameter
+Table 5 ip_range objectsParameter
|
Mandatory
|
@@ -256,7 +256,8 @@
|---|
Example RequestGET https://{endpoint}/v2/e73621affb8f44e1bc01898747ca09d4/servers/65fae4c2-3a09-46c6-af12-3b04f1fdba1e/os-security-groups
+Example RequestQuery security groups of a specified ECS.
+ GET https://{endpoint}/v2/e73621affb8f44e1bc01898747ca09d4/servers/65fae4c2-3a09-46c6-af12-3b04f1fdba1e/os-security-groups
GET https://{endpoint}/v2.1/e73621affb8f44e1bc01898747ca09d4/servers/65fae4c2-3a09-46c6-af12-3b04f1fdba1e/os-security-groups
Example Response{
diff --git a/docs/ecs/api-ref/en-us_topic_0065817703.html b/docs/ecs/api-ref/en-us_topic_0065817703.html
index 5b8d56616..5e405e347 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817703.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817703.html
@@ -192,7 +192,7 @@
Integer
|
Specifies the end port number. The value ranges from 1 to 65,535.
-- When the protocol type is set to ICMP, to_port is the ICMP code and ranges from 0 to 255.
- If both from_port and to_port are -1, it indicates that any ICMP packet can be transmitted.
+- When the protocol type is set to ICMP, to_port is the ICMP code and ranges from 0 to 255.
- If both from_port and to_port are -1, it indicates that any ICMP packet can be transmitted.
|
|
|---|
ip_range
diff --git a/docs/ecs/api-ref/en-us_topic_0065817705.html b/docs/ecs/api-ref/en-us_topic_0065817705.html
index 0b0f9f237..709b36d1d 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817705.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817705.html
@@ -109,7 +109,7 @@
|
Table 4 flavors field descriptionParameter
+Table 4 flavors field descriptionParameter
|
Type
|
@@ -143,7 +143,7 @@
|---|
Table 5 links field descriptionParameter
+Table 5 links field descriptionParameter
|
Type
|
@@ -169,7 +169,8 @@
|---|
Example RequestGET https://{endpoint}/v2/743b4c0428d94531b9f2add666642e6b/flavors
+Example RequestQuery available ECS flavors.
+ GET https://{endpoint}/v2/743b4c0428d94531b9f2add666642e6b/flavors
GET https://{endpoint}/v2.1/743b4c0428d94531b9f2add666642e6b/flavors
Example Response{
diff --git a/docs/ecs/api-ref/en-us_topic_0065817706.html b/docs/ecs/api-ref/en-us_topic_0065817706.html
index 35d10f79b..ed1796319 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817706.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817706.html
@@ -57,7 +57,8 @@
|
|---|
Example RequestGET https://{endpoint}/v2/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2/os-extra_specs
+Example RequestQuery the extra_specs details of a specified ECS flavor.
+ GET https://{endpoint}/v2/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2/os-extra_specs
GET https://{endpoint}/v2.1/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2/os-extra_specs
Example Response{
diff --git a/docs/ecs/api-ref/en-us_topic_0065817707.html b/docs/ecs/api-ref/en-us_topic_0065817707.html
index 8b30be354..bbf7f94c5 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817707.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817707.html
@@ -156,7 +156,8 @@
Example RequestDELETE https://{endpoint}/v2/6fbe9263116a4b68818cf1edce16bc4f/servers/ab258e25-e351-47c7-b6e3-0749c5d9ed6a/os-volume_attachments/54667652-3029-4af8-9222-2d53066fd61c
+Example RequestDetach the disk whose ID is 54667652-3029-4af8-9222-2d53066fd61c from a specified ECS.
+ DELETE https://{endpoint}/v2/6fbe9263116a4b68818cf1edce16bc4f/servers/ab258e25-e351-47c7-b6e3-0749c5d9ed6a/os-volume_attachments/54667652-3029-4af8-9222-2d53066fd61c
DELETE https://{endpoint}/v2.1/6fbe9263116a4b68818cf1edce16bc4f/servers/ab258e25-e351-47c7-b6e3-0749c5d9ed6a/os-volume_attachments/54667652-3029-4af8-9222-2d53066fd61c
Example ResponseNone
diff --git a/docs/ecs/api-ref/en-us_topic_0065817708.html b/docs/ecs/api-ref/en-us_topic_0065817708.html
index 32c778d9e..c0bd12a50 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817708.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817708.html
@@ -45,9 +45,9 @@
String
|
- Specifies the AZ to which the volume to be created belongs.
+ | Specifies the AZ where the volume is created.
If the specified AZ does not exist, creating the volume failed, and the volume is in error state.
-The AZ to which the volume to be created belongs must be specified in the cloud service system.
+An AZ must be specified during the volume creation.
|
|
|---|
display_description
@@ -95,7 +95,7 @@
| String
|
Specifies the volume type.
-Currently, the value can be SSD, SAS, SATA, co-p1, or uh-l1. - SSD: specifies the ultra-I/O disk type.
- SAS: specifies the high I/O disk type.
- SATA: specifies the common I/O disk type.
- co-p1: specifies the high I/O (performance-optimized I) disk type.
- uh-l1: specifies the ultra-high I/O (latency-optimized) disk type.
NOTE: EVS disks of the co-p1 and uh-l1 types are used exclusively for high performance computing (HPC) and SAP HANA ECSs.
+ Currently, the value can be SSD, SAS, SATA, co-p1, or uh-l1. - SSD: specifies the ultra-I/O disk type.
- SAS: specifies the high I/O disk type.
- SATA: specifies the common I/O disk type.
- co-p1: specifies the high I/O (performance-optimized I) disk type.
- uh-l1: specifies the ultra-high I/O (latency-optimized) disk type.
NOTE: EVS disks of the co-p1 and uh-l1 types are used exclusively for high performance computing (HPC) ECSs.
diff --git a/docs/ecs/api-ref/en-us_topic_0065817713.html b/docs/ecs/api-ref/en-us_topic_0065817713.html
index 045a1fa49..9992f57cd 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817713.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817713.html
@@ -62,7 +62,8 @@
|
Example RequestGET https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/servers/998af54b-5762-4041-abc1-f98a2c27b3a2/metadata
+Example RequestQuery metadata details of a specified ECS.
+ GET https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/servers/998af54b-5762-4041-abc1-f98a2c27b3a2/metadata
GET https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/servers/998af54b-5762-4041-abc1-f98a2c27b3a2/metadata
Example Response{
diff --git a/docs/ecs/api-ref/en-us_topic_0065817714.html b/docs/ecs/api-ref/en-us_topic_0065817714.html
index 245eda65c..4e334850c 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817714.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817714.html
@@ -63,7 +63,8 @@
|
|---|
Example RequestGET https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/servers/998af54b-5762-4041-abc1-f98a2c27b3a2/metadata/key1
+Example RequestObtain the metadata with a specified key of an ECS.
+ GET https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/servers/998af54b-5762-4041-abc1-f98a2c27b3a2/metadata/key1
GET https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/servers/998af54b-5762-4041-abc1-f98a2c27b3a2/metadata/key1
Example Response{
diff --git a/docs/ecs/api-ref/en-us_topic_0065817716.html b/docs/ecs/api-ref/en-us_topic_0065817716.html
index 667c957a7..d4b636bb4 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817716.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817716.html
@@ -167,32 +167,33 @@
Integer
|
-Specifies the size quota of ECS groups.
+ | Specifies the ECS quota in an ECS group.
|
|
|---|
Example RequestGET https://{endpoint}/v2/d9ebe43510414ef590a4aa158605329e/os-quota-sets/d9ebe43510414ef590a4aa158605329e/defaults
+Example RequestQuery default quotas of resources.
+ GET https://{endpoint}/v2/d9ebe43510414ef590a4aa158605329e/os-quota-sets/d9ebe43510414ef590a4aa158605329e/defaults
GET https://{endpoint}/v2.1/d9ebe43510414ef590a4aa158605329e/os-quota-sets/d9ebe43510414ef590a4aa158605329e/defaults
Example Response{
- "quota_set": {
- "injected_file_content_bytes": 10240,
- "metadata_items": 128,
- "server_group_members": 10,
- "server_groups": 10,
- "ram": 51200,
- "floating_ips": 10,
- "key_pairs": 100,
- "injected_file_path_bytes": 255,
- "instances": 10,
- "security_group_rules": 20,
- "injected_files": 5,
- "cores": 20,
- "fixed_ips": -1,
- "id": "474eff20eee84b2e87b5717cc7f34dd8",
- "security_groups": 10
+Example Response{
+ "quota_set":{
+ "injected_file_content_bytes":10240,
+ "metadata_items":128,
+ "server_group_members":10,
+ "server_groups":10,
+ "ram":51200,
+ "floating_ips":10,
+ "key_pairs":100,
+ "injected_file_path_bytes":255,
+ "instances":10,
+ "security_group_rules":20,
+ "injected_files":5,
+ "cores":20,
+ "fixed_ips":-1,
+ "id":"474eff20eee84b2e87b5717cc7f34dd8",
+ "security_groups":10
}
}
|
|---|
- Example RequestGET https://{endpoint}/v2/d9ebe43510414ef590a4aa158605329e/limits
+Example RequestQuery tenant quota limits.
+ GET https://{endpoint}/v2/d9ebe43510414ef590a4aa158605329e/limits
GET https://{endpoint}/v2.1/d9ebe43510414ef590a4aa158605329e/limits
Example Response{
diff --git a/docs/ecs/api-ref/en-us_topic_0065817720.html b/docs/ecs/api-ref/en-us_topic_0065817720.html
index 07c441afd..89053b30e 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 @@
- Table 5 server_group field descriptionParameter
+Table 5 server_group field descriptionParameter
|
Type
|
@@ -173,9 +173,11 @@
|---|
Example RequestPOST https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/os-server-groups
-POST https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/os-server-groups
- {
+Example RequestCreate an ECS group.
+ POST https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/os-server-groups
+POST https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/os-server-groups
+
+{
"server_group": {
"name": "test",
"policies": ["anti-affinity"]
diff --git a/docs/ecs/api-ref/en-us_topic_0065817721.html b/docs/ecs/api-ref/en-us_topic_0065817721.html
index 473e837d4..92e07aa78 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817721.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817721.html
@@ -115,7 +115,8 @@
|
|---|
Example RequestGET https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/os-server-groups
+Example RequestQuery a list of ECS groups.
+ GET https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/os-server-groups
GET https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/os-server-groups
Example Response{
diff --git a/docs/ecs/api-ref/en-us_topic_0065817722.html b/docs/ecs/api-ref/en-us_topic_0065817722.html
index ec988f39e..0e6573115 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817722.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817722.html
@@ -1,7 +1,7 @@
Querying Details About an ECS Group
-FunctionThis API is used to query details bout an ECS group.
+ FunctionThis API is used to query details about an ECS group.
URIGET /v2.1/{project_id}/os-server-groups/{server_group_id}
GET /v2/{project_id}/os-server-groups/{server_group_id}
@@ -120,7 +120,8 @@
|---|
Example RequestGET https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/os-server-groups/5bbcc3c4-1da2-4437-a48a-66f15b1b13f9
+Example RequestQuery details about an ECS group.
+ GET https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/os-server-groups/5bbcc3c4-1da2-4437-a48a-66f15b1b13f9
GET https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/os-server-groups/5bbcc3c4-1da2-4437-a48a-66f15b1b13f9
Example Response{
diff --git a/docs/ecs/api-ref/en-us_topic_0065817723.html b/docs/ecs/api-ref/en-us_topic_0065817723.html
index 0cc981928..591bd38fd 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817723.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817723.html
@@ -37,7 +37,8 @@
Example RequestDELETE https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/os-server-groups/5bbcc3c4-1da2-4437-a48a-66f15b1b13f9
+Example RequestDelete a specified ECS group.
+ DELETE https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/os-server-groups/5bbcc3c4-1da2-4437-a48a-66f15b1b13f9
DELETE https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/os-server-groups/5bbcc3c4-1da2-4437-a48a-66f15b1b13f9
Returned ValuesSee Returned Values for General Requests.
diff --git a/docs/ecs/api-ref/en-us_topic_0065817728.html b/docs/ecs/api-ref/en-us_topic_0065817728.html
index 5a469196e..f5d984891 100644
--- a/docs/ecs/api-ref/en-us_topic_0065817728.html
+++ b/docs/ecs/api-ref/en-us_topic_0065817728.html
@@ -99,7 +99,8 @@
|
|---|
Example RequestGET https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/os-availability-zone
+Example RequestQuery a list of AZs.
+ GET https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/os-availability-zone
GET https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/os-availability-zone
Example Response{
diff --git a/docs/ecs/api-ref/en-us_topic_0065820822.html b/docs/ecs/api-ref/en-us_topic_0065820822.html
index c008f8f29..12c36e772 100644
--- a/docs/ecs/api-ref/en-us_topic_0065820822.html
+++ b/docs/ecs/api-ref/en-us_topic_0065820822.html
@@ -49,7 +49,7 @@
Array of strings
|
Specifies ECS tags.
-Tag functions have been upgraded on the cloud service platform. After the upgrade, the tag values returned by the system comply with the following rules:
+Tag functions have been upgraded on the cloud platform. After the upgrade, the tag values returned by the system comply with the following rules:
- The key and value of a tag are connected using an equal sign (=), for example, key=value.
- If the value is empty, only the key is returned.
For more details about upgraded tag functions, see Tag Types.
|
@@ -58,7 +58,8 @@
|
|---|
Example RequestGET https://{endpoint}/v2.1/{project_id}/servers/{server_id}/tags
+ Example RequestQuery all tags attached to a specified ECS.
+ GET https://{endpoint}/v2.1/{project_id}/servers/{server_id}/tags
Example ResponseExample response {
"tags": ["baz=xyy", "foo", "qux"]
diff --git a/docs/ecs/api-ref/en-us_topic_0065820823.html b/docs/ecs/api-ref/en-us_topic_0065820823.html
index 4dc1412e6..613b28be4 100644
--- a/docs/ecs/api-ref/en-us_topic_0065820823.html
+++ b/docs/ecs/api-ref/en-us_topic_0065820823.html
@@ -103,8 +103,10 @@
|
|---|
Example RequestPUT https://{endpoint}/v2.1/{project_id}/servers/{server_id}/tags
- {
+Example RequestAdd tags to a specified ECS.
+ PUT https://{endpoint}/v2.1/{project_id}/servers/{server_id}/tags
+
+{
"tags": ["baz", "foo", "qux"]
}
Example RequestDELETE https://{endpoint}/v2.1/{project_id}/servers/{server_id}/tags
+ Example RequestDelete all tags from a specified ECS.
+ DELETE https://{endpoint}/v2.1/{project_id}/servers/{server_id}/tags
diff --git a/docs/ecs/api-ref/en-us_topic_0065820825.html b/docs/ecs/api-ref/en-us_topic_0065820825.html
index cdddef4c9..41ffefb77 100644
--- a/docs/ecs/api-ref/en-us_topic_0065820825.html
+++ b/docs/ecs/api-ref/en-us_topic_0065820825.html
@@ -35,7 +35,7 @@
Specifies the key of the tag to be added.
For details about key rules, see Tag Types.
- NOTE: Tag functions have been upgraded on the cloud service platform. If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key".
+ NOTE: Tag functions have been upgraded on the cloud platform. If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key".
For example, an existing tag is "a.b". The tag can be queried in the format of "tag=a.b" before and in the format of "tag=a" now according to the new tag rules.
|
@@ -81,7 +81,8 @@
|
|---|
Example RequestPUT https://{endpoint}/v2.1/{project_id}/servers/{server_id}/tags/{tag}
+ Example RequestAdd a tag to a specified ECS.
+ PUT https://{endpoint}/v2.1/{project_id}/servers/{server_id}/tags/{tag}
Example ResponseBy default, the response is in HTML format.
<html>
diff --git a/docs/ecs/api-ref/en-us_topic_0065820826.html b/docs/ecs/api-ref/en-us_topic_0065820826.html
index 76c9660d5..9d5a29f10 100644
--- a/docs/ecs/api-ref/en-us_topic_0065820826.html
+++ b/docs/ecs/api-ref/en-us_topic_0065820826.html
@@ -33,7 +33,7 @@
Specifies the key of the tag to be queried. If no key is specified, all tags of the ECS will be displayed.
For details about key rules, see Tag Types.
- NOTE: Tag functions have been upgraded on the cloud service platform. If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key".
+ NOTE: Tag functions have been upgraded on the cloud platform. If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key".
For example, an existing tag is "a.b". The tag can be queried in the format of "tag=a.b" before and in the format of "tag=a" now according to the new tag rules.
|
@@ -47,7 +47,8 @@
- Example RequestGET https://{endpoint}/v2.1/{project_id}/servers/{server_id}/tags/{tag}
+ Example RequestQuery whether an ECS has a specified tag.
+ GET https://{endpoint}/v2.1/{project_id}/servers/{server_id}/tags/{tag}
diff --git a/docs/ecs/api-ref/en-us_topic_0065820827.html b/docs/ecs/api-ref/en-us_topic_0065820827.html
index 45c9806d0..22d5aef00 100644
--- a/docs/ecs/api-ref/en-us_topic_0065820827.html
+++ b/docs/ecs/api-ref/en-us_topic_0065820827.html
@@ -35,7 +35,7 @@
Specifies the key of the tag to be deleted. If no key is specified, all tags of the ECS will be deleted.
For details about key rules, see Tag Types.
- NOTE: Tag functions have been upgraded on the cloud service platform. If the tags added before the function upgrade are in the format of "Key.Value", delete tags using "Key".
+ NOTE: Tag functions have been upgraded on the cloud platform. If the tags added before the function upgrade are in the format of "Key.Value", delete tags using "Key".
For example, an existing tag is a.b. After the tag function upgrade, delete the tag using "a".
|
@@ -49,7 +49,8 @@
- Example RequestDELETE https://{endpoint}/v2.1/{project_id}/servers/{server_id}/tags/{tag}
+ Example RequestDelete a specified tag from a specified ECS.
+ DELETE https://{endpoint}/v2.1/{project_id}/servers/{server_id}/tags/{tag}
diff --git a/docs/ecs/api-ref/en-us_topic_0065962600.html b/docs/ecs/api-ref/en-us_topic_0065962600.html
index c6aedc083..5b50c99f4 100644
--- a/docs/ecs/api-ref/en-us_topic_0065962600.html
+++ b/docs/ecs/api-ref/en-us_topic_0065962600.html
@@ -42,7 +42,7 @@
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 +.
|
|
|---|
@@ -115,7 +115,7 @@
String
|
Specifies the FPGA image status. Options:
-- initialing: 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.
+- initialing: 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_0067161469.html b/docs/ecs/api-ref/en-us_topic_0067161469.html
index b19bd2265..26e5f4138 100644
--- a/docs/ecs/api-ref/en-us_topic_0067161469.html
+++ b/docs/ecs/api-ref/en-us_topic_0067161469.html
@@ -1,7 +1,7 @@
-Adding a Security Group
-FunctionThis API is used to add an ECS to a security group.
+ Adding an ECS to a Security Group
+ FunctionThis API is used to add an ECS to a security group.
You are suggested to add an ECS to a maximum of five security groups.
URIPOST /v2.1/{project_id}/servers/{server_id}/action
@@ -84,8 +84,10 @@
- Example RequestPOST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action
- {
+Example RequestAdd a security group to a specified ECS.
+ POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action
+
+{
"addSecurityGroup": {
"name": "sg-test"
}
diff --git a/docs/ecs/api-ref/en-us_topic_0067161717.html b/docs/ecs/api-ref/en-us_topic_0067161717.html
index 2340b1f97..118ba151f 100644
--- a/docs/ecs/api-ref/en-us_topic_0067161717.html
+++ b/docs/ecs/api-ref/en-us_topic_0067161717.html
@@ -1,7 +1,7 @@
-Deleting a Security Group
-FunctionThis API is used to delete a security group for an ECS.
+ Removing a Security Group
+ FunctionThis API is used to remove a security group from an ECS.
URIPOST /v2.1/{project_id}/servers/{server_id}/action
POST /v2/{project_id}/servers/{server_id}/action
@@ -51,7 +51,7 @@
|
Object
|
-Specifies the security group to be deleted for an ECS. For details, see Table 3.
+ | Specifies the security group to be removed from an ECS. For details, see Table 3.
|
@@ -83,8 +83,10 @@
-Example Request
POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action
-
{
+Example Request
Remove a security group from an ECS.
+
POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action
+
+{
"removeSecurityGroup": {
"name": "sg-test"
}
diff --git a/docs/ecs/api-ref/en-us_topic_0067298110.html b/docs/ecs/api-ref/en-us_topic_0067298110.html
index af9b6a502..93ece06f7 100644
--- a/docs/ecs/api-ref/en-us_topic_0067298110.html
+++ b/docs/ecs/api-ref/en-us_topic_0067298110.html
@@ -174,14 +174,15 @@
Integer
|
-Specifies the size quota of ECS groups.
+ | Specifies the ECS quota in an ECS group.
|
-
Example Request
GET https://{endpoint}/v2/d9ebe43510414ef590a4aa158605329e/os-quota-sets/d9ebe43510414ef590a4aa158605329e
+Example Request
Query quotas of resources such as ECSs, vCPUs, and memory.
+
GET https://{endpoint}/v2/d9ebe43510414ef590a4aa158605329e/os-quota-sets/d9ebe43510414ef590a4aa158605329e
GET https://{endpoint}/v2.1/d9ebe43510414ef590a4aa158605329e/os-quota-sets/d9ebe43510414ef590a4aa158605329e
Example Response
{
diff --git a/docs/ecs/api-ref/en-us_topic_0067876349.html b/docs/ecs/api-ref/en-us_topic_0067876349.html
index c849bf8a6..8eb37e884 100644
--- a/docs/ecs/api-ref/en-us_topic_0067876349.html
+++ b/docs/ecs/api-ref/en-us_topic_0067876349.html
@@ -2,6 +2,7 @@
Reinstalling an ECS OS (Using an Image with Cloud-Init Installed)
Function
This API is used to reinstall an ECS OS. During the system disk reinstallation using the original image, the data disks of the ECS remain unchanged.
+
This API is an asynchronous API. After the OS reinstallation request is successfully delivered, a job ID is returned. This does not mean the reinstallation is complete. You need to call the API by referring to Querying Task Execution Status to query the job status. The SUCCESS status indicates that the reinstallation is successful.
After this API is called, the system uninstalls the system disk, uses the original image to create a system disk, and attaches it to the ECS. In this way, the OS is reinstalled.
Constraints
- You can only use an image with Cloud-Init or Cloudbase-Init installed.
- You can reinstall OS only on an ECS that is stopped or for which OS reinstallation has failed.
- You are not allowed to reinstall the OS of an ECS that does not have the system disk.
- You are not allowed to perform other operations when reinstalling the OS. Otherwise, reinstalling the OS will fail.
@@ -118,7 +119,7 @@
String
|
Specifies whether a user has the license of an image.
-- If this parameter is set to true, the license file delivered with the image is used, indicating that BYOL is used.
- If this parameter is set to a value other than true, BYOL is not used, and the license file provided by the cloud service platform must be used.
+- If this parameter is set to true, the license file delivered with the image is used, indicating that BYOL is used.
- If this parameter is set to a value other than true, BYOL is not used, and the license file provided by the cloud platform must be used.
The default value is not true, indicating that BYOL is not used.
|