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 +Example Request
- Add a NIC whose network ID is 3cb9bc59-5699-4588-a4b1-b87f96708bc6 to a specified ECS.
POST https://{endpoint}/v2/{project_id}/servers/{server_id}/os-interface POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-interface { @@ -234,7 +234,7 @@ 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 + - Add a NIC whose port ID is ce531f90-199f-48c0-816c-13e38010b442 to a specified ECS.
POST https://{endpoint}/v2/{project_id}/servers/{server_id}/os-interface POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-interface { diff --git a/docs/ecs/api-ref/en-us_topic_0020212667.html b/docs/ecs/api-ref/en-us_topic_0020212667.html index 907fe8992..d9fde9a2c 100644 --- a/docs/ecs/api-ref/en-us_topic_0020212667.html +++ b/docs/ecs/api-ref/en-us_topic_0020212667.html @@ -8,7 +8,7 @@ - Querying a Disk Attached to an ECS
- - Attaching a ECS Data Disk
+ - Attaching an ECS Data Disk
- Detaching a Disk from an ECS
diff --git a/docs/ecs/api-ref/en-us_topic_0020212668.html b/docs/ecs/api-ref/en-us_topic_0020212668.html
index d419521cc..e0aa9645e 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212668.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212668.html
@@ -2,7 +2,7 @@
- The content of user_data must be encoded with base64.
- The maximum size of the content to be injected (before encoding) is 32 KB.
- The content of user_data must be encoded with base64.
- The maximum size of the content to be injected (before encoding) is 32 KB.
- If the user_data field is specified for a Linux ECS that is created using an image with Cloud-Init installed, the adminPass field becomes invalid.
- ECS Statuses
- - Network APIs
- - ECS Monitoring Metrics
diff --git a/docs/ecs/api-ref/en-us_topic_0022067717.html b/docs/ecs/api-ref/en-us_topic_0022067717.html
index 60b4251bf..e3efc863f 100644
--- a/docs/ecs/api-ref/en-us_topic_0022067717.html
+++ b/docs/ecs/api-ref/en-us_topic_0022067717.html
@@ -244,7 +244,7 @@
- 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: 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.
- 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.
- If this parameter is set to true, the disk device type is SCSI, which allows ECS OSs to directly access the underlying storage media. SCSI reservation commands are supported.
- If this parameter is set to false, the disk device type is VBD, which supports only simple SCSI read/write commands.
- Fixed 59 UAT issues in Elastic Cloud Server API Reference 27.
- Fixed 59 UAT issues in Elastic Cloud Server API Reference 27.
- Added FPGA Logical File Management.
- Fixed 110 UAT issues in Elastic Cloud Server API Reference 26.
- Added FPGA Logical File Management.
- Fixed 110 UAT issues in Elastic Cloud Server API Reference 26.
- Added Network Management.
- Added Security Group Management.
- Added Attaching a ECS Data Disk.
- Added Obtaining the Password of an ECS.
- Added Deleting the Password of an ECS.
- Added Network Management.
- Added Security Group Management.
- Added Attaching an ECS Data Disk.
- Added Obtaining the Password of an ECS.
- Added Deleting the Password of an ECS.
- Added the user_data field in Creating an ECS.
- Added the user_data field in Creating an ECS.
- If you attach a bootable disk to an ECS, you must specify the disk drive letter.
- A disk created using a backup cannot be attached to an ECS as the system disk.
- An ECS in the SUSPENDED or PAUSED state, which is specified using the OS-EXT-STS:vm_state parameter of the ECS, cannot have a disk attached.
- The EVS must be in the available status.
- The EVS disk and the target ECS must be located in the same AZ.
- VBD EVS disks cannot be attached to BMSs.
- To create a system disk image or data disk image, use the IMS API (POST /v2/cloudimages/action). For details, see "Creating an Image" in Image Management Service API Reference.
- To create a full-ECS image, use the IMS API (POST /v1/cloudimages/wholeimages/action). For details, see "Creating a Full-ECS Image" in Image Management Service API Reference.
- To create a system disk image or data disk image, use the IMS API (POST /v2/cloudimages/action). For details, see "Creating an Image" in Image Management Service API Reference.
- To create a full-ECS image, use the IMS API (POST /v1/cloudimages/wholeimages/action). For details, see "Creating a Full-ECS Image" in Image Management Service API Reference.
- 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.
- 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.
- 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.
- Only data disks, the device name of which is not /dev/sda, can be detached from an ECS.
- Make sure that OTC Tools have been installed and enabled on the ECS. Otherwise, the uninstallation will fail.
- For a Linux ECS, you need to log in to the ECS and run the umount command to disassociate the target disk from the file system. In addition, you need to ensure that no data is being written into or being read from the disk. Otherwise, the detachment will fail.
- For a Windows ECS, you need to ensure that no data is being written into or being read from the disk when a disk is to be detached from the running ECS. Otherwise, data will be lost.
- OSs supporting EVS disk detachment from a running ECS include two parts:
- For the first part, see External Image File Formats and Supported OSs.
- Table 1 lists the second part of supported OSs.
Table 1 OSs supporting EVS disk detachment from a running ECS OS
-Request
N/A
+Request
None
Response
Table 2 describes the response parameters.
diff --git a/docs/ecs/api-ref/en-us_topic_0065817720.html b/docs/ecs/api-ref/en-us_topic_0065817720.html index da903cdb9..02c78c45a 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 description Parameter
+Table 5 server_group field description Parameter
Type
Querying Details About a Floating IP Address (Discarded)
-Function
This API is used to query the details about a floating IP address based on the ID of the IP address.
+Function
This API is used to query the details about a floating IP address based on the ID of the floating IP address.
This API has been discarded. Use the API described in "Querying a Floating IP Address".
URI
GET /v2/{project_id}/os-floating-ips/{floating_ip_id}
diff --git a/docs/ecs/api-ref/en-us_topic_0065962600.html b/docs/ecs/api-ref/en-us_topic_0065962600.html index b840db22f..91108e071 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 +.
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_0067876349.html b/docs/ecs/api-ref/en-us_topic_0067876349.html index 36b090f32..ecc3250dc 100644 --- a/docs/ecs/api-ref/en-us_topic_0067876349.html +++ b/docs/ecs/api-ref/en-us_topic_0067876349.html @@ -163,7 +163,7 @@ echo 111 > c:\aaa.txtString
Specifies the CMK ID, which indicates encryption in metadata. This parameter is used with __system__encrypted.
-NOTE:For details about how to obtain the CMK ID, see "Querying the List of CMKs" in Key Management Service API Reference.
+NOTE:For details about how to obtain the CMK ID through HTTPS requests, see "Querying the List of CMKs" in Key Management Service API Reference.
Constraints
- This API is native, which does not support the creation of ECSs using full-ECS images. To use full-ECS images to create ECSs, refer to Creating an ECS.
- When using this API to create an ECS, you cannot bind an EIP to the ECS during the creation process. To do so, see Creating an ECS.
- Parameter port in the three network parameters (port, uuid, and fixed_ip) has the highest priority. If parameter fixed_ip is set, you must specify the UUID.
- A file injection failure will result in the ECS creation failure.
- The following restrictions apply when you create ECSs using an image:
- You cannot create an ECS on a specified host.
- If a tenant backs up a disk in an ECS, the disk can be deleted only after the tenant deletes all the snapshots of the disk.
- The flavors with different resource types cannot be adjusted if you adjust the specifications of an ECS created using an image.
- Native APIs /v2/{project_id}/servers and /v2.1/{project_id}/servers provided by the cloud platform is developed based on and compatible with the community-version native OpenStack API.Compared with the community-version native API, this API has the following restrictions when you create an ECS using a specified image:
- Community-version native OpenStack API: creates an ECS using the local disk by default.
- Native API provided by the cloud platform: creates an ECS using the shared storage as the system disk.
- Native APIs /v2/{project_id}/servers and /v2.1/{project_id}/servers provided by the cloud platform is developed based on and compatible with the community-version native OpenStack API.
Compared with the community-version native API, this API has the following restrictions when you create an ECS using a specified image:-- Community-version native OpenStack API: creates an ECS using the local disk by default.
- Native API provided by the cloud platform: creates an ECS using the shared storage as the system disk for reliability.
Specifically, when you use the native API to create an ECS:- You can query information about the disks attached to the ECS.
- The ECS system disk uses the EVS disk quota.
- You cannot query ECSs created based on a specified image using the image filtering function.
Specifically, when you use the native API to create an ECS:- You can query information about the system disks attached to the ECS.
- The ECS system disk uses the EVS disk quota.
- You cannot query ECSs created based on a specified image using the image filtering function.
- When you create an ECS with a specified disk, ensure that the disk and the ECS are in the same AZ.
- The device_name field configured in block_device_mapping_v2 during the ECS creation does not take effect. The system generates a device name by default.
- ECSs cannot be created in networks with provider:network_type set to geneve.
@@ -91,7 +91,8 @@
provider:network_type being set to geneve indicates the internal high-speed network for BMSs.
String
Specifies the ECS image ID or URL.
-- Example image ID: 3b8d6fef-af77-42ab-b8b7-5a7f0f0af8f2
- Example image URL: http://glance.openstack.example.com/images/3b8d6fef-af77-42ab-b8b7-5a7f0f0af8f2
- If you use a specified disk as the system disk to create an ECS, this parameter is not required. If you do not use a disk to create an ECS, you must set a valid UUID. Otherwise, the API will return error code 400.
- Example image ID: 3b8d6fef-af77-42ab-b8b7-5a7f0f0af8f2
- Example image URL: +
- If you use a specified disk as the system disk to create an ECS, this parameter is not required. If you do not use a disk to create an ECS, you must set a valid UUID. Otherwise, the API will return error code 400.
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.
String
Specifies the fixed IP address. Parameter port in the three network parameters (port, uuid, and fixed_ip) has the highest priority. If parameter fixed_ip is set, you must specify the UUID.
+Specifies the fixed IP address. Parameter port in the three network parameters (port, uuid, and fixed_ip) has the highest priority. If parameter fixed_ip is set, you must specify the UUID.
Request
Table 2 describes the request parameters.
-Table 2 Request Parameter
+-Table 2 Request parameters Parameter
Type
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 +.
Table 4 security_group_rule objects Parameter
+-Table 4 security_group_rule objects Parameter
Type
Integer
Specifies the stop port number. The value ranges from 1 to 65,535 and cannot be less than from_port.
-When ip_protocol is icmp, this parameter indicates the ICMP code field with a length from 0 to 255 characters.
-NOTE:The ICMP message type is determined by the type field and code field in the packet. For details, see Appendix > ICMP-Port Range Relationship Table in Virtual Private Cloud API Reference. port_range_min indicates the ICMP type, and port_range_max indicates the ICMP code.
+Specifies the stop port number. The value ranges from 1 to 65,535 and cannot be less than from_port.
+When ip_protocol is icmp, this parameter indicates the ICMP code field with a length from 0 to 255 characters.
+NOTE:The ICMP message type is determined by the type field and code field in the packet. For details, see Appendix > ICMP-Port Range Relationship Table in Virtual Private Cloud API Reference. port_range_min indicates the ICMP type, and port_range_max indicates the ICMP code.
Table 5 ip_range objects Parameter
+-Table 5 ip_range objects Parameter
Type
Table 4 security_group_rule objects Parameter
+-Table 4 security_group_rule objects Parameter
Type
Integer
Specifies the stop port number. The value ranges from 1 to 65,535 and cannot be less than from_port.
-When ip_protocol is icmp, this parameter indicates the ICMP code field with a length from 0 to 255 characters.
-NOTE:The ICMP message type is determined by the type field and code field in the packet. For details, see Appendix > ICMP-Port Range Relationship Table in Virtual Private Cloud API Reference. port_range_min indicates the ICMP type, and port_range_max indicates the ICMP code.
+Specifies the stop port number. The value ranges from 1 to 65,535 and cannot be less than from_port.
+When ip_protocol is icmp, this parameter indicates the ICMP code field with a length from 0 to 255 characters.
+NOTE:The ICMP message type is determined by the type field and code field in the packet. For details, see Appendix > ICMP-Port Range Relationship Table in Virtual Private Cloud API Reference. port_range_min indicates the ICMP type, and port_range_max indicates the ICMP code.
Object
Specifies the name of the peer security group and the ID of the tenant in the peer security group. For details, see Table 6.
-Specify either ip_range or group.
+Specify either ip_range or group.
id
@@ -175,7 +175,7 @@Table 5 ip_range objects Parameter
+-Table 5 ip_range objects Parameter
Type
addresses
Object
+Map<String, Array of objects>
Specifies the network attribute of the ECS.
-The structure is Map<String, Object>.
- The key indicates the network name, for example, demo_net.
- The value indicates the network attribute specified in Table 1.
String
Reserved
+This is a reserved parameter.
accessIPv6
String
Reserved
+This is a reserved parameter.
fault
@@ -340,7 +339,7 @@String
Specifies the UUID of the Ramdisk image if an AMI image is used. In other scenarios, leave this parameter blank.
+Specifies the UUID of the ramdisk image if an AMI image is used. In other scenarios, leave this parameter blank.
OS-EXT-SRV-ATTR:root_device_name
diff --git a/docs/ecs/api-ref/en-us_topic_0094148850.html b/docs/ecs/api-ref/en-us_topic_0094148850.html index a33f6fa97..bdf88932f 100644 --- a/docs/ecs/api-ref/en-us_topic_0094148850.html +++ b/docs/ecs/api-ref/en-us_topic_0094148850.html @@ -251,9 +251,6 @@ "OS-DCF:diskConfig":"MANUAL", "OS-EXT-AZ:availability_zone":"az1-dc1", "os:scheduler_hints":{ - "guestos_product_name":[ - "KVM Virtual Machine" - ] }, "OS-EXT-SRV-ATTR:root_device_name":"/dev/sda", "OS-EXT-SRV-ATTR:ramdisk_id":"8999878c-4a62-4014-89be-1743ff3a5daf", @@ -349,9 +346,6 @@ "OS-DCF:diskConfig":"MANUAL", "OS-EXT-AZ:availability_zone":"az1-dc1", "os:scheduler_hints":{ - "guestos_product_name":[ - "KVM Virtual Machine" - ] }, "OS-EXT-SRV-ATTR:root_device_name":"/dev/sda", "OS-EXT-SRV-ATTR:ramdisk_id":"8999878c-4a62-4026-92be-1743ff3a5daf", @@ -442,9 +436,6 @@ "OS-DCF:diskConfig":"MANUAL", "OS-EXT-AZ:availability_zone":"az1-dc1", "os:scheduler_hints":{ - "guestos_product_name":[ - "KVM Virtual Machine" - ] }, "OS-EXT-SRV-ATTR:root_device_name":"/dev/sda", "OS-EXT-SRV-ATTR:ramdisk_id":"8999878c-4a25-4014-92be-1743ff3a5daf", @@ -544,9 +535,6 @@ "OS-DCF:diskConfig":"MANUAL", "OS-EXT-AZ:availability_zone":"az1-dc1", "os:scheduler_hints":{ - "guestos_product_name":[ - "KVM Virtual Machine" - ] }, "OS-EXT-SRV-ATTR:root_device_name":"/dev/sda", "OS-EXT-SRV-ATTR:ramdisk_id":"8999878c-4a62-4014-92be-1743ff3a5daf", diff --git a/docs/ecs/api-ref/en-us_topic_0102606095.html b/docs/ecs/api-ref/en-us_topic_0102606095.html index 31103fd11..ac54b19cf 100644 --- a/docs/ecs/api-ref/en-us_topic_0102606095.html +++ b/docs/ecs/api-ref/en-us_topic_0102606095.html @@ -240,7 +240,7 @@Table 7 resource_tag field description Parameter
+-Table 7 resource_tag field description Parameter
Type
- Response body when action is set to count
{ +- Response body when action is set to count
{ "total_count": 1000 }
-
- Response body when action is set to count
+ GET /v2/{project_id}/os-keypairs/{keypair_name}
GET /v2.1/{project_id}/os-keypairs/{keypair_name}
diff --git a/docs/ecs/api-ref/en-us_topic_0103071516.html b/docs/ecs/api-ref/en-us_topic_0103071516.html index bfc7b8d99..76aa6ac27 100644 --- a/docs/ecs/api-ref/en-us_topic_0103071516.html +++ b/docs/ecs/api-ref/en-us_topic_0103071516.html @@ -22,7 +22,7 @@-
Querying ECS metadata with a specified key (native OpenStack API)
+Obtaining ECS metadata with a specified key (native OpenStack API)
GET /v2/{project_id}/servers/{server_id}/metadata/{key}
GET /v2.1/{project_id}/servers/{server_id}/metadata/{key}
diff --git a/docs/ecs/api-ref/en-us_topic_0103071522.html b/docs/ecs/api-ref/en-us_topic_0103071522.html index 541f99dbc..d97d3f5f6 100644 --- a/docs/ecs/api-ref/en-us_topic_0103071522.html +++ b/docs/ecs/api-ref/en-us_topic_0103071522.html @@ -12,7 +12,7 @@+ Querying details about flavors and extended flavor information
GET /v1/{project_id}/cloudservers/flavors
String
Specifies the swap partition size required by the ECS flavor.
-This parameter has not been used. Its default value is "".
+This parameter has not been used. Its default value is "".
OS-FLV-EXT-DATA:ephemeral
@@ -190,7 +190,7 @@Integer
Specifies the temporary disk size. This is an extended attribute.
-This parameter has not been used. Its default value is 0.
+This parameter has not been used. Its default value is 0.
OS-FLV-DISABLED:disabled
@@ -217,7 +217,7 @@String
Specifies the software constraints of the network bandwidth that can be used by the ECS.
-This parameter has not been used. Its default value is null.
+This parameter has not been used. Its default value is null.
rxtx_cap
@@ -225,7 +225,7 @@String
Specifies the hardware constraints of the network bandwidth that can be used by the ECS.
-This parameter has not been used. Its default value is null.
+This parameter has not been used. Its default value is null.
os-flavor-access:is_public
@@ -233,7 +233,7 @@Boolean
Specifies whether a flavor is available to all tenants. This is an extended attribute.
-- true: indicates that a flavor is available to all tenants.
- false: indicates that a flavor is available only to certain tenants.
- true: indicates that a flavor is available to all tenants.
- false: indicates that a flavor is available only to certain tenants.
Default value: true
String
Reserved
+This is a reserved parameter.
addresses
@@ -177,7 +177,7 @@String
Reserved
+This is a reserved parameter.
created
@@ -226,7 +226,7 @@Integer
Reserved
+This is a reserved parameter.
links
diff --git a/docs/ecs/api-ref/en-us_topic_0161097718.html b/docs/ecs/api-ref/en-us_topic_0161097718.html index 1020905eb..10d090e68 100644 --- a/docs/ecs/api-ref/en-us_topic_0161097718.html +++ b/docs/ecs/api-ref/en-us_topic_0161097718.html @@ -3,7 +3,7 @@Creating an ECS Group
-Function
This API is used to create an ECS group.
Constraints
Only anti-affinity policies are supported.
+Constraints
Only anti-affinity groups are supported.
URI
POST /v1/{project_id}/cloudservers/os-server-groups
Table 1 describes the parameters in the URI. diff --git a/docs/ecs/api-ref/en-us_topic_0161341998.html b/docs/ecs/api-ref/en-us_topic_0161341998.html index 9b95188b2..1b529f711 100644 --- a/docs/ecs/api-ref/en-us_topic_0161341998.html +++ b/docs/ecs/api-ref/en-us_topic_0161341998.html @@ -12,7 +12,7 @@Obtaining the password for logging in to a Windows ECS (native OpenStack API)
+Obtaining the password for logging in to a Windows ECS (native OpenStack)
GET /v2/{project_id}/servers/{server_id}/os-server-password
GET /v2.1/{project_id}/servers/{server_id}/os-server-password
@@ -22,7 +22,7 @@-
Deleting the password for logging in to a Windows ECS (native OpenStack API)
+Deleting the password for logging in to a Windows ECS (native OpenStack)
DELETE /v2/{project_id}/servers/{server_id}/os-server-password
DELETE /v2.1/{project_id}/servers/{server_id}/os-server-password
diff --git a/docs/ecs/api-ref/en-us_topic_0167811964.html b/docs/ecs/api-ref/en-us_topic_0167811964.html index 96bf82140..c5371a78c 100644 --- a/docs/ecs/api-ref/en-us_topic_0167811964.html +++ b/docs/ecs/api-ref/en-us_topic_0167811964.html @@ -2,7 +2,7 @@Deleting Tags from an ECS in a Batch
Function
- This API is used to delete tags from a specified ECS in a batch.
- The Tag Management Service (TMS) uses this API to batch manage the tags of an ECS.
- This API is idempotent. When you delete a tag but the tag does not exist, a successful result is returned.
- This API is idempotent. When you delete a tag but the tag does not exist, a successful result is returned by default.
Constraints
An ECS allows a maximum of 10 tags.
diff --git a/docs/ecs/api-ref/en-us_topic_0167957246.html b/docs/ecs/api-ref/en-us_topic_0167957246.html index a64d06793..c0e9c65af 100644 --- a/docs/ecs/api-ref/en-us_topic_0167957246.html +++ b/docs/ecs/api-ref/en-us_topic_0167957246.html @@ -148,7 +148,7 @@String
Specifies the bandwidth sharing type.
-Enumerated values: PER (indicates exclusive bandwidth) and WHOLE (indicates sharing)
+Enumerated values: PER (indicates exclusive bandwidth) and WHOLE (indicates shared bandwidth)
chargemode
@@ -165,7 +165,7 @@ipv6_bandwidth Field Description
This field is used by the following APIs:- Creating ECSs /v1/{project_id}/cloudservers
ipv6_bandwidth Field Description
This field is used by the following APIs:- Creating ECSs /v1/{project_id}/cloudservers
Table 5 ipv6_bandwidth field description Parameter
extendparam Field Description for Creating Disks
This field is used by the following APIs:
- Creating ECSs /v1/{project_id}/cloudservers
-Table 6 extendparam field description for creating disks Parameter
+Table 6 extendparam field description for creating disks Parameter
Mandatory
String
Specifies the user ID.
+NOTE:The value of this parameter is that of IAM User ID of the current login account. If you log in as an IAM user, obtain the IAM user ID of that IAM user.
+agency_name
@@ -453,7 +455,7 @@Array of strings
Creates ECSs on a dedicated or shared host.
-The value of this parameter can be dedicated or shared.
+The value of this parameter can be dedicated or shared.
dedicated_host_id
@@ -461,7 +463,7 @@Array of strings
Specifies the dedicated host ID.
-NOTE:A DeH ID takes effect only when tenancy is set to dedicated.
+NOTE:A DeH ID takes effect only when tenancy is set to dedicated.
extra_dhcp_opts Field Description
This field is used by the following APIs:-- Creating ECSs: /v1/{project_id}/cloudservers
Table 13 extra_dhcp_opts field description Parameter
+Table 13 extra_dhcp_opts field description Parameter
Mandatory
String
Specifies the image type. The following types are supported:
-- Public image: The value is gold.
- Private image: The value is private.
- Shared image: The value is shared.
- Public image (gold)
- Private image (private)
- Shared image (shared)
metering.resourcespeccode
diff --git a/docs/ecs/api-ref/en-us_topic_0170316409.html b/docs/ecs/api-ref/en-us_topic_0170316409.html index 49d1e2a83..390d5e823 100644 --- a/docs/ecs/api-ref/en-us_topic_0170316409.html +++ b/docs/ecs/api-ref/en-us_topic_0170316409.html @@ -9,7 +9,7 @@Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to query ECSs using an API, the user must have been granted permissions that allow the ecs:servers:list action.
Supported Actions
ECS provides system-defined policies that can be directly used in IAM. You can also create custom policies to supplement system-defined policies for more refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:
-- Permissions: statements in a policy that allow or deny certain operations
- APIs: REST APIs that can be called by a user who has been granted specific permissions
- Actions: specific operations that are allowed or denied
- Dependencies: actions which a specific action depends on. When allowing an action for a user, you also need to allow any existing action dependencies for that user.
- IAM projects/Enterprise projects: the authorization scope of a custom policy. A custom policy can be applied to IAM projects or enterprise projects or both. Policies that contain actions for both IAM and enterprise projects can be used and applied for both IAM and Enterprise Management. Policies that contain actions only for IAM projects can be used and applied to IAM only.
- Permissions: statements in a policy that allow or deny certain operations on specified resources under specific conditions.
- APIs: REST APIs that can be called by a custom policy
- Actions: specific operations that are allowed or denied in a custom policy
- Dependencies: actions which a specific action depends on. When allowing an action for a user, you also need to allow any existing action dependencies for that user.
- IAM projects/Enterprise projects: the authorization scope of a custom policy. A custom policy can be applied to IAM projects or enterprise projects or both. Policies that contain actions for both IAM and enterprise projects can be used and applied for both IAM and Enterprise Management. Policies that contain actions only for IAM projects can be used and applied to IAM only.
√: supported; x: not supported
ECS supports the following actions that can be defined in custom policies:- Lifecycle Management
- ECS Status Management
- Batch Operations
- Network Management
- Image Management
- Security Group Management
- Specifications Query
- NIC Management
- Disk Management
- Metadata Management
- Tenant Quota Management
- SSH Key Management
- Password Management
- ECS Group Management
- ECS Management Through Console
- AZ Management
- Tag Management
String
Specifies the ECS flavor type:
-- normal: general computing
- cpuv1: computing I
- cpuv2: computing II
- computingv3: general computing-plus
- highmem: memory-optimized
- diskintensive: disk-intensive
- highcpu: high-performance computing
- gpu: GPU-accelerated
- fpga: FPGA-accelerated
- normal: general computing
- computingv3: general computing-plus
- highmem: memory-optimized
- cpuv1: computing I
- cpuv2: computing II
- highcpu: high-performance computing
- diskintensive: disk-intensive
- gpu: GPU-accelerated
- fpga: FPGA-accelerated
resource_type
@@ -52,7 +52,7 @@String
The value of this parameter is in format of "{type}:{count}:{size}:{safeFormat}", where,
+The value of this parameter is in format of {type}:{count}:{size}:{safeFormat}.
- type: indicates the disk type, which can only be HDD.
- count: indicates the number of local disks. The following types are supported:
- For D2 ECSs, the value can be 2, 4, 8, 12, 16, or 24.
- For D3 ECSs, the value can be 2, 4, 8, 12, 16, 24, or 28.
- size: indicates the capacity of a single disk, in GB. Currently, only 1675 is supported. The actual disk size is 1800, and the available size after formatting is 1675.
- safeFormat: indicates whether the local disks of the ECS are securely formatted. The following types are supported:
- For D2 or D3 ECSs, the value is True.
String
The value of this parameter is in the format of {type}:{spec}:{num}:{size}:{safeFormat}:.
-- type: indicates the capacity of a single NVME SSD disk attached to the ECS, which can only be 1.6 TB or 3.2 TB.
- spec: indicates the specification of the NVME SSD disk, which can be large or small.
If the value is large, only I3 ECSs are supported.
- - num: indicates the number of partitions on the disk.
- size: indicates the capacity, in the unit of GB, of the disk used by the guest user. If the spec value is large, the value of this parameter is the size of a single disk attached to the ECS. If the spec value is small, the value of this parameter is 1/4 or 1/2 of the specification.
- safeFormat: indicates whether the local disks of the ECS are securely formatted.
If the value is True, only I3 ECSs are supported.
+The value of this parameter is in the format of {type}:{spec}:{num}:{size}:{safeFormat}.
+- type: indicates the capacity of a single NVME SSD disk attached to the ECS, which can only be 1.6 TB or 3.2 TB.
- spec: indicates the specifications of the NVMe SSD disk, which can be large (large specifications) or lvs (small specifications).
If spec is set to large, only I series (for example, I3) is supported.
+ - num indicates the number of local disks.
- size: indicates the capacity, in the unit of GB, of the disk used by the guest user. If the spec value is large, the value of this parameter is the size of a single disk attached to the ECS. If the value of spec is lvs, the value of size is an integer multiple of 50.
- safeFormat: indicates whether the local disks of the ECS are securely formatted.
If safeFormat is set to True, only I series (for example, I3) is supported.
NOTE:@@ -111,7 +111,7 @@This field is dedicated for ultra-high I/O ECSs.
String
This parameter takes effect region-wide. If an AZ is not configured in the cond:operation:az parameter, the value of this parameter is used by default. If this parameter is not set or used, the meaning of normal applies. Options:
-- normal: indicates normal commercial use of the flavor.
- abandon: indicates that the flavor has been canceled (not displayed).
- sellout: indicates that the flavor has been sold out.
- obt: indicates that the flavor is under open beta testing (OBT).
- obt_sellout: indicates that the OBT resources are sold out.
- promotion: indicates the recommended flavor (commercial use, which is similar to normal).
- normal: indicates normal commercial use of the flavor.
- abandon: indicates that the flavor has been taken offline (not displayed).
- sellout: indicates that the flavor has been sold out.
- obt: indicates that the flavor is under open beta testing (OBT).
- obt_sellout: indicates that the OBT resources are sold out.
- promotion: indicates that the flavor is recommended (for commercial use, which is similar to normal).
cond:operation:az
@@ -137,7 +137,7 @@String
Specified the assured bandwidth.
+Specifies the assured bandwidth.
- Unit: Mbit/s. If a bandwidth is in the unit of Gbit/s, it must be divided by 1,000.
Creating an ECS
Function
This API is used to create one or more ECSs.
-This API is an asynchronous API. After the creation request is successfully delivered, a job ID is returned. This does not mean the creation is complete. You need to call the API by referring to Querying Task Execution Status to query the job status. The SUCCESS status indicates that the creation is successful.
+This API is an asynchronous API. After the creation request is successfully delivered, a job ID is returned. This does not mean that the creation is complete. You need to call the API by referring to Querying 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.
@@ -125,7 +125,7 @@String
Specifies the user data to be injected to the ECS during the creation. Text and text files can be injected.
-NOTE:NOTE:For more information about the user data to be injected, see "Injecting User Data into ECSs" in the Elastic Cloud Server User Guide.
Examples
@@ -341,7 +341,7 @@ echo 111 > c:\aaa.txtString
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
@@ -554,7 +554,7 @@ echo 111 > c:\aaa.txtObject
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.
@@ -563,7 +563,6 @@ echo 111 > c:\aaa.txt -Response
-Parameter
diff --git a/docs/ecs/api-ref/en-us_topic_0020212674.html b/docs/ecs/api-ref/en-us_topic_0020212674.html index 0fbc34779..730ac4a70 100644 --- a/docs/ecs/api-ref/en-us_topic_0020212674.html +++ b/docs/ecs/api-ref/en-us_topic_0020212674.html @@ -59,7 +59,7 @@Integer
Specifies the maximum number of ECSs you can use.
+Specifies the maximum number of ECSs that can be requested.
maxTotalCores
diff --git a/docs/ecs/api-ref/en-us_topic_0020212676.html b/docs/ecs/api-ref/en-us_topic_0020212676.html index 5fd3578f5..e01d267dd 100644 --- a/docs/ecs/api-ref/en-us_topic_0020212676.html +++ b/docs/ecs/api-ref/en-us_topic_0020212676.html @@ -67,7 +67,7 @@Table 4 keypair field description Parameter
+-Table 4 keypair field description Parameter
Type
Table 5 keypair field description Parameter
+-Table 5 keypair field description Parameter
Type
String
Specifies the key type. The value is ssh or x509.
+Specifies the key type. The value is ssh or x509.
This parameter is supported in microversion 2.2 and later.
String
Specifies an ECS uniquely.
+Specifies the unique ID of an ECS.
links
diff --git a/docs/ecs/api-ref/en-us_topic_0020212689.html b/docs/ecs/api-ref/en-us_topic_0020212689.html index 6221a3aff..382d882ce 100644 --- a/docs/ecs/api-ref/en-us_topic_0020212689.html +++ b/docs/ecs/api-ref/en-us_topic_0020212689.html @@ -208,7 +208,7 @@String
Specifies an ECS uniquely.
+Specifies the unique ID of an ECS.
status
@@ -467,7 +467,7 @@String
Specifies the UUID of the Ramdisk image if an AMI image is used. In other scenarios, leave this parameter blank.
+Specifies the UUID of the ramdisk image if an AMI image is used. In other scenarios, leave this parameter blank.
This parameter is supported in microversion 2.3 and later.
String
Reserved
+This is a reserved parameter.
accessIPv6
String
Reserved
+This is a reserved parameter.
config_drive
String
Reserved
+This is a reserved parameter.
progress
Integer
Reserved
+This is a reserved parameter.
Table 11 image field description Parameter
+-Table 11 image field description Parameter
Type
String
Specifies an ECS uniquely.
+Specifies the unique ID of an ECS.
status
@@ -340,7 +340,7 @@String
Specifies the UUID of the Ramdisk image if an AMI image is used. In other scenarios, leave this parameter blank.
+Specifies the UUID of the ramdisk image if an AMI image is used. In other scenarios, leave this parameter blank.
This parameter is supported in microversion 2.3 and later.
String
Reserved
+This is a reserved parameter.
accessIPv6
String
Reserved
+This is a reserved parameter.
config_drive
String
Reserved
+This is a reserved parameter.
progress
Integer
Reserved
+This is a reserved parameter.
String
Reserved
+This is a reserved parameter.
addresses
@@ -161,7 +161,7 @@String
Reserved
+This is a reserved parameter.
created
@@ -210,7 +210,7 @@Integer
Reserved
+This is a reserved parameter.
links
diff --git a/docs/ecs/api-ref/en-us_topic_0022067588.html b/docs/ecs/api-ref/en-us_topic_0022067588.html index a21ae46ee..4282752f4 100644 --- a/docs/ecs/api-ref/en-us_topic_0022067588.html +++ b/docs/ecs/api-ref/en-us_topic_0022067588.html @@ -14,8 +14,6 @@The flavor does not exist or has been abandoned.
Change another flavor.
+Switch to another flavor.
400
@@ -266,7 +266,7 @@The image does not exist.
Change another image.
+Replace the image.
400
@@ -277,7 +277,7 @@The image is not in Active state.
Change another image.
+Replace the image.
400
@@ -288,7 +288,7 @@The full-ECS backup does not exist or has been deleted.
Change another image.
+Replace the image.
400
@@ -585,7 +585,7 @@External users are not allowed to create Windows ECSs.
External users, including non-internal users and non-third-party users, are not allowed to purchase Windows images.
+External users, including and non-third-party users, are not allowed to purchase Windows images.
400
@@ -1367,7 +1367,7 @@The target specifications are the same as the current ECS specifications.
Change another specifications.
+Switch to another flavor.
400
diff --git a/docs/ecs/api-ref/en-us_topic_0022067718.html b/docs/ecs/api-ref/en-us_topic_0022067718.html deleted file mode 100644 index 4cbcd1bea..000000000 --- a/docs/ecs/api-ref/en-us_topic_0022067718.html +++ /dev/null @@ -1,11 +0,0 @@ - - -Network APIs
--For details about network APIs, see the Virtual Private Cloud API Reference.
--- diff --git a/docs/ecs/api-ref/en-us_topic_0022067719.html b/docs/ecs/api-ref/en-us_topic_0022067719.html index a83e0def1..8731c5258 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 @@--Parent topic: Appendix-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.
-The system periodically checks the NIC status and returns check results using value 0 or 1.
+0 or 1
Table 4 sub_jobs field description Parameter
+-Table 4 sub_jobs field description Parameter
Type
String
Specifies the task status.
-entities
@@ -237,7 +237,7 @@Table 5 sub_jobs.entities field description Parameter
+Table 5 sub_jobs.entities field description Parameter
Type
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
diff --git a/docs/ecs/api-ref/en-us_topic_0022472987.html b/docs/ecs/api-ref/en-us_topic_0022472987.html index 597784da2..23954d7cb 100644 --- a/docs/ecs/api-ref/en-us_topic_0022472987.html +++ b/docs/ecs/api-ref/en-us_topic_0022472987.html @@ -125,7 +125,7 @@String
If volumeId is unavailable and dry_run is set to true, hw:passthrough is available and must be specified.
+If volumeId is unavailable and dry_run is set to true, volume_type is available and must be specified.
2018-05-31
Modified the following content:
-2018-05-21
Modified the following content:
-2018-03-30
@@ -441,7 +441,7 @@2016-06-02
Added the following content:
-Modified the following content:
Deleted the following content:
diff --git a/docs/ecs/api-ref/en-us_topic_0031167350.html b/docs/ecs/api-ref/en-us_topic_0031167350.html index e2b453544..993634f3b 100644 --- a/docs/ecs/api-ref/en-us_topic_0031167350.html +++ b/docs/ecs/api-ref/en-us_topic_0031167350.html @@ -1,6 +1,6 @@ -Attaching a ECS Data Disk
+Attaching an ECS Data Disk
Function
This API is used to attach a disk to an ECS.
Constraints
Querying the Networks of a Specified ECS
-Function
This API is used to query the networks of an ECS.
+Function
This API is used to query the networks of a specified ECS.
diff --git a/docs/ecs/api-ref/en-us_topic_0065817694.html b/docs/ecs/api-ref/en-us_topic_0065817694.html index d63f88fc5..c278d764a 100644 --- a/docs/ecs/api-ref/en-us_topic_0065817694.html +++ b/docs/ecs/api-ref/en-us_topic_0065817694.html @@ -5,9 +5,9 @@Constraints
None
Images created using an ECS are stored on storage nodes as snapshots.
- This API is a native OpenStack API that is not applicable to the images on the cloud platform.
--Constraints
Constraints
URI
POST /v2.1/{project_id}/servers/{server_id}/action
POST /v2/{project_id}/servers/{server_id}/action
diff --git a/docs/ecs/api-ref/en-us_topic_0065817695.html b/docs/ecs/api-ref/en-us_topic_0065817695.html index e298b4963..e8323b1cc 100644 --- a/docs/ecs/api-ref/en-us_topic_0065817695.html +++ b/docs/ecs/api-ref/en-us_topic_0065817695.html @@ -156,7 +156,7 @@Table 5 images information Parameter
+-Table 5 images parameters Parameter
Mandatory
Table 7 links parameter description Parameter
+-Table 7 links parameters Parameter
Mandatory
Table 5 links parameter description Parameter
+-Table 5 links parameters Parameter
Mandatory
Table 3 links parameter description Parameter
+-Table 3 links parameters Parameter
Mandatory
Table 7 ip_range objects Parameter
+-Table 7 ip_range objects Parameter
Mandatory
Table 4 security_group_rule objects Parameter
+-Table 4 security_group_rule objects Parameter
Mandatory
Integer
Specifies the stop port number. The value ranges from 1 to 65,535 and cannot be less than from_port.
+Specifies the stop port number. The value ranges from 1 to 65,535 and cannot be less than from_port.
When ip_protocol is icmp, it specifies the code. The value ranges from 0 to 255. If both from_port and to_port are -1, any ICMP packet can be transmitted.
Object
Specifies the name of the peer security group and the ID of the tenant in the peer security group. For details, see Table 6.
-The value of ip_range or group must be empty.
+The value of ip_range or group must be empty.
id
@@ -201,7 +201,7 @@Table 5 ip_range objects Parameter
+Table 5 ip_range objects Parameter
Mandatory
Integer
Specifies the end port number. The value ranges from 1 to 65,535.
-ip_range
diff --git a/docs/ecs/api-ref/en-us_topic_0065817707.html b/docs/ecs/api-ref/en-us_topic_0065817707.html index bbf7f94c5..496ede31c 100644 --- a/docs/ecs/api-ref/en-us_topic_0065817707.html +++ b/docs/ecs/api-ref/en-us_topic_0065817707.html @@ -3,8 +3,8 @@Detaching a Disk from an ECS
-Function
This API is used to detach a disk from an ECS.
Constraints
The system disk, the device name of which is /dev/sda, and user disks can be detached from an ECS only when the ECS is stopped. There are no requirements on OTC Tools.
-When an ECS is in the active state, pay attention to the following constraints:
+Constraints
The system disk, the device name of which is /dev/sda, and user disks can be detached from an ECS only when the ECS is stopped. There are no requirements on the OSs and OTC Tools.
+When an ECS is in the active status, pay attention to the following constraints:
- Add a NIC whose network ID is 3cb9bc59-5699-4588-a4b1-b87f96708bc6 to a specified ECS.