For more information, see "ECS Specifications and Types" in the Elastic Cloud Server User Guide.
+ For more information, see "ECS Specifications and Types" in Elastic Cloud Server User Guide.
Example Request
Query details about ECS flavors and extended flavor information.
GET https://{endpoint}/v1/{project_id}/cloudservers/flavors?availability_zone=availability_value
diff --git a/docs/ecs/api-ref/en-us_topic_0020212658.html b/docs/ecs/api-ref/en-us_topic_0020212658.html
index 038044254..6382bfe16 100644
--- a/docs/ecs/api-ref/en-us_topic_0020212658.html
+++ b/docs/ecs/api-ref/en-us_topic_0020212658.html
@@ -163,7 +163,7 @@
String
Specifies the swap partition size required by the ECS flavor.
-This parameter has not been used. Its default value is "".
+This parameter has not been used. Its default value is "".
OS-FLV-EXT-DATA:ephemeral
@@ -171,7 +171,7 @@Integer
Specifies the temporary disk size. This is an extended attribute.
-This parameter has not been used. Its default value is 0.
+This parameter has not been used. Its default value is 0.
OS-FLV-DISABLED:disabled
@@ -179,7 +179,7 @@Boolean
Specifies whether the ECS flavor has been disabled. This is an extended attribute.
-This parameter has not been used. Its default value is false.
+This parameter has not been used. Its default value is false.
rxtx_factor
@@ -187,7 +187,7 @@Float
Specifies the ratio of the available network bandwidth to the network hardware bandwidth of the ECS.
-This parameter has not been used. Its default value is 1.0.
+This parameter has not been used. Its default value is 1.0.
os-flavor-access:is_public
@@ -195,7 +195,7 @@Boolean
Specifies whether a flavor is available to all tenants. This is an extended attribute.
-- true: indicates that a flavor is available to all tenants.
- false: indicates that a flavor is available only to certain tenants.
- true: indicates that a flavor is available to all tenants.
- false: indicates that a flavor is available only to certain tenants.
Default value: true
String
Specifies the swap partition size required by the ECS flavor.
-This parameter has not been used. Its default value is "".
+This parameter has not been used. Its default value is "".
OS-FLV-EXT-DATA:ephemeral
@@ -120,7 +120,7 @@Integer
Specifies the temporary disk size. This is an extended attribute.
-This parameter has not been used. Its default value is 0.
+This parameter has not been used. Its default value is 0.
OS-FLV-DISABLED:disabled
@@ -128,7 +128,7 @@Boolean
Specifies whether the ECS flavor has been disabled. This is an extended attribute.
-This parameter has not been used. Its default value is false.
+This parameter has not been used. Its default value is false.
rxtx_factor
@@ -136,7 +136,7 @@Float
Specifies the ratio of the available network bandwidth to the network hardware bandwidth of the ECS.
-This parameter has not been used. Its default value is 1.0.
+This parameter has not been used. Its default value is 1.0.
os-flavor-access:is_public
@@ -144,7 +144,7 @@Boolean
Specifies whether a flavor is available to all tenants. This is an extended attribute.
-- true: indicates that a flavor is available to all tenants.
- false: indicates that a flavor is available only to certain tenants.
- true: indicates that a flavor is available to all tenants.
- false: indicates that a flavor is available only to certain tenants.
Default value: true
Querying Details About a Specified NIC of an ECS
-Function
This API is used to query details about an NIC based on the NIC ID.
+Function
This API is used to query details about a NIC based on the NIC 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}
@@ -136,7 +136,7 @@Example Request
Query details about an NIC based on the specified NIC ID.
+Example Request
Query details about a 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}
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.@@ -102,7 +102,7 @@ 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.
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
@@ -112,7 +112,7 @@String
Specifies the ECS name.
-Value requirements:
+Value range:
- The parameter value consists of 1 to 128 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
- If more than one ECS is to be created (the count value is greater than 1), the system automatically adds a hyphen followed by a four-digit incremental number, such as -0000, to the end of each ECS name. If you specify a number, the name of the first new ECS will start from the specified number. In this case, the ECS name contains a maximum of 59 characters.
String
Specifies the user data to be injected to the ECS during the creation. Text and text files can be injected.
-NOTE:- The content of user_data must be encoded with base64.
- The maximum size of the content to be injected (before encoding) is 32 KB.
- If the user_data field is specified for a Linux ECS that is created using an image with Cloud-Init installed, the adminPass field becomes invalid.
NOTE:- The content of user_data must be encoded with base64.
- The maximum size of the content to be injected (before encoding) is 32 KB.
- If the user_data field is specified for a Linux ECS that is created using an image with Cloud-Init installed, the adminPass field becomes invalid.
For more information about the user data to be injected, see "Injecting User Data into ECSs" in the Elastic Cloud Server User Guide.
Examples
@@ -148,7 +148,7 @@ echo 111 > c:\aaa.txtString
Specifies the initial login password of the administrator account for logging in to an ECS using password authentication. The Linux administrator is root, and the Windows administrator is Administrator. For details, see Function.
-Password complexity requirements:- Consists of 8 to 26 characters.
- The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (!@$%^-_=+[{}]:,./?~#*).
- The password cannot contain the username or the username in reverse.
- The Windows ECS password cannot contain the username, the username in reverse, or more than two consecutive characters in the username.
Password complexity requirements:- The password must contain 8 to 26 characters.
- The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (!@$%^-_=+[{}]:,./?~#*).
- The password cannot contain the username or the username in reverse.
- The Windows ECS password cannot contain the username, the username in reverse, or more than two consecutive characters in the username.
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
@@ -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.
@@ -595,7 +595,7 @@ echo 111 > c:\aaa.txtFor details about abnormal responses, see Responses (Task).
-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 +-Example Request
- Create a pay-per-use ECS with 2 vCPUs, 16 GiB of memory, private image imageid_123, SSD disks attached, and 10 Mbit/s of bandwidth-billed EIP bound. Use the key pair for login authentication.
POST https://{endpoint}/v1/{project_id}/cloudservers { "server": { diff --git a/docs/ecs/api-ref/en-us_topic_0020212676.html b/docs/ecs/api-ref/en-us_topic_0020212676.html index e01d267dd..9df748b3d 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.
The value can be true or false.
- true: When an ECS is deleted, the EIP bound to the ECS is also released regardless of whether delete_on_termination of the EIP is true or false.
- false: When an ECS is deleted, the EIP is only unbound from the ECS and will not be released regardless of whether delete_on_termination of the EIP is true or false.
NOTE:diff --git a/docs/ecs/api-ref/en-us_topic_0020212688.html b/docs/ecs/api-ref/en-us_topic_0020212688.html index 6682a15ab..0e466ac71 100644 --- a/docs/ecs/api-ref/en-us_topic_0020212688.html +++ b/docs/ecs/api-ref/en-us_topic_0020212688.html @@ -81,7 +81,7 @@If delete_publicip is not specified, the delete_on_termination value of the EIP decides whether the EIP is released when the ECS is deleted.
-- If delete_on_termination is true and delete_public is null, the EIP is released when the ECS is deleted.
- If delete_on_termination is false and delete_public is null, the EIP is only unbound from the ECS and will not be released when the ECS is deleted.
- If delete_on_termination is true and delete_public is null, the EIP is released when the ECS is deleted.
- If delete_on_termination is false and delete_public is null, the EIP is only unbound from the ECS and will not be released when the ECS is deleted.
String
Specifies the ECS status.
-Options:
+Value range:
ACTIVE, BUILD, ERROR, HARD_REBOOT, MIGRATING, REBOOT, REBUILD, RESIZE, REVERT_RESIZE, SHUTOFF, and VERIFY_RESIZE
In microversion 2.37, the system will return an empty list for the status field out of the preceding options. In microversion 2.38 and later, the system will return error 400.
For details, see ECS Statuses.
diff --git a/docs/ecs/api-ref/en-us_topic_0020212689.html b/docs/ecs/api-ref/en-us_topic_0020212689.html index 382d882ce..15289b33e 100644 --- a/docs/ecs/api-ref/en-us_topic_0020212689.html +++ b/docs/ecs/api-ref/en-us_topic_0020212689.html @@ -81,7 +81,7 @@String
Specifies the ECS status.
-Options:
+Value range:
ACTIVE, BUILD, ERROR, HARD_REBOOT, MIGRATING, REBOOT, REBUILD, RESIZE, REVERT_RESIZE, SHUTOFF, and VERIFY_RESIZE
In microversion 2.37, the system will return an empty list for the status field out of the preceding options. In microversion 2.38 and later, the system will return error 400.
For details, see ECS Statuses.
@@ -216,7 +216,7 @@String
Specifies the ECS status.
-Options:
+Value range:
ACTIVE, BUILD, DELETED, ERROR, HARD_REBOOT, MIGRATING, PAUSED, REBOOT, REBUILD, RESIZE, REVERT_RESIZE, SHUTOFF, SHELVED, SHELVED_OFFLOADED, SOFT_DELETED, SUSPENDED, and VERIFY_RESIZE
For details, see ECS Statuses.
String
Specifies the disk configuration mode. This is an extended attribute. This field is valid for the ECS started using an image.
-Options:
+Value range:
- AUTO: This API uses a single partition to build an ECS with the target disk size. The API automatically adjusts the file system to adapt to the entire partition.
- MANUAL: This API uses the partitioning scheme in the source image and the file system to build the ECS. If the target disk size is large, the API does not partition the remaining disk space.
String
Specifies the ECS status. This is an extended attribute.
-Options:
+Value range:
ACTIVE, BUILDING, STOPPED, RESIZED, PAUSED, SUSPENDED, RESCUED, ERROR, DELETED, SOFT_DELETED, SHELVED, and SHELVED_OFFLOADED
For details, see ECS Statuses.
Table 11 image field description Parameter
+Table 11 image field description Parameter
Type
String
Specifies the ECS status.
-Options:
+Value range:
ACTIVE, BUILD, DELETED, ERROR, HARD_REBOOT, MIGRATING, PAUSED, REBOOT, REBUILD, RESIZE, REVERT_RESIZE, SHUTOFF, SHELVED, SHELVED_OFFLOADED, SOFT_DELETED, SUSPENDED, and VERIFY_RESIZE
For details, see ECS Statuses.
String
Specifies the disk configuration mode. This is an extended attribute. This field is valid for the ECS started using an image.
-Options:
+Value range:
- AUTO: This API uses a single partition to build an ECS with the target disk size. The API automatically adjusts the file system to adapt to the entire partition.
- MANUAL: This API uses the partitioning scheme in the source image and the file system to build the ECS. If the target disk size is large, the API does not partition the remaining disk space.
String
Specifies the ECS status. This is an extended attribute.
-Options:
+Value range:
ACTIVE, BUILDING, STOPPED, RESIZED, PAUSED, SUSPENDED, RESCUED, ERROR, DELETED, SOFT_DELETED, SHELVED, and SHELVED_OFFLOADED
For details, see ECS Statuses.
String
Specifies the ID of the user to which an ECS belongs.
+Specifies the ID of the user which an ECS belongs to.
name
String
Specifies the modified name of the ECS.
+Specifies the new name of the ECS.
progress
@@ -268,7 +268,7 @@String
Specifies the ECS status.
-Options:
+Value range:
ACTIVE, BUILD, ERROR, HARD_REBOOT, MIGRATING, REBOOT, RESIZE, REVERT_RESIZE, SHELVED, SHELVED_OFFLOADED, SHUTOFF, UNKNOWN, and VERIFY_RESIZE
For details, see ECS Statuses.
String
Specifies the returned task ID after delivering the task. Users can query the task progress using this ID. For how to query the execution status of the task based on the task ID, see Task Status Management.
+Specifies the returned task ID after delivering the task. Users can query the task progress using this ID. For details about how to query the task execution status based on job_id, see Task Status Management.
Specifies error details.
Error details provide the error code and fault description, facilitating error handling.
-This field is optional.
String
Describes the error message when an error occurs.
-This field is optional.
code
@@ -97,7 +95,6 @@String
Specifies the error code when an error occurs.
-This field is optional.
Error Codes
-Context
- An error code returned by an API does not correspond to one error message. The following table lists only common error messages.
- Most ECS APIs are asynchronous. Some error codes are displayed in the returned messages for task viewing requests. HTTP status codes may not be accurate.
- The ECS service is strongly dependent on other services, such as network and storage. If the reported error messages contain information about ECS-depended services, contact technical support for troubleshooting.
- If the system displays an error code when you perform operations on the management console, see "How Do I Handle Error Messages Displayed on the Management Console?" in the Elastic Cloud Server User Guide for troubleshooting.
Context
- An error code returned by an API does not correspond to one error message. The following table lists only common error messages.
- Most ECS APIs are asynchronous. Some error codes are displayed in the returned messages for task viewing requests. HTTP status codes may not be accurate.
- The ECS service is strongly dependent on other services, such as network and storage. If the reported error messages contain information about ECS-depended services, contact technical support for troubleshooting.
- If the system displays an error code when you perform operations on the management console, see "How Do I Handle Error Messages Displayed on the Management Console?" in Elastic Cloud Server User Guide for troubleshooting.
Error Codes
HTTP Status Code
@@ -187,7 +187,7 @@The status of the selected disk does not meet the attachment requirements on the ECS. Select an available disk for attaching.
The ECS is not the target one that the system disk or data disk is to be attached.
+The ECS is not the target one that the system disk or data disk is to be attached.
Check whether the __system__server_id value in disk metadata is the same as the UUID of the ECS to which the system disk or data disk is to be attached.
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
Querying Task Execution Status
-Function
This API is used to query the execution status of an asynchronous request task.
-After an asynchronous request task is issued, for example, creating or deleting an ECS, performing operations on ECSs in a batch, or performing operations on ECS NICs, a task ID will be returned, based on which you can query the execution status of the task.
+After an asynchronous request task is issued, for example, creating or deleting an ECS, performing operations on ECSs in a batch, or performing operations on ECS NICs, a task ID (job_id) will be returned, based on which you can query the execution status of the task.
For details about how to obtain the task ID, see Responses (Task).
+For details about how to obtain job_id, see Responses (Task).
URI
GET /v1/{project_id}/jobs/{job_id}
Table 1 describes the parameters in the URI.-Table 1 Parameter description Parameter
@@ -49,8 +49,8 @@String
Specifies the task status.
-- SUCCESS: indicates the task is successfully executed.
- RUNNING: indicates that the task is in progress.
- FAIL: indicates that the task failed.
- INIT: indicates that the task is being initialized.
Specifies the job status.
+- SUCCESS: The job is successfully executed.
- RUNNING: The job is in progress.
- FAIL: The job failed.
- INIT: The job is being initialized.
entities
@@ -94,16 +94,16 @@String
Specifies the returned error code when the task execution fails.
-After the task is executed successfully, the value of this parameter is null.
+Specifies the returned error code when the job execution fails.
+After the job is executed successfully, the value of this parameter is null.
fail_reason
String
Specifies the cause of the task execution failure.
-After the task is executed successfully, the value of this parameter is null.
+Specifies the cause of the job execution failure.
+After the task job executed successfully, the value of this parameter is null.
message
@@ -166,7 +166,7 @@Table 4 sub_jobs field description Parameter
+-Table 4 sub_jobs field description Parameter
Type
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
@@ -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_0024734483.html b/docs/ecs/api-ref/en-us_topic_0024734483.html index e3c81b8a4..02d8e0787 100644 --- a/docs/ecs/api-ref/en-us_topic_0024734483.html +++ b/docs/ecs/api-ref/en-us_topic_0024734483.html @@ -8,7 +8,13 @@2024-09-04
+2025-03-14
+Modified the following content:
+Updated actions in Metadata Management and Tag Management.
+2024-09-04
Modified the following content:
Deleted expired actions in Security Group Management.
@@ -288,13 +294,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:
-- Added FPGA Logical File Management.
- Fixed 110 UAT issues in Elastic Cloud Server API Reference 26.
- Added FPGA Logical File Management.
- Fixed 110 UAT issues in Elastic Cloud Server API Reference 26.
2018-03-30
diff --git a/docs/ecs/api-ref/en-us_topic_0065792794.html b/docs/ecs/api-ref/en-us_topic_0065792794.html index d9924c19d..036d162d8 100644 --- a/docs/ecs/api-ref/en-us_topic_0065792794.html +++ b/docs/ecs/api-ref/en-us_topic_0065792794.html @@ -1,7 +1,7 @@Querying a Specified API Version
-Function Description
This API is used to query the information of a specified version.
+Function
This API is used to query the information of a specified version.
To support function extension, Nova APIs can be distinguished by version. There are two types of versions:
- Major version: Independent URL
- Microversion: Used by the HTTP request header X-OpenStack-Nova-API-Version. Since version 2.27, the new microversion header OpenStack-API-Version has been supported.
If the OpenStack-API-Version request header is used, the version is in the format of "compute microversion".
For example, if key is set to OpenStack-API-Version, set value to compute 2.27.
diff --git a/docs/ecs/api-ref/en-us_topic_0065817690.html b/docs/ecs/api-ref/en-us_topic_0065817690.html index f9530cda3..82fe84464 100644 --- a/docs/ecs/api-ref/en-us_topic_0065817690.html +++ b/docs/ecs/api-ref/en-us_topic_0065817690.html @@ -2,7 +2,7 @@Locking an ECS
Function
This API is used to lock an ECS.
-You are only allowed to lock your own ECSs. After ECSs are locked, you will not be able to perform management operations on them, including life cycle management, status management, NIC management, disk management, and password management.
+You are only allowed to lock your own ECSs. After ECSs are locked, you will not be able to perform management operations on them, including life cycle management, status management, NIC management, disk management, and password management.
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_0065817692.html b/docs/ecs/api-ref/en-us_topic_0065817692.html index 1064379b8..4bc275741 100644 --- a/docs/ecs/api-ref/en-us_topic_0065817692.html +++ b/docs/ecs/api-ref/en-us_topic_0065817692.html @@ -56,7 +56,7 @@
No
Specifies the marker that points to the operation. The query starts from the next piece of data indexed by this parameter. The value is request_id.
+Specifies the marker that points to the server action. The query starts from the next piece of data indexed by this parameter. The value is request_id.
This parameter is supported in microversion 2.58 and later.
String
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
+Value range:
+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, trigger_crash_dump, extend_volume
instance_uuid
diff --git a/docs/ecs/api-ref/en-us_topic_0065817694.html b/docs/ecs/api-ref/en-us_topic_0065817694.html index c278d764a..ea2bb9aba 100644 --- a/docs/ecs/api-ref/en-us_topic_0065817694.html +++ b/docs/ecs/api-ref/en-us_topic_0065817694.html @@ -5,9 +5,9 @@Images created using an ECS are stored on storage nodes as snapshots.
- This API is a native OpenStack API that is not applicable to the images on the cloud platform.
-- To create a system disk image or data disk image, use the IMS API (POST /v2/cloudimages/action). For details, see "Creating an Image" in Image Management Service API Reference.
- To create a full-ECS image, use the IMS API (POST /v1/cloudimages/wholeimages/action). For details, see "Creating a Full-ECS Image" in Image Management Service API Reference.
- To create a system disk image or data disk image, use the IMS API (POST /v2/cloudimages/action). For details, see "Creating an Image" in Image Management Service API Reference.
- To create a full-ECS image, use the IMS API (POST /v1/cloudimages/wholeimages/action). For details, see "Creating a Full-ECS Image" in Image Management Service API Reference.
-Constraints
- An ECS in the error state cannot be used to create an image.
- If an image created using an ECS is used to create a new ECS, the new ECS must be located in the same AZ as the original ECS.
- After an ECS is deleted, the images and snapshots created using this ECS will not be automatically deleted. You must manually delete them.
- After an image created using an ECS is deleted, the associated snapshots will not be automatically deleted (this function is implemented by native OpenStack). You must manually delete such snapshots.
- The image created using an ECS cannot be used to create data disks.
- The images created using the API described in this section (URI: POST /v2/{project_id}/servers/{server_id}/action or POST /v2.1/{project_id}/servers/{server_id}/action) cannot be exported to OBS buckets. If such images must be exported, use the IMS API (POST /v2/cloudimages/action). For details, see "Creating an Image" in Image Management Service API Reference.
Constraints
- An ECS in the error state cannot be used to create an image.
- If an image created using an ECS is used to create a new ECS, the new ECS must be located in the same AZ as the original ECS.
- After an ECS is deleted, the images and snapshots created using this ECS will not be automatically deleted. You must manually delete them.
- After an image created using an ECS is deleted, the associated snapshots will not be automatically deleted (this function is implemented by native OpenStack). You must manually delete such snapshots.
- The image created using an ECS cannot be used to create data disks.
- The images created using the API described in this section (URI: POST /v2/{project_id}/servers/{server_id}/action or POST /v2.1/{project_id}/servers/{server_id}/action) cannot be exported to OBS buckets. If such images must be exported, use the IMS API (POST /v2/cloudimages/action). For details, see "Creating an Image" in Image Management Service API Reference.
URI
POST /v2.1/{project_id}/servers/{server_id}/action
POST /v2/{project_id}/servers/{server_id}/action
diff --git a/docs/ecs/api-ref/en-us_topic_0065817696.html b/docs/ecs/api-ref/en-us_topic_0065817696.html index 8f5729d86..80e2ab240 100644 --- a/docs/ecs/api-ref/en-us_topic_0065817696.html +++ b/docs/ecs/api-ref/en-us_topic_0065817696.html @@ -27,7 +27,7 @@Parameters in the following table can be used as URI parameters to filter query results. Usage: /v2/{tenant_id}/images/detail? name ={name}&status={status}
+Parameters in the following table can be used as URI parameters to filter query results. Usage: /v2/{project_id}/images/detail? name ={name}&status={status}
Table 2 describes the query parameters.
-Table 2 Query parameters Parameter
diff --git a/docs/ecs/api-ref/en-us_topic_0065817700.html b/docs/ecs/api-ref/en-us_topic_0065817700.html index 47af2f760..4a50e8aef 100644 --- a/docs/ecs/api-ref/en-us_topic_0065817700.html +++ b/docs/ecs/api-ref/en-us_topic_0065817700.html @@ -257,7 +257,7 @@Table 7 ip_range objects Parameter
+-Table 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.
-- 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_0065817707.html b/docs/ecs/api-ref/en-us_topic_0065817707.html index 496ede31c..b7a46b287 100644 --- a/docs/ecs/api-ref/en-us_topic_0065817707.html +++ b/docs/ecs/api-ref/en-us_topic_0065817707.html @@ -5,7 +5,7 @@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:
-- 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.
+
- 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
Version
diff --git a/docs/ecs/api-ref/en-us_topic_0065817720.html b/docs/ecs/api-ref/en-us_topic_0065817720.html index 02c78c45a..df70fad52 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 AZs
-Function
This API is used to query AZs.
+Function
This API is used to list AZs.
URI
GET /v2.1/{project_id}/os-availability-zone
GET /v2/{project_id}/os-availability-zone
diff --git a/docs/ecs/api-ref/en-us_topic_0065962600.html b/docs/ecs/api-ref/en-us_topic_0065962600.html index 91108e071..5497ff165 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 ecc3250dc..eb671d978 100644 --- a/docs/ecs/api-ref/en-us_topic_0067876349.html +++ b/docs/ecs/api-ref/en-us_topic_0067876349.html @@ -76,7 +76,7 @@String
Specifies the key pair name.
+Specifies the key name.
userid
@@ -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 through HTTPS requests, 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.
String
Specifies the key pair name.
+Specifies the key name.
userid
@@ -173,7 +173,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.
- 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.
- provider:network_type being set to geneve indicates the internal high-speed network for BMSs.
- If your ECS is remotely logged in using a key, use the key_name parameter. If your ECS is remotely logged in using a password, use the adminPass parameter. Linux ECSs support user_data for injection. Windows ECSs support admin_pass for injection.
- If the image based on which the ECS is created uses the native OpenStack API, ensure that the specified AZ and system disk capacity and type used when the ECS is created are the same as those used when the image is created. Otherwise, the ECS creation will fail.
+- If your ECS is remotely logged in using a key, use the key_name parameter. If your ECS is remotely logged in using a password, use the adminPass parameter. Linux ECSs support user_data for injection. Windows ECSs support admin_pass for injection.
- If the image based on which the ECS is created uses the native OpenStack API, ensure that the specified AZ and system disk capacity and type used when the ECS is created are the same as those used when the image is created. Otherwise, the ECS creation will fail.
Request
Table 2 describes the request parameters.
@@ -114,7 +114,7 @@String
Specifies the ECS name.
-The value options are as follows:
+Value range:
- The parameter value consists of 1 to 128 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
- If more than one ECS is to be created (the count value is greater than 1), the system automatically adds a hyphen followed by a four-digit incremental number, such as -0000, to the end of each ECS name. If you specify a number, the name of the first new ECS will start from the specified number. In this case, the ECS name contains a maximum of 59 characters.
String
Specifies the fixed IP address. Parameter port in the three network parameters (port, uuid, and fixed_ip) has the highest priority. If parameter fixed_ip is set, you must specify the UUID.
+Specifies the fixed IP address. Parameter port in the three network parameters (port, uuid, and fixed_ip) has the highest priority. If parameter fixed_ip is set, you must specify the UUID.
No
Specifies the maximum records displayed on a page in a pagination query.
-- Must be a decimal integer.
- Ranges from 1 (inclusive) to 100 (inclusive).
- Cannot contain +.
- Must be a decimal integer.
- Ranges from 1 (inclusive) to 100 (inclusive).
- Cannot contain +.
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
String
Specifies the ECS status.
-Options:
+Value range:
ACTIVE, BUILD, ERROR, HARD_REBOOT, MIGRATING, REBOOT, REBUILD, RESIZE, REVERT_RESIZE, SHUTOFF, VERIFY_RESIZE, DELETED, SHELVED, SHELVED_OFFLOADED, and UNKNOWN
For details, see ECS Statuses.
Map<String, Array of objects>
Specifies the network attribute of the ECS.
-- The key indicates the network name, for example, demo_net.
- The value indicates the network attribute specified in Table 1.
- The key indicates the network name, for example, demo_net.
- The value indicates the network attribute specified in Table 4.
key_name
@@ -115,7 +115,7 @@Object
Specifies the ECS image. For details, see Table 7.
+Specifies the ECS image. For details, see Table 6.
OS-EXT-STS:task_state
@@ -151,7 +151,7 @@Object
Specifies the ECS flavor.
-For details, see Table 2.
+For details, see Table 1.
id
@@ -166,7 +166,7 @@Array of objects
Specifies the security groups of the ECS.
-For details, see Table 3.
+For details, see Table 2.
OS-EXT-AZ:availability_zone
@@ -249,7 +249,7 @@Integer
Specifies the power status of the ECS. This is an extended attribute.
-Options:
+Value range:
- 0: NOSTATE
- 1: RUNNING
- 4: SHUTDOWN
Map<String,String>
Specifies the ECS metadata. For details, see Table 5.
+Specifies the ECS metadata. For details, see Table 4.
NOTE:Metadata includes system default fields and the fields set by users.
Array of objects
Specifies the disks attached to an ECS.
-For details, see Table 4.
+For details, see Table 3.
description
@@ -383,7 +383,56 @@Array of objects
Specifies ECS system tags.
-For details, see Table 6.
+For details, see Table 5.
+-Table 4 addresses field description Parameter
+Type
+Description
+version
+String
+Specifies the IP address version.
+- 4: indicates IPv4.
- 6: indicates IPv6.
addr
+String
+Specifies the IP address.
+OS-EXT-IPS:type
+String
+Specifies the IP address type.
+- fixed: indicates the private IP address.
- floating: indicates the floating IP address.
OS-EXT-IPS-MAC:mac_addr
+String
+Specifies the MAC address.
+OS-EXT-IPS:port_id
+String
+Specifies the port ID corresponding to the IP address.
-Example Request
Query details about the ECS whose ID is 4f4b3dfa-eb70-47cf-a60a-998a53bd598a.
GET https://{endpoint}/v1/{project_id}/cloudservers/{server_id}Example Response
{ - "server":{ - "id":"4f4b3dfa-eb70-47cf-a60a-998a53bd598a", - "name":"ecs-2ecf", - "addresses":{ - "0431c5e5-bc94-4a44-8263-15da2a642435":[ +diff --git a/docs/ecs/api-ref/en-us_topic_0094148850.html b/docs/ecs/api-ref/en-us_topic_0094148850.html index bdf88932f..f38b142ee 100644 --- a/docs/ecs/api-ref/en-us_topic_0094148850.html +++ b/docs/ecs/api-ref/en-us_topic_0094148850.html @@ -1,8 +1,8 @@ -Example Response
{ + "server": { + "fault": null, + "id": "4f4b3dfa-eb70-47cf-a60a-998a53bd598a", + "name": "ecs-2ecf", + "addresses": { + "0431c5e5-bc94-4a44-8263-15da2a642435": [ { - "version":"4", - "addr":"192.168.1.99", - "OS-EXT-IPS-MAC:mac_addr":"fa:16:3e:df:18:6d", - "OS-EXT-IPS:port_id":"23037c18-027a-44e5-b6b9-f8d8f113fe02", - "OS-EXT-IPS:type":"fixed" + "version": "4", + "addr": "192.168.1.99", + "primary": true, + "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:df:18:6d", + "OS-EXT-IPS:type": "fixed", + "OS-EXT-IPS:port_id": "23037c18-027a-44e5-b6b9-f8d8f113fe02" } ] }, - "flavor":{ - "disk":"0", - "vcpus":"2", - "ram":"1024", - "id":"s3.large.1", - "name":"s3.large.1" + "flavor": { + "disk": "0", + "vcpus": "2", + "ram": "1024", + "id": "s3.large.1", + "name": "s3.large.1" + "asic_accelerators": [ + + ] }, - "accessIPv4":"", - "accessIPv6":"", - "status":"ACTIVE", - "progress":0, - "hostId":"c7145889b2e3202cd295ceddb1742ff8941b827b586861fd0acedf64", - "updated":"2018-09-13T07:06:51Z", - "created":"2018-09-13T07:03:44Z", - "image":{ - "id":"1ce5800a-e487-4c1b-b264-3353a39e2b4b" + "accessIPv4": "", + "accessIPv6": "", + "status": "ACTIVE", + "progress": 0, + "hostId": "c7145889b2e3202cd295ceddb1742ff8941b827b586861fd0acedf64", + "updated": "2018-09-13T07:06:51Z", + "created": "2018-09-13T07:03:44Z", + "metadata": { + "metering.order_id": "CS1809131459IGC24", + "image_name": "Public_Cloudinit_Oracle_Linux_7.4_64bit_40G", + "metering.resourcespeccode": "s3.large.1", + "charging_mode": "1", + "vpc_id": "0431c5e5-bc94-4a44-8263-15da2a642435", + "os_type": "Linux", + "metering.resourcetype": "1", + "metering.image_id": "c71b64e7-4767-4406-afde-2c7c7ac2242c", + "os_bit": "64", + "__support_agent_list": "hss,ces", + "cascaded.instance_extrainfo": "pcibridge:2", + "metering.imagetype": "gold" }, - "metadata":{ - "metering.order_id":"CS1809131459IGC24", - "metering.image_id":"c71b64e7-4767-4406-afde-2c7c7ac2242c", - "metering.imagetype":"gold", - "metering.resourcespeccode":"s3.small.1.linux", - "image_name":"HEC_Public_Cloudinit_Oracle_Linux_7.4_64bit_40G", - "metering.resourcetype":"1", - "metering.product_id":"00301-117024-0--0", - "cascaded.instance_extrainfo":"pcibridge:2", - "os_bit":"64", - "vpc_id":"0431c5e5-bc94-4a44-8263-15da2a642435", - "os_type":"Linux", - "charging_mode":"1" - }, - "tags":[ + "tags": [ + ], - "description":"", - "locked":false, - "config_drive":"", - "tenant_id":"ff2eb406effc455aba53174463eb9322", - "user_id":"0bc5e11f91dd48849bb03b7c8a263b2c", - "key_name":"KeyPair-d750", - "os-extended-volumes:volumes_attached":[ + "description": "", + "locked": false, + "config_drive": "", + "tenant_id": "ff2eb406effc455aba53174463eb9322", + "user_id": "0bc5e11f91dd48849bb03b7c8a263b2c", + "key_name": "KeyPair-d750", + "os-extended-volumes:volumes_attached": [ { - "device":"/dev/vda", - "bootIndex":"0", - "id":"80c15cff-2473-4982-a816-d760cad6c42c", - "delete_on_termination":"false" + "id": "80c15cff-2473-4982-a816-d760cad6c42c", + "delete_on_termination": "false", + "device": "/dev/vda", + "bootIndex": "0" } ], - "OS-EXT-STS:task_state":null, - "OS-EXT-STS:power_state":1, - "OS-EXT-STS:vm_state":"active", - "OS-EXT-SRV-ATTR:host":"az21.dc1", - "OS-EXT-SRV-ATTR:instance_name":"instance-0015147f", - "OS-EXT-SRV-ATTR:hypervisor_hostname":"nova003@74", - "OS-EXT-SRV-ATTR:user_data":null, - "OS-DCF:diskConfig":"MANUAL", - "OS-EXT-AZ:availability_zone":"az1-dc1", - "os:scheduler_hints":{ + "OS-EXT-STS:task_state": null, + "OS-EXT-STS:power_state": 1, + "OS-EXT-STS:vm_state": "active", + "OS-EXT-SRV-ATTR:host": "az21.dc1", + "OS-EXT-SRV-ATTR:instance_name": "instance-0015147f", + "OS-EXT-SRV-ATTR:hypervisor_hostname": "nova003@74", + "OS-DCF:diskConfig": "MANUAL", + "OS-EXT-AZ:availability_zone": "az1-dc1", + "os:scheduler_hints": { + }, - "OS-EXT-SRV-ATTR:root_device_name":"/dev/vda", - "OS-EXT-SRV-ATTR:ramdisk_id":"", - "OS-SRV-USG:launched_at":"2018-09-13T07:04:09.197749", - "OS-EXT-SRV-ATTR:kernel_id":"", - "OS-EXT-SRV-ATTR:launch_index":0, - "host_status":"UP", - "OS-EXT-SRV-ATTR:reservation_id":"r-nrd8b5c4", - "OS-EXT-SRV-ATTR:hostname":"ecs-2ecf", - "sys_tags":[ + "OS-EXT-SRV-ATTR:root_device_name": "/dev/vda", + "OS-EXT-SRV-ATTR:ramdisk_id": "", + "OS-EXT-SRV-ATTR:user_data": null, + "OS-SRV-USG:launched_at": "2018-09-13T07:04:09.197749", + "OS-EXT-SRV-ATTR:kernel_id": "", + "OS-EXT-SRV-ATTR:launch_index": 0, + "host_status": "UP", + "OS-EXT-SRV-ATTR:reservation_id": "r-nrd8b5c4", + "OS-EXT-SRV-ATTR:hostname": "ecs-2ecf", + "OS-SRV-USG:terminated_at": null, + "sys_tags": [ { - "key":"_sys_enterprise_project_id", - "value":"0" + "key": "_sys_enterprise_project_id", + "value": "0" } ], - "security_groups":[ + "security_groups": [ { - "name":"sg-95ec", - "id":"6505b5d1-7837-41eb-8a1c-869d4355baa3" + "id": "6505b5d1-7837-41eb-8a1c-869d4355baa3", + "name": "sg-95ec" } - ] + ], + "image": { + "id": "c71b64e7-4767-4406-afde-2c7c7ac2242c" + }, + "hypervisor": null, + "auto_terminate_time": "", + "cpu_options": { + "hw:cpu_threads": null + }, + "enclave_options": { + "enabled": false + }, + "capacity_reservation_id": null, + "capacity_reservation_specification": { + "id": null, + "preference": null + }, + "security_options": { + "secure_boot_enabled": null, + "tpm_enabled": null + }, + "spod_id": null } }Querying Details About ECSs
+Querying Details About ECSs
Function
This API is used to query details about ECSs according to search criteria.
-The information that can be queried includes the ECS billing mode and whether the ECS is frozen.
+The information that can be queried includes the ECS billing mode and whether the ECS is frozen.
URI
GET /v1/{project_id}/cloudservers/detail?flavor={flavor}&name={name}&status={status}&limit={limit}&offset={offset}¬-tags={not-tags}&reservation_id={reservation_id}&&tags={tags}&ip={ip}
Table 1 describes the parameters in the URI. @@ -76,7 +76,7 @@String
Specifies the ECS status.
-Options:
+Value range:
ACTIVE, BUILD, ERROR, HARD_REBOOT, MIGRATING, REBOOT, REBUILD, RESIZE, REVERT_RESIZE, SHUTOFF, VERIFY_RESIZE, DELETED, SHELVED, SHELVED_OFFLOADED, and UNKNOWN
For details, see ECS Statuses.
NOTE:When an ECS is in an intermediate state, the statuses that can be obtained are as follows:
diff --git a/docs/ecs/api-ref/en-us_topic_0102606095.html b/docs/ecs/api-ref/en-us_topic_0102606095.html index ac54b19cf..dfd6ec4f0 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 }
ecs:servers:setMetadata
-
+ecs:servers:get
- Response body when action is set to count
Modifying ECS metadata with a specified key (native OpenStack API)
@@ -49,7 +49,7 @@ecs:servers:setMetadata
-
+ecs:servers:get
@@ -59,7 +59,7 @@ ecs:servers:setMetadata
-
+ecs:servers:get
diff --git a/docs/ecs/api-ref/en-us_topic_0103071521.html b/docs/ecs/api-ref/en-us_topic_0103071521.html index da634d9e9..c4924e167 100644 --- a/docs/ecs/api-ref/en-us_topic_0103071521.html +++ b/docs/ecs/api-ref/en-us_topic_0103071521.html @@ -39,32 +39,13 @@ -
- - -POST /v1/{project_id}/servers/{server_id}/tags/action
-ecs:servers:setTags
--
-POST /v1/{project_id}/servers/resource_instances/action
ecs:servers:getTags
-
-- -GET /v1/{project_id}/servers/tags
-ecs:servers:getTags
--
+ecs:servers:get
@@ -73,7 +54,7 @@ ecs:servers:getTags
-
+ecs:servers:get
diff --git a/docs/ecs/api-ref/en-us_topic_0103072348.html b/docs/ecs/api-ref/en-us_topic_0103072348.html index f7cbfcad9..91b43b4b8 100644 --- a/docs/ecs/api-ref/en-us_topic_0103072348.html +++ b/docs/ecs/api-ref/en-us_topic_0103072348.html @@ -19,13 +19,15 @@ ecs:servers:createImage
evs:volumes:get
+ecs:servers:list
+evs:volumes:get
evs:snapshots:create
ims:images:create
ims:images:get
ims:images:list
ims:images:update
ims:images:delete
+ims:quotas:get
String
Specifies the ascending or descending sorting.
-Options:
+Value range:
- asc: indicates the ascending order.
- desc: indicates the descending order.
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
@@ -198,7 +198,7 @@Boolean
This is an extended attribute, specifying whether a flavor is available.
-- true: indicates that a flavor is available.
- false: indicates that a flavor is unavailable.
- true: indicates that a flavor is unavailable.
- false: indicates that a flavor is available.
NOTE:This parameter is not used.
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
Modifying ECS Details
-Function
This API is used to modify ECS details. Only the name and description of an ECS can be modified.
Constraints
This API is used to modify the name of an ECS. For details about how to modify the host name of the ECS, see "How Can a Changed Static Hostname Take Effect Permanently?" in the Elastic Cloud Server User Guide.
+Constraints
This API is used to change the name of an ECS. For details about how to change the hostname of the ECS, see "How Can a Changed Static Hostname Take Effect Permanently?" in Elastic Cloud Server User Guide.
URI
PUT /v1/{project_id}/cloudservers/{server_id}
Table 1 describes the parameters in the URI. @@ -95,9 +95,9 @@String
Specifies the modified host name of the ECS.
+Specifies the new hostname of the ECS.
The name consists of 1-64 characters. It can be segmented using periods (.). Only letters, digits, and hyphens (-) are allowed in each segment. A name cannot contain consecutive periods (.) or hyphens (-), and cannot start or end with a period (.) or hyphen (-). Additionally, the combinations of (.-) and (-.) are not allowed.
-NOTE:This field is no longer used. For details about how to modify the host name of the ECS, see "How Can a Changed Static Hostname Take Effect Permanently?" in the Elastic Cloud Server User Guide.
+NOTE:This field is no longer used. For details about how to change the hostname of the ECS, see "How Can a Changed Static Hostname Take Effect Permanently?" in Elastic Cloud Server User Guide.
String
Specifies the ECS status.
-Options:
+Value range:
ACTIVE, BUILD, ERROR, HARD_REBOOT, MIGRATING, REBOOT, RESIZE, REVERT_RESIZE, SHELVED, SHELVED_OFFLOADED, SHUTOFF, UNKNOWN, and VERIFY_RESIZE
For details, see ECS Statuses.
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 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.
Specifies the ECS group ID in UUID format.
Obtain the parameter value from the console or by referring to Querying ECS Groups.
NOTE:Ensure that the ECS group uses the anti-affinity policy.
+The anti-affinity policy is not supported for ECSs created on a specified DeH.
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
@@ -463,7 +464,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
Data Structure for Querying Details About ECSs
+Data Structure for Querying Details About ECSs
-Table 1 address parameters Parameter
+- -
-Table 1 flavor parameters Parameter
Type
+Type
Description
+Description
version
+id
String
+String
Specifies the IP address version.
-- 4: indicates IPv4.
- 6: indicates IPv6.
Specifies the ECS flavor ID.
addr
+name
String
+String
Specifies the IP address.
+Specifies the ECS flavor name.
OS-EXT-IPS:type
+disk
String
+String
Specifies the IP address type.
-- fixed: indicates the private IP address.
- floating: indicates the floating IP address.
OS-EXT-IPS-MAC:mac_addr
-String
-Specifies the MAC address.
-OS-EXT-IPS:port_id
-String
-Specifies the port ID corresponding to the IP address.
--Table 2 flavor parameters Parameter
-Type
-Description
-id
-String
-Specifies the ECS flavor ID.
-name
-String
-Specifies the ECS flavor name.
-disk
-String
-Specifies the system disk size in the ECS flavor. Value 0 indicates that the disk size is not limited.
+Specifies the system disk size in the ECS flavor. Value 0 indicates that the disk size is not limited.
The field is invalid in this system.
vcpus
+vcpus
String
+String
Specifies the number of vCPUs in the ECS flavor.
+Specifies the number of vCPUs in the ECS flavor.
ram
+ram
String
+String
Specifies the memory size (MB) in the ECS flavor.
+Specifies the memory size (MB) in the ECS flavor.
Table 3 security_groups parameters Parameter
+-Table 2 security_groups parameters Parameter
Type
+Type
Description
+Description
name
+name
String
+String
Specifies the security group name or UUID.
+Specifies the security group name or UUID.
id
+id
String
+String
Specifies the security group ID.
+Specifies the security group ID.
Table 4 os-extended-volumes:volumes_attached parameters Parameter
+-Table 3 os-extended-volumes:volumes_attached parameters Parameter
Type
+Type
Description
+Description
id
+id
String
+String
Specifies the disk ID in UUID format.
+Specifies the disk ID in UUID format.
delete_on_termination
+delete_on_termination
String
+String
Specifies whether the disk is deleted with the ECS.
+Specifies whether the disk is deleted with the ECS.
- true: indicates that the disk is deleted with the ECS.
- false: indicates that the disk is not deleted with the ECS.
This parameter is supported in microversion 2.3 and later.
bootIndex
+bootIndex
String
+String
Specifies the EVS disk boot sequence.
+Specifies the EVS disk boot sequence.
- 0 indicates the system disk.
- Non-0 indicates a data disk.
device
+device
String
+String
Specifies the drive letter of the EVS disk, which is the device name of the EVS disk.
+Specifies the drive letter of the EVS disk, which is the device name of the EVS disk.
Table 5 metadata parameters Parameter
+-Table 4 metadata parameters Parameter
Type
+Type
Description
+Description
charging_mode
+charging_mode
String
+String
Specifies the ECS billing mode.
+Specifies the ECS billing mode.
vpc_id
+vpc_id
String
+String
Specifies the ID of the VPC where the ECS is located.
+Specifies the ID of the VPC where the ECS is located.
EcmResStatus
+EcmResStatus
String
+String
Specifies the ECS frozen status.
+Specifies the ECS frozen status.
- normal: The ECS is not frozen.
- freeze: The ECS has been frozen.
NOTE:The system automatically adds this field, which is mandatory, after an ECS is frozen or unfrozen.
metering.image_id
+metering.image_id
String
+String
Specifies the image ID of the ECS.
+Specifies the image ID of the ECS.
metering.imagetype
+metering.imagetype
String
+String
Specifies the image type. The following types are supported:
+Specifies the image type. The following types are supported:
- Public image (gold)
- Private image (private)
- Shared image (shared)
metering.resourcespeccode
+metering.resourcespeccode
String
+String
Specifies the resource specifications of the ECS.
+Specifies the resource specifications of the ECS.
metering.resourcetype
+metering.resourcetype
String
+String
Specifies the resource type of the ECS.
+Specifies the resource type of the ECS.
Value 1 indicates ECSs.
cascaded.instance_extrainfo
+cascaded.instance_extrainfo
String
+String
Specifies the extended information about the internal ECSs.
+Specifies the extended information about the internal ECSs.
image_name
+image_name
String
+String
Specifies the image name of the ECS.
+Specifies the image name of the ECS.
agency_name
+agency_name
String
+String
Specifies the IAM agency name.
+Specifies the IAM agency name.
An agency is created by a tenant administrator on IAM to provide temporary credentials for ECSs to access cloud services.
os_bit
+os_bit
String
+String
Specifies the number of bits in the operating system: 32 or 64.
+Specifies the number of bits in the operating system: 32 or 64.
os_type
+os_type
String
+String
Specifies the OS type. The value can be Linux or Windows.
+Specifies the OS type. The value can be Linux or Windows.
lockCheckEndpoint
+lockCheckEndpoint
String
+String
Specifies the callback URL for checking whether ECS locking is enabled.
+Specifies the callback URL for checking whether ECS locking is enabled.
- If ECS locking is enabled, the ECS is locked.
- If ECS locking is disabled, the ECS is unlocked, and invalid locks are deleted.
lockSource
+lockSource
String
+String
Specifies the lock source.
+Specifies the lock source.
- Order lock (ORDER)
lockSourceId
+lockSourceId
String
+String
Specifies the ECS lock source ID.
+Specifies the ECS lock source ID.
If lockSource is set to ORDER, lockSourceId is the order ID.
lockScene
+lockScene
String
+String
Specifies the ECS lock type.
+Specifies the ECS lock type.
virtual_env_type
+virtual_env_type
String
+String
- If an ECS is created using an iOS image, the value of this parameter is IsoImage.
- If an ECS is created using a non-iOS image, the value of this parameter is FusionCompute in versions earlier than 19.5.0, and this parameter will be unavailable in versions later than 19.5.0.
- If an ECS is created using an iOS image, the value of this parameter is IsoImage.
- If an ECS is created using a non-iOS image, the value of this parameter is FusionCompute in versions earlier than 19.5.0, and this parameter will be unavailable in versions later than 19.5.0.
NOTE:- The virtual_env_type cannot be added, deleted, or modified.
Table 6 sys_tags parameters Parameter
+-Table 5 sys_tags parameters Parameter
Type
+Type
Description
+Description
key
+key
String
+String
Specifies the system tag key.
+Specifies the system tag key.
value
+value
String
+String
Specifies the system tag value.
+Specifies the system tag value.
Table 7 image parameters Parameter
+Table 6 image parameters Parameter
Type
+Type
Description
+Description
id
+id
String
+String
Specifies the image ID.
+Specifies the image ID.
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 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.
- 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: Authorization scope of custom policies, which can be IAM projects, enterprise projects, or both. Custom policies that contain actions for both IAM projects and enterprise projects can be assigned to user groups and be applied in both IAM and Enterprise Management. Policies that contain actions only for IAM projects can be assigned to user groups and be applied only in IAM. They cannot be applied in Enterprise Management.
√: 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
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:
+This parameter takes effect region-wide. If an AZ is not configured in the cond:operation:az parameter, the value of this parameter is used by default. If this parameter is not set or used, the meaning of normal applies. Value range:
- 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).
- Create a pay-per-use ECS with 2 vCPUs, 16 GiB of memory, private image imageid_123, SSD disks attached, and 10 Mbit/s of bandwidth-billed EIP bound. Use the key pair for login authentication.