diff --git a/api-ref/source/apis_recommended/batch_operations/restarting_ecss_in_a_batch.rst b/api-ref/source/apis_recommended/batch_operations/restarting_ecss_in_a_batch.rst index 4877816..ab185bf 100644 --- a/api-ref/source/apis_recommended/batch_operations/restarting_ecss_in_a_batch.rst +++ b/api-ref/source/apis_recommended/batch_operations/restarting_ecss_in_a_batch.rst @@ -23,11 +23,25 @@ POST /v1/{project_id}/cloudservers/action .. table:: **Table 1** Parameter description - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= + +-----------------------+-----------------------+---------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+===========================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ Request ------- @@ -38,11 +52,25 @@ Request .. table:: **Table 2** Request parameters - +-----------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+============================================================================================================================+ - | reboot | Yes | Object | Specifies the operation to restart the ECS. For details, see :ref:`Table 3 `. | - +-----------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================================================================+ + | reboot | Yes | Object | **Definition** | + | | | | | + | | | | Specifies the operation to restart the ECS. For details, see :ref:`Table 3 `. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------+ .. _en-us_topic_0020212649__table64591731162222: @@ -51,23 +79,63 @@ Request +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +=================+=================+==================+===================================================================================================+ - | type | Yes | String | Specifies the type of the restart operation. | + | type | Yes | String | **Definition** | + | | | | | + | | | | Specifies the type of the restart operation. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | | | | | | | | | | - **SOFT**: normal restart | | | | | - **HARD**: forcible restart (hard restart) | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------------+ - | servers | Yes | Array of objects | Specifies ECS IDs. For details, see :ref:`Table 4 `. | + | servers | Yes | Array of objects | **Definition** | + | | | | | + | | | | Specifies ECS IDs. For details, see :ref:`Table 4 `. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------------+ .. _en-us_topic_0020212649__table26785545162223: .. table:: **Table 4** **servers** field description - ========= ========= ====== ===================== - Parameter Mandatory Type Description - ========= ========= ====== ===================== - id Yes String Specifies the ECS ID. - ========= ========= ====== ===================== + +-----------------+-----------------+-----------------+-----------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=======================+ + | id | Yes | String | **Definition** | + | | | | | + | | | | Specifies the ECS ID. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+-----------------+-----------------------+ Response -------- diff --git a/api-ref/source/apis_recommended/batch_operations/starting_ecss_in_a_batch.rst b/api-ref/source/apis_recommended/batch_operations/starting_ecss_in_a_batch.rst index 32c166c..daa716d 100644 --- a/api-ref/source/apis_recommended/batch_operations/starting_ecss_in_a_batch.rst +++ b/api-ref/source/apis_recommended/batch_operations/starting_ecss_in_a_batch.rst @@ -23,42 +23,98 @@ POST /v1/{project_id}/cloudservers/action .. table:: **Table 1** Parameter description - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= + +-----------------------+-----------------------+---------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+===========================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ Request ------- .. table:: **Table 2** Request parameters - +-----------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+==========================================================================================================================+ - | os-start | Yes | Object | Specifies the operation to start the ECS. For details, see :ref:`Table 3 `. | - +-----------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================+ + | os-start | Yes | Object | **Definition** | + | | | | | + | | | | Specifies the operation to start the ECS. For details, see :ref:`Table 3 `. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+ .. _en-us_topic_0020212207__table52132698163051: .. table:: **Table 3** **os-start** field description - +-----------+-----------+------------------+---------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+==================+=============================================================================================+ - | servers | Yes | Array of objects | Specifies ECS IDs. For details, see :ref:`Table 4 `. | - +-----------+-----------+------------------+---------------------------------------------------------------------------------------------+ + +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+==================+=============================================================================================+ + | servers | Yes | Array of objects | **Definition** | + | | | | | + | | | | Specifies ECS IDs. For details, see :ref:`Table 4 `. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------+ .. _en-us_topic_0020212207__table23507505: .. table:: **Table 4** **servers** field description - ========= ========= ====== ===================== - Parameter Mandatory Type Description - ========= ========= ====== ===================== - id Yes String Specifies the ECS ID. - ========= ========= ====== ===================== + +-----------------+-----------------+-----------------+-----------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=======================+ + | id | Yes | String | **Definition** | + | | | | | + | | | | Specifies the ECS ID. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+-----------------+-----------------------+ Response -------- diff --git a/api-ref/source/apis_recommended/batch_operations/stopping_ecss_in_a_batch.rst b/api-ref/source/apis_recommended/batch_operations/stopping_ecss_in_a_batch.rst index a5ee540..703e792 100644 --- a/api-ref/source/apis_recommended/batch_operations/stopping_ecss_in_a_batch.rst +++ b/api-ref/source/apis_recommended/batch_operations/stopping_ecss_in_a_batch.rst @@ -23,22 +23,50 @@ POST /v1/{project_id}/cloudservers/action .. table:: **Table 1** Parameter description - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= + +-----------------------+-----------------------+---------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+===========================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ Request ------- .. table:: **Table 2** Request parameters - +-----------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+=========================================================================================================================+ - | os-stop | Yes | Object | Specifies the operation to stop the ECS. For details, see :ref:`Table 3 `. | - +-----------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=========================================================================================================================+ + | os-stop | Yes | Object | **Definition** | + | | | | | + | | | | Specifies the operation to stop the ECS. For details, see :ref:`Table 3 `. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------+ .. _en-us_topic_0020212651__table51053190162024: @@ -47,24 +75,63 @@ Request +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +=================+=================+==================+=============================================================================================+ - | servers | Yes | Array of objects | Specifies ECS IDs. For details, see :ref:`Table 4 `. | + | servers | Yes | Array of objects | **Definition** | + | | | | | + | | | | Specifies ECS IDs. For details, see :ref:`Table 4 `. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------+ - | type | No | String | Specifies an ECS stop type. The default value is **SOFT**. | + | type | No | String | **Definition** | + | | | | | + | | | | Specifies the type of the stop operation. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | - **SOFT**: normal stop (default) | + | | | | - **HARD**: forcible stop | | | | | | - | | | | **SOFT**: normal ECS stop (default) | + | | | | **Default Value** | | | | | | - | | | | **HARD**: forcible ECS stop | + | | | | SOFT | +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------+ .. _en-us_topic_0020212651__table48932206: .. table:: **Table 4** **servers** field description - ========= ========= ====== ===================== - Parameter Mandatory Type Description - ========= ========= ====== ===================== - id Yes String Specifies the ECS ID. - ========= ========= ====== ===================== + +-----------------+-----------------+-----------------+-----------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=======================+ + | id | Yes | String | **Definition** | + | | | | | + | | | | Specifies the ECS ID. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+-----------------+-----------------------+ Response -------- diff --git a/api-ref/source/apis_recommended/disk_management/attaching_a_disk_to_an_ecs.rst b/api-ref/source/apis_recommended/disk_management/attaching_a_disk_to_an_ecs.rst index 6e16a3a..0584352 100644 --- a/api-ref/source/apis_recommended/disk_management/attaching_a_disk_to_an_ecs.rst +++ b/api-ref/source/apis_recommended/disk_management/attaching_a_disk_to_an_ecs.rst @@ -23,55 +23,183 @@ POST /v1/{project_id}/cloudservers/{server_id}/attachvolume .. table:: **Table 1** Parameter description - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= + +-----------------------+-----------------------+---------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+===========================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ + | server_id | Yes | **Definition** | + | | | | + | | | Specifies the ECS ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ Request ------- .. table:: **Table 2** Request parameters - +------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==================+=================+=================+============================================================================================================================================================================================================================================================================================+ - | volumeAttachment | Yes | Object | Specifies the ECS attachment information. For details, see :ref:`Table 3 `. | - +------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dry_run | No | Boolean | Specifies whether to check the request and attach the disk. | - | | | | | - | | | | - **true**: indicates that only the request is sent, and no disk will be attached. Check items include mandatory parameters, request format, and service restrictions. If the check fails, the system returns an error. If the check result is as expected, the system properly responds. | - | | | | - **false**: indicates that only the request is sent and the disk will be attached if the check result is as expected. | - | | | | | - | | | | The default value is **false**. | - +------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==================+=================+=================+=====================================================================================================================================================+ + | volumeAttachment | Yes | Object | **Definition** | + | | | | | + | | | | Specifies the ECS attachment information. For details, see :ref:`Table 3 `. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | dry_run | No | Boolean | **Definition** | + | | | | | + | | | | Specifies whether the system checks the request. If this parameter is set to **true**, the system checks the request, but no disk will be attached. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | - **true**: The system checks the request. Check items include mandatory parameters and request format. | + | | | | | + | | | | - If the check fails, the system returns an error. | + | | | | - If the check is successful, the system returns status code 202. | + | | | | | + | | | | - **false**: The system sends the request without checking the request body. | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | false | + +------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ .. _en-us_topic_0022472987__table40707503151632: .. table:: **Table 3** **volumeAttachment** field description - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==========================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | volumeId | Yes | String | Specifies the ID of the disk to be attached. The value is in UUID format. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device | No | String | Indicates the disk device name. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | - The new disk device name cannot be the same as an existing one. | - | | | | - For KVM ECSs, set the parameter value to **/dev/vda** for system disks. The device names for data disks of KVM ECSs are optional. If the device names of data disks are required, set them in alphabetical order. For example, if there are two data disks, set the device names of the two data disks to **/dev/vdb** and **/dev/vdc**, respectively. If you set a device name starting with **/dev/sd**, the system uses **/dev/vd** by default. | - | | | | - For ECSs that only support SCSI disks, set the device name of the system disk to **/dev/sda** and the device names of data disks in alphabetical order, for example, **/dev/sdb** and **/dev/sdc**. The system will not change the default device names. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | volume_type | No | String | Specifies the disk type. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | count | No | Integer | Specifies the number of disks. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | hw:passthrough | No | String | - 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. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=======================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | volumeId | Yes | String | **Definition** | + | | | | | + | | | | Specifies the ID of the disk to be attached. The value is in UUID format. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device | No | String | **Definition** | + | | | | | + | | | | Specifies the disk device name. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | The new disk device name cannot be the same as an existing one. | + | | | | | + | | | | **Range** | + | | | | | + | | | | - For KVM ECSs, set the parameter value to **/dev/vda** for system disks. The device names for data disks of KVM ECSs are optional. If the device names of data disks are required, set them in alphabetical order. For example, if there are two data disks, set the device names of the two data disks to **/dev/vdb** and **/dev/vdc**, respectively. If you set a device name starting with **/dev/sd**, the system uses **/dev/vd** by default. | + | | | | - For ECSs that only support SCSI disks, set the device name of the system disk to **/dev/sda** and the device names of data disks in alphabetical order, for example, **/dev/sdb** and **/dev/sdc**. The system will not change the default device names. | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | volume_type | No | String | **Definition** | + | | | | | + | | | | Specifies the disk type. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | The value can be **ESSD**, **GPSSD**, **SSD**, **SAS**, or **SATA**. | + | | | | | + | | | | - **SSD**: the ultra-high I/O type | + | | | | - **SAS**: the high I/O type | + | | | | - **SATA**: the common I/O type (end-of-sale) | + | | | | - **GPSSD**: the general purpose SSD type | + | | | | - **ESSD**: the extreme SSD type | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | count | No | Integer | **Definition** | + | | | | | + | | | | Specifies the number of disks. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | hw:passthrough | No | String | **Definition** | + | | | | | + | | | | Specifies the EVS disk device type. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | - **true**: indicates the SCSI device type, which allows ECS OSs to directly access the underlying storage media. SCSI reservation commands are supported. | + | | | | - **false**: indicates the VBD disk device type, which only supports simple SCSI read/write commands. | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response -------- diff --git a/api-ref/source/apis_recommended/disk_management/detaching_an_evs_disk_from_an_ecs.rst b/api-ref/source/apis_recommended/disk_management/detaching_an_evs_disk_from_an_ecs.rst index 806d90e..34d6482 100644 --- a/api-ref/source/apis_recommended/disk_management/detaching_an_evs_disk_from_an_ecs.rst +++ b/api-ref/source/apis_recommended/disk_management/detaching_an_evs_disk_from_an_ecs.rst @@ -26,18 +26,70 @@ DELETE /v1/{project_id}/cloudservers/{server_id}/detachvolume/{volume_id} +-----------------------+-----------------------+---------------------------------------------------+ | Parameter | Mandatory | Description | +=======================+=======================+===================================================+ - | project_id | Yes | Specifies the project ID. | + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | +-----------------------+-----------------------+---------------------------------------------------+ - | server_id | Yes | Specifies the ECS ID. | + | server_id | Yes | **Definition** | + | | | | + | | | Specifies the ECS ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | +-----------------------+-----------------------+---------------------------------------------------+ - | volume_id | Yes | Specifies the disk ID. | + | volume_id | Yes | **Definition** | + | | | | + | | | Specifies the disk ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | +-----------------------+-----------------------+---------------------------------------------------+ - | delete_flag | No | Indicates whether to forcibly detach a data disk. | + | delete_flag | No | **Definition** | + | | | | + | | | Specifies whether to forcibly detach a data disk. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | | | | | | | | - If yes, set it to **1**. | | | | - If no, set it to **0**. | | | | | - | | | It is set to **0** by default. | + | | | **Default Value** | + | | | | + | | | 0 | +-----------------------+-----------------------+---------------------------------------------------+ Request diff --git a/api-ref/source/apis_recommended/disk_management/listing_details_about_disks_attached_to_an_ecs.rst b/api-ref/source/apis_recommended/disk_management/listing_details_about_disks_attached_to_an_ecs.rst index 0293bd0..e2907aa 100644 --- a/api-ref/source/apis_recommended/disk_management/listing_details_about_disks_attached_to_an_ecs.rst +++ b/api-ref/source/apis_recommended/disk_management/listing_details_about_disks_attached_to_an_ecs.rst @@ -21,12 +21,41 @@ GET /v1/{project_id}/cloudservers/{server_id}/block_device .. table:: **Table 1** Parameter description - ========== ========= ==================================== - Parameter Mandatory Description - ========== ========= ==================================== - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID in UUID format. - ========== ========= ==================================== + +-----------------------+-----------------------+--------------------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+======================================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+--------------------------------------+ + | server_id | Yes | **Definition** | + | | | | + | | | Specifies the ECS ID in UUID format. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+--------------------------------------+ Request ------- @@ -42,13 +71,25 @@ Response .. table:: **Table 2** Response parameters - +--------------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +====================+==================+==============================================================================================================================================+ - | volumeAttachments | Array of objects | Specifies the disks attached to an ECS. For details, see :ref:`Table 3 `. | - +--------------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | attachableQuantity | Object | Specifies the number of disks that can be attached to an ECS. For details, see :ref:`Table 4 `. | - +--------------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+==============================================================================================================================================+ + | volumeAttachments | Array of objects | **Definition** | + | | | | + | | | Specifies the disks attached to an ECS. For details, see :ref:`Table 3 `. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | attachableQuantity | Object | **Definition** | + | | | | + | | | Specifies the number of disks that can be attached to an ECS. For details, see :ref:`Table 4 `. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ .. _en-us_topic_0122107473__table7886611: @@ -57,43 +98,106 @@ Response +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ | Parameter | Type | Description | +=======================+=======================+==========================================================================================+ - | serverId | String | Specifies the ECS ID in UUID format. | + | serverId | String | **Definition** | + | | | | + | | | Specifies the ECS ID in UUID format. | + | | | | + | | | **Range** | + | | | | + | | | N/A | +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ - | volumeId | String | Specifies the EVS disk ID in UUID format. | + | volumeId | String | **Definition** | + | | | | + | | | Specifies the EVS disk ID in UUID format. | + | | | | + | | | **Range** | + | | | | + | | | N/A | +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ - | id | String | Specifies the mount ID, which is the same as the EVS disk ID. | + | id | String | **Definition** | + | | | | + | | | Specifies the mount ID, which is the same as the EVS disk ID. | | | | | | | | The value is in UUID format. | + | | | | + | | | **Range** | + | | | | + | | | N/A | +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ - | size | Integer | Specifies the EVS disk size, in GiB. | + | size | Integer | **Definition** | + | | | | + | | | Specifies the EVS disk size, in GiB. | + | | | | + | | | **Range** | + | | | | + | | | N/A | +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ - | device | String | Specifies the drive letter of the EVS disk, displayed as the device name on the console. | + | device | String | **Definition** | + | | | | + | | | Specifies the drive letter of the EVS disk, displayed as the device name on the console. | + | | | | + | | | **Range** | + | | | | + | | | N/A | +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ - | pciAddress | String | Specifies the PCI address. | + | pciAddress | String | **Definition** | + | | | | + | | | Specifies the PCI address. | + | | | | + | | | **Range** | + | | | | + | | | N/A | +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ - | bootIndex | Integer | Specifies the EVS disk boot sequence. | + | bootIndex | Integer | **Definition** | + | | | | + | | | Specifies the EVS disk boot sequence. | + | | | | + | | | **Range** | | | | | | | | - **0** indicates the system disk. | | | | - A non-zero value indicates a data disk. | +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ - | bus | String | Specifies the disk bus type. | + | bus | String | **Definition** | + | | | | + | | | Specifies the disk bus type. | + | | | | + | | | **Range** | | | | | - | | | Options: **virtio** and **scsi** | + | | | - virtio | + | | | - scsi | +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ .. _en-us_topic_0122107473__table17531254101519: .. table:: **Table 4** **attachableQuantity** parameters - +-----------+---------+--------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+=========+==========================================================================+ - | free_scsi | Integer | Specifies the number of SCSI disks that can be attached to an ECS. | - +-----------+---------+--------------------------------------------------------------------------+ - | free_blk | Integer | Specifies the number of virtio_blk disks that can be attached to an ECS. | - +-----------+---------+--------------------------------------------------------------------------+ - | free_disk | Integer | Specifies the total number of disks that can be attached to an ECS. | - +-----------+---------+--------------------------------------------------------------------------+ + +-----------------------+-----------------------+--------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+==========================================================================+ + | free_scsi | Integer | **Definition** | + | | | | + | | | Specifies the number of SCSI disks that can be attached to an ECS. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+--------------------------------------------------------------------------+ + | free_blk | Integer | **Definition** | + | | | | + | | | Specifies the number of virtio_blk disks that can be attached to an ECS. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+--------------------------------------------------------------------------+ + | free_disk | Integer | **Definition** | + | | | | + | | | Specifies the total number of disks that can be attached to an ECS. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+--------------------------------------------------------------------------+ Example Request --------------- diff --git a/api-ref/source/apis_recommended/disk_management/querying_details_of_a_single_disk_attached_to_an_ecs.rst b/api-ref/source/apis_recommended/disk_management/querying_details_of_a_single_disk_attached_to_an_ecs.rst index 991f533..d9305e9 100644 --- a/api-ref/source/apis_recommended/disk_management/querying_details_of_a_single_disk_attached_to_an_ecs.rst +++ b/api-ref/source/apis_recommended/disk_management/querying_details_of_a_single_disk_attached_to_an_ecs.rst @@ -23,13 +23,57 @@ GET /v1/{project_id}/cloudservers/{server_id}/block_device/{volume_id} .. table:: **Table 1** Parameter description - ========== ========= ========================================= - Parameter Mandatory Description - ========== ========= ========================================= - server_id Yes Specifies the ECS ID in UUID format. - project_id Yes Specifies the project ID. - volume_id Yes Specifies the EVS disk ID in UUID format. - ========== ========= ========================================= + +-----------------------+-----------------------+-------------------------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+===========================================+ + | server_id | Yes | **Definition** | + | | | | + | | | Specifies the ECS ID in UUID format. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+-------------------------------------------+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+-------------------------------------------+ + | volume_id | Yes | **Definition** | + | | | | + | | | Specifies the EVS disk ID in UUID format. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+-------------------------------------------+ Request ------- @@ -45,11 +89,17 @@ Response .. table:: **Table 2** Response parameters - +------------------+--------+----------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==================+========+======================================================================================================================+ - | volumeAttachment | Object | Specifies the disk attached to an ECS. For details, see :ref:`Table 3 `. | - +------------------+--------+----------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================================================+ + | volumeAttachment | Object | **Definition** | + | | | | + | | | Specifies the disk attached to an ECS. For details, see :ref:`Table 3 `. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------+ .. _en-us_topic_0167811961__table1128997111919: @@ -58,28 +108,73 @@ Response +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ | Parameter | Type | Description | +=======================+=======================+==========================================================================================+ - | serverId | String | Specifies the ECS ID in UUID format. | + | serverId | String | **Definition** | + | | | | + | | | Specifies the ECS ID in UUID format. | + | | | | + | | | **Range** | + | | | | + | | | N/A | +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ - | volumeId | String | Specifies the EVS disk ID in UUID format. | + | volumeId | String | **Definition** | + | | | | + | | | Specifies the EVS disk ID in UUID format. | + | | | | + | | | **Range** | + | | | | + | | | N/A | +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ - | id | String | Specifies the mount ID, which is the same as the EVS disk ID. | + | id | String | **Definition** | + | | | | + | | | Specifies the mount ID, which is the same as the EVS disk ID. | | | | | | | | The value is in UUID format. | + | | | | + | | | **Range** | + | | | | + | | | N/A | +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ - | size | Integer | Specifies the EVS disk size, in GiB. | + | size | Integer | **Definition** | + | | | | + | | | Specifies the EVS disk size, in GiB. | + | | | | + | | | **Range** | + | | | | + | | | N/A | +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ - | device | String | Specifies the drive letter of the EVS disk, displayed as the device name on the console. | + | device | String | **Definition** | + | | | | + | | | Specifies the drive letter of the EVS disk, displayed as the device name on the console. | + | | | | + | | | **Range** | + | | | | + | | | N/A | +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ - | pciAddress | String | Specifies the PCI address. | + | pciAddress | String | **Definition** | + | | | | + | | | Specifies the PCI address. | + | | | | + | | | **Range** | + | | | | + | | | N/A | +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ - | bootIndex | Integer | Specifies the EVS disk boot sequence. | + | bootIndex | Integer | **Definition** | + | | | | + | | | Specifies the EVS disk boot sequence. | + | | | | + | | | **Range** | | | | | | | | - **0** indicates the system disk. | | | | - Non-**0** indicates a data disk. | +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ - | bus | String | Specifies the disk bus type. | + | bus | String | **Definition** | + | | | | + | | | Specifies the disk bus type. | + | | | | + | | | **Range** | | | | | - | | | Options: **virtio** and **scsi** | + | | | - virtio | + | | | - scsi | +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ Example Request diff --git a/api-ref/source/apis_recommended/ecs_group_management/adding_an_ecs_to_an_ecs_group.rst b/api-ref/source/apis_recommended/ecs_group_management/adding_an_ecs_to_an_ecs_group.rst index 462af2f..4fb64dd 100644 --- a/api-ref/source/apis_recommended/ecs_group_management/adding_an_ecs_to_an_ecs_group.rst +++ b/api-ref/source/apis_recommended/ecs_group_management/adding_an_ecs_to_an_ecs_group.rst @@ -28,12 +28,41 @@ POST /v1/{project_id}/cloudservers/os-server-groups/{server_group_id}/action .. table:: **Table 1** Parameter description - =============== ========= =========================== - Parameter Mandatory Description - =============== ========= =========================== - project_id Yes Specifies the project ID. - server_group_id Yes Specifies the ECS group ID. - =============== ========= =========================== + +-----------------------+-----------------------+-----------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+=============================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+-----------------------------+ + | server_group_id | Yes | **Definition** | + | | | | + | | | Specifies the ECS group ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+-----------------------------+ Request ------- @@ -47,20 +76,48 @@ Request +-----------------+-----------------+-----------------+------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +=================+=================+=================+==============================================================================+ - | add_member | Yes | Object | Specifies the information of the ECS to be added to an ECS group. | + | add_member | Yes | Object | **Definition** | + | | | | | + | | | | Specifies the information of the ECS to be added to an ECS group. | | | | | | | | | | For details, see :ref:`Table 3 `. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------+ .. _en-us_topic_0133622595__table532112610239: .. table:: **Table 3** **add_member** parameters - ============= ========= ====== ======================= - Parameter Mandatory Type Description - ============= ========= ====== ======================= - instance_uuid Yes String Specifies the ECS UUID. - ============= ========= ====== ======================= + +-----------------+-----------------+-----------------+-------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=========================+ + | instance_uuid | Yes | String | **Definition** | + | | | | | + | | | | Specifies the ECS UUID. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+-----------------+-------------------------+ Response -------- diff --git a/api-ref/source/apis_recommended/ecs_group_management/creating_an_ecs_group.rst b/api-ref/source/apis_recommended/ecs_group_management/creating_an_ecs_group.rst index 4c09084..ce7ba63 100644 --- a/api-ref/source/apis_recommended/ecs_group_management/creating_an_ecs_group.rst +++ b/api-ref/source/apis_recommended/ecs_group_management/creating_an_ecs_group.rst @@ -26,11 +26,25 @@ POST /v1/{project_id}/cloudservers/os-server-groups .. table:: **Table 1** Parameter description - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= + +-----------------------+-----------------------+---------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+===========================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ Request ------- diff --git a/api-ref/source/apis_recommended/ecs_group_management/deleting_an_ecs_group.rst b/api-ref/source/apis_recommended/ecs_group_management/deleting_an_ecs_group.rst index 494d14f..772c65a 100644 --- a/api-ref/source/apis_recommended/ecs_group_management/deleting_an_ecs_group.rst +++ b/api-ref/source/apis_recommended/ecs_group_management/deleting_an_ecs_group.rst @@ -21,12 +21,41 @@ DELETE /v1/{project_id}/cloudservers/os-server-groups/{server_group_id} .. table:: **Table 1** Parameter description - =============== ========= ============================= - Parameter Mandatory Description - =============== ========= ============================= - project_id Yes Specifies the project ID. - server_group_id Yes Specifies the ECS group UUID. - =============== ========= ============================= + +-----------------------+-----------------------+-------------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+===============================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+-------------------------------+ + | server_group_id | Yes | **Definition** | + | | | | + | | | Specifies the ECS group UUID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+-------------------------------+ Request Parameters ------------------ diff --git a/api-ref/source/apis_recommended/ecs_group_management/listing_ecs_groups.rst b/api-ref/source/apis_recommended/ecs_group_management/listing_ecs_groups.rst index 92996dc..4baa41e 100644 --- a/api-ref/source/apis_recommended/ecs_group_management/listing_ecs_groups.rst +++ b/api-ref/source/apis_recommended/ecs_group_management/listing_ecs_groups.rst @@ -21,22 +21,62 @@ GET /v1/{project_id}/cloudservers/os-server-groups .. table:: **Table 1** Path parameters - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= + +-----------------------+-----------------------+---------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+===========================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ .. table:: **Table 2** Query parameters +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +=================+=================+=================+============================================================================================================================+ - | limit | No | Integer | Specifies the upper limit on the number of returned server groups. The maximum value is 1,000. | + | limit | No | Integer | **Definition** | + | | | | | + | | | | Specifies the maximum number of server groups that can be returned. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | Maximum: 1000 | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------+ - | marker | No | String | Specifies the marker that points to the ECS group. The query starts from the next piece of data indexed by this parameter. | + | marker | No | String | **Definition** | + | | | | | + | | | | Specifies the marker that points to the ECS group. The query starts from the next piece of data indexed by this parameter. | + | | | | | + | | | | **Constraints** | | | | | | | | | | Parameters marker and limit must be used together. | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------+ Request @@ -53,13 +93,25 @@ Response .. table:: **Table 3** Response parameters - +---------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===============+==================+=====================================================================================================================================================================================+ - | server_groups | Array of objects | Specifies ECS groups. For details, see :ref:`Table 4 `. | - +---------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | page_info | Object | If the pagination function is enabled, the UUID of the last ECS group on the current page is returned. For details, see :ref:`Table 5 `. | - +---------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=====================================================================================================================================================================================+ + | server_groups | Array of objects | **Definition** | + | | | | + | | | Specifies ECS groups. For details, see :ref:`Table 4 `. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | page_info | Object | **Definition** | + | | | | + | | | If the pagination function is enabled, the UUID of the last ECS group on the current page is returned. For details, see :ref:`Table 5 `. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _en-us_topic_0175597846__en-us_topic_0057973158_table47937085: @@ -68,15 +120,43 @@ Response +-----------------------+-----------------------+-------------------------------------------------------------------------------+ | Parameter | Type | Description | +=======================+=======================+===============================================================================+ - | id | String | Specifies the ECS group UUID. | + | id | String | **Definition** | + | | | | + | | | Specifies the ECS group UUID. | + | | | | + | | | **Range** | + | | | | + | | | N/A | +-----------------------+-----------------------+-------------------------------------------------------------------------------+ - | name | String | Specifies the ECS group name. | + | name | String | **Definition** | + | | | | + | | | Specifies the ECS group name. | + | | | | + | | | **Range** | + | | | | + | | | N/A | +-----------------------+-----------------------+-------------------------------------------------------------------------------+ - | members | Array of strings | Specifies the ECSs contained in an ECS group. | + | members | Array of strings | **Definition** | + | | | | + | | | Specifies the ECSs contained in an ECS group. | + | | | | + | | | **Range** | + | | | | + | | | N/A | +-----------------------+-----------------------+-------------------------------------------------------------------------------+ - | metadata | Object | Specifies the ECS group metadata. | + | metadata | Object | **Definition** | + | | | | + | | | Specifies the ECS group metadata. | + | | | | + | | | **Range** | + | | | | + | | | N/A | +-----------------------+-----------------------+-------------------------------------------------------------------------------+ - | policies | Array of strings | Specifies the policies associated with the ECS group. Options: | + | policies | Array of strings | **Definition** | + | | | | + | | | Specifies the policies associated with the ECS group. | + | | | | + | | | **Range** | | | | | | | | - **anti-affinity**: ECSs in this group must be deployed on different hosts. | +-----------------------+-----------------------+-------------------------------------------------------------------------------+ @@ -85,11 +165,17 @@ Response .. table:: **Table 5** **page_info** field description - =========== ====== ============================ - Parameter Type Description - =========== ====== ============================ - next_marker String Specifies an ECS group UUID. - =========== ====== ============================ + +-----------------------+-----------------------+------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+==============================+ + | next_marker | String | **Definition** | + | | | | + | | | Specifies an ECS group UUID. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+------------------------------+ Example Request --------------- diff --git a/api-ref/source/apis_recommended/ecs_group_management/querying_details_about_an_ecs_group.rst b/api-ref/source/apis_recommended/ecs_group_management/querying_details_about_an_ecs_group.rst index ac6ac77..9120828 100644 --- a/api-ref/source/apis_recommended/ecs_group_management/querying_details_about_an_ecs_group.rst +++ b/api-ref/source/apis_recommended/ecs_group_management/querying_details_about_an_ecs_group.rst @@ -21,12 +21,41 @@ GET /v1/{project_id}/cloudservers/os-server-groups/{server_group_id} .. table:: **Table 1** Parameter description - =============== ========= ============================ - Parameter Mandatory Description - =============== ========= ============================ - project_id Yes Specifies the project ID. - server_group_id Yes Specifies an ECS group UUID. - =============== ========= ============================ + +-----------------------+-----------------------+------------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+==============================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+------------------------------+ + | server_group_id | Yes | **Definition** | + | | | | + | | | Specifies an ECS group UUID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+------------------------------+ Request ------- @@ -42,29 +71,65 @@ Response .. table:: **Table 2** Response parameters - +--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==============+========+=====================================================================================================================================+ - | server_group | Object | Specifies the ECS group information. For details, see :ref:`Table 3 `. | - +--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=====================================================================================================================================+ + | server_group | Object | **Definition** | + | | | | + | | | Specifies the ECS group information. For details, see :ref:`Table 3 `. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------+ .. _en-us_topic_0175597847__en-us_topic_0057973159_table5520021: .. table:: **Table 3** **server_group** parameters - +-----------+------------------+-------------------------------------------------------+ - | Parameter | Type | Description | - +===========+==================+=======================================================+ - | id | String | Specifies an ECS group UUID. | - +-----------+------------------+-------------------------------------------------------+ - | name | String | Specifies the ECS group name. | - +-----------+------------------+-------------------------------------------------------+ - | policies | Array of strings | Specifies the policies associated with the ECS group. | - +-----------+------------------+-------------------------------------------------------+ - | members | Array of strings | Specifies the ECS contained in an ECS group. | - +-----------+------------------+-------------------------------------------------------+ - | metadata | Object | Specifies the ECS group metadata. | - +-----------+------------------+-------------------------------------------------------+ + +-----------------------+-----------------------+-------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=======================================================+ + | id | String | **Definition** | + | | | | + | | | Specifies an ECS group UUID. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+-------------------------------------------------------+ + | name | String | **Definition** | + | | | | + | | | Specifies the ECS group name. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+-------------------------------------------------------+ + | policies | Array of strings | **Definition** | + | | | | + | | | Specifies the policies associated with the ECS group. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+-------------------------------------------------------+ + | members | Array of strings | **Definition** | + | | | | + | | | Specifies the ECS contained in an ECS group. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+-------------------------------------------------------+ + | metadata | Object | **Definition** | + | | | | + | | | Specifies the ECS group metadata. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+-------------------------------------------------------+ Example Request --------------- diff --git a/api-ref/source/apis_recommended/ecs_group_management/removing_an_ecs_from_an_ecs_group.rst b/api-ref/source/apis_recommended/ecs_group_management/removing_an_ecs_from_an_ecs_group.rst index 6df8c10..2593f12 100644 --- a/api-ref/source/apis_recommended/ecs_group_management/removing_an_ecs_from_an_ecs_group.rst +++ b/api-ref/source/apis_recommended/ecs_group_management/removing_an_ecs_from_an_ecs_group.rst @@ -26,12 +26,41 @@ POST /v1/{project_id}/cloudservers/os-server-groups/{server_group_id}/action .. table:: **Table 1** Parameter description - =============== ========= =========================== - Parameter Mandatory Description - =============== ========= =========================== - project_id Yes Specifies the project ID. - server_group_id Yes Specifies the ECS group ID. - =============== ========= =========================== + +-----------------------+-----------------------+-----------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+=============================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+-----------------------------+ + | server_group_id | Yes | **Definition** | + | | | | + | | | Specifies the ECS group ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+-----------------------------+ Request ------- @@ -42,19 +71,47 @@ Request .. table:: **Table 2** Request parameters - +---------------+-----------+--------+-----------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===============+===========+========+=======================================================================+ - | remove_member | Yes | Object | Specifies the information of the ECS to be removed from an ECS group. | - +---------------+-----------+--------+-----------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=======================================================================+ + | remove_member | Yes | Object | **Definition** | + | | | | | + | | | | Specifies the information of the ECS to be removed from an ECS group. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------+ .. table:: **Table 3** **remove_member** parameters - ============= ========= ====== ======================= - Parameter Mandatory Type Description - ============= ========= ====== ======================= - instance_uuid Yes String Specifies the ECS UUID. - ============= ========= ====== ======================= + +-----------------+-----------------+-----------------+-------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=========================+ + | instance_uuid | Yes | String | **Definition** | + | | | | | + | | | | Specifies the ECS UUID. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+-----------------+-------------------------+ Response -------- diff --git a/api-ref/source/apis_recommended/flavor_management/listing_flavor_details_and_extended_information.rst b/api-ref/source/apis_recommended/flavor_management/listing_flavor_details_and_extended_information.rst index 8de3ef6..6ebe394 100644 --- a/api-ref/source/apis_recommended/flavor_management/listing_flavor_details_and_extended_information.rst +++ b/api-ref/source/apis_recommended/flavor_management/listing_flavor_details_and_extended_information.rst @@ -21,11 +21,25 @@ GET /v1/{project_id}/cloudservers/flavors .. table:: **Table 1** Path parameters - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= + +-----------------------+-----------------------+---------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+===========================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ .. table:: **Table 2** Query parameters @@ -216,15 +230,33 @@ Response .. table:: **Table 5** **links** field description - +-----------+--------+----------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+====================================================================================================+ - | rel | String | Specifies the shortcut link marker name. | - +-----------+--------+----------------------------------------------------------------------------------------------------+ - | href | String | Provides the corresponding shortcut link. | - +-----------+--------+----------------------------------------------------------------------------------------------------+ - | type | String | Specifies the shortcut link type. This parameter has not been used. Its default value is **null**. | - +-----------+--------+----------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+====================================================================================================+ + | rel | String | **Definition** | + | | | | + | | | Specifies the shortcut link marker name. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------+ + | href | String | **Definition** | + | | | | + | | | Provides the corresponding shortcut link. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------+ + | type | String | **Definition** | + | | | | + | | | Specifies the shortcut link type. This parameter has not been used. Its default value is **null**. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------+ .. _en-us_topic_0020212656__table59078165: @@ -233,7 +265,11 @@ Response +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | +==================================+=======================+============================================================================================================================================================================================================================================================================================================================================================================================================================+ - | ecs:performancetype | String | Specifies the ECS flavor type: | + | ecs:performancetype | String | **Definition** | + | | | | + | | | Specifies the ECS flavor type. | + | | | | + | | | **Range** | | | | | | | | - **normal**: general computing | | | | - **computingv3**: general computing-plus | @@ -245,15 +281,45 @@ Response | | | - **gpu**: GPU-accelerated | | | | - **fpga**: FPGA-accelerated | +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_type | String | Specifies the resource type. **resource_type** is used to differentiate between the types of the physical servers accommodating ECSs. | + | resource_type | String | **Definition** | + | | | | + | | | Specifies the resource type. **resource_type** is used to differentiate between the types of the physical servers accommodating ECSs. | + | | | | + | | | **Range** | + | | | | + | | | N/A | +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_vnic:type | String | Specifies the NIC type. The value of this parameter is consistently **enhanced**, indicating that network enhancement ECSs are to be created. | + | instance_vnic:type | String | **Definition** | + | | | | + | | | Specifies the NIC type. | + | | | | + | | | **Range** | + | | | | + | | | The value is fixed at **enhanced**, indicating that network-enhanced resources are used to create ECSs. | +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_vnic:instance_bandwidth | String | Specifies the maximum bandwidth in the unit of Mbit/s. The maximum value of this parameter is **10,000**. | + | instance_vnic:instance_bandwidth | String | **Definition** | + | | | | + | | | Specifies the maximum bandwidth. | + | | | | + | | | **Range** | + | | | | + | | | Maximum value: 10000 (in Mbit/s) | +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_vnic:max_count | String | Specifies the maximum number of NICs. The maximum value of this parameter is 4. | + | instance_vnic:max_count | String | **Definition** | + | | | | + | | | Specifies the maximum number of NICs. | + | | | | + | | | **Range** | + | | | | + | | | Maximum value: 4 | +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | quota:local_disk | String | The value of this parameter is in format of {type}:{count}:{size}:{safeFormat}. | + | quota:local_disk | String | **Definition** | + | | | | + | | | This field is dedicated for disk-intensive ECSs. | + | | | | + | | | **Range** | + | | | | + | | | 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: | @@ -265,18 +331,20 @@ Response | | | - **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**. | + +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | quota:nvme_ssd | String | **Definition** | | | | | - | | | .. note:: | + | | | This field is dedicated for ultra-high I/O ECSs. | | | | | - | | | This field is dedicated for disk-intensive ECSs. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | quota:nvme_ssd | String | The value of this parameter is in the format of {type}:{spec}:{num}:{size}:{safeFormat}. | + | | | **Range** | + | | | | + | | | 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. | + | | | If **spec** is set to **large**, only the I series (for example, I3) is supported. | | | | | | | | - **num** indicates the number of local disks. | | | | | @@ -284,43 +352,61 @@ Response | | | | | | | - **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. | + | | | If **safeFormat** is set to **True**, only the I series (for example, I3) is supported. | + +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ecs:generation | String | **Definition** | | | | | - | | | .. note:: | + | | | Specifies the generation of an ECS type. | | | | | - | | | This field is dedicated for ultra-high I/O ECSs. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ecs:generation | String | Specifies the generation of an ECS type. | + | | | For example, **3** in **s3** indicates the general computing III generation. For details about flavors and generations, see `ECS Specifications `__ in the *Elastic Cloud Server User Guide*. | | | | | - | | | For example, **3** in **s3** indicates the general-purpose third-generation ECSs. For details about flavors and generations, see `ECS Specifications `__ in the *Elastic Cloud Server User Guide*. | + | | | **Range** | + | | | | + | | | N/A | +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ecs:virtualization_env_types | String | Specifies a virtualization type. | + | ecs:virtualization_env_types | String | **Definition** | + | | | | + | | | Specifies a virtualization type. | + | | | | + | | | **Range** | | | | | | | | - If the parameter value is **FusionCompute**, the ECS uses Xen virtualization. Currently, the Xen virtualization technology is not supported. | | | | - If the parameter value is **CloudCompute**, the ECS uses KVM virtualization. | + +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | pci_passthrough:enable_gpu | String | **Definition** | | | | | - | | | .. note:: | + | | | Specifies whether the GPU is passthrough. | | | | | - | | | This field is optional. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | pci_passthrough:enable_gpu | String | Specifies whether the GPU is passthrough. | + | | | **Range** | | | | | | | | If the value is **true**, the GPU is passthrough. | +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | pci_passthrough:alias | String | Specifies the PCI passthrough device information in the "PCI device name:Quantity" format. Use commas (,) to separate multiple device information records. | + | pci_passthrough:alias | String | **Definition** | + | | | | + | | | Specifies the PCI passthrough device information in the "PCI device name:Quantity" format. Use commas (,) to separate multiple device information records. | | | | | | | | For example, nvidia-a30:1 indicates that the ECS has an A30 GPU attached. | + | | | | + | | | **Range** | + | | | | + | | | N/A | +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cond:operation:status | 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: | + | cond:operation:status | String | **Definition** | | | | | - | | | - **normal**: indicates normal commercial use of the flavor. | + | | | 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 specified or used, the status is **normal**. | + | | | | + | | | **Range** | + | | | | + | | | - **normal**: indicates that the flavor is commercially used. | | | | - **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 | String | This parameter takes effect AZ-wide. If an AZ is not configured in this parameter, the value of the **cond:operation:status** parameter is used by default. This parameter is in the format of "az(xx)". The value in parentheses is the flavor status in an AZ. If the parentheses are left blank, the configuration is invalid. The **cond:operation:az** options are the same as the **cond:operation:status** options. | + | cond:operation:az | String | **Definition** | + | | | | + | | | This parameter takes effect AZ-wide. If an AZ is not configured in this parameter, the value of the **cond:operation:status** parameter is used by default. This parameter is in the format of "az(xx)". The value in parentheses is the flavor status in an AZ. If the parentheses are left blank, the configuration is invalid. The **cond:operation:az** options are the same as the **cond:operation:status** options. | | | | | | | | For example, a flavor is for commercial use in AZs 0 and 3, sold out in AZ 1, for OBT in AZ 2, and is canceled in other AZs. Then, set parameters as follows: | | | | | @@ -330,24 +416,48 @@ Response | | | .. note:: | | | | | | | | Configure this parameter if the flavor status in an AZ is different from the **cond:operation:status** value. | + | | | | + | | | **Range** | + | | | | + | | | N/A | +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | quota:max_rate | String | Specifies the maximum bandwidth. | + | quota:max_rate | String | **Definition** | + | | | | + | | | Specifies the maximum bandwidth. | | | | | - | | | - Unit: Mbit/s. If a bandwidth is in the unit of Gbit/s, it must be divided by 1,000. | + | | | **Range** | + | | | | + | | | Unit: Mbit/s. If the unit is Gbit/s, the value is divided by 1000. | +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | quota:min_rate | String | Specifies the assured bandwidth. | + | quota:min_rate | String | **Definition** | + | | | | + | | | Specifies the assured bandwidth. | + | | | | + | | | **Range** | | | | | - | | | - Unit: Mbit/s. If a bandwidth is in the unit of Gbit/s, it must be divided by 1,000. | + | | | Unit: Mbit/s. If the unit is Gbit/s, the value is divided by 1000. | +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | quota:max_pps | String | Specifies the maximum intranet PPS. | + | quota:max_pps | String | **Definition** | | | | | - | | | - Unit: number. If a value is in the unit of 10,000, it must be divided by 10,000. | + | | | Specifies the maximum intranet PPS. | + | | | | + | | | **Range** | + | | | | + | | | Unit: number. If a value is in the unit of 10000, the value is divided by 10000. | +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cond:operation:charge | String | Specifies a billing type. | + | cond:operation:charge | String | **Definition** | + | | | | + | | | Specifies the billing mode. All billing modes are supported if this parameter is not specified. | | | | | - | | | - All the billing types are supported if this parameter is not set. | + | | | **Range** | + | | | | + | | | N/A | +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cond:compute | String | Specifies computing constraints. | + | cond:compute | String | **Definition** | + | | | | + | | | Specifies compute constraints. | + | | | | + | | | **Range** | | | | | | | | - **autorecovery**: indicates that automatic recovery is supported. | | | | - If this parameter does not exist, automatic recovery is not supported. | diff --git a/api-ref/source/apis_recommended/job_status_management/querying_job_execution_status.rst b/api-ref/source/apis_recommended/job_status_management/querying_job_execution_status.rst index 7a5eda9..ed20d1a 100644 --- a/api-ref/source/apis_recommended/job_status_management/querying_job_execution_status.rst +++ b/api-ref/source/apis_recommended/job_status_management/querying_job_execution_status.rst @@ -25,12 +25,41 @@ GET /v1/{project_id}/jobs/{job_id} .. table:: **Table 1** Parameter description - ========== ========= ======================================== - Parameter Mandatory Description - ========== ========= ======================================== - project_id Yes Specifies the project ID. - job_id Yes Specifies the ID of an asynchronous job. - ========== ========= ======================================== + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+========================================================================================================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------+ + | job_id | Yes | **Definition** | + | | | | + | | | Specifies the ID of an asynchronous job. It can be obtained from the response of the asynchronous job. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------+ Request ------- @@ -46,44 +75,107 @@ Response .. table:: **Table 2** Response parameters - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+======================================================================================================================================================================================================================================================================+ - | status | String | 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 | Object | Specifies the object of the job. | - | | | | - | | | The value of this parameter varies depending on the type of the job. If the job is an ECS-related operation, the value is **server_id**. If the job is a NIC operation, the value is **nic_id**. If a sub-Job is available, details about the sub-job are displayed. | - | | | | - | | | For details, see :ref:`Table 3 `. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | job_id | String | Specifies the ID of an asynchronous job. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | job_type | String | Specifies the type of an asynchronous job. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | begin_time | String | Specifies the time when the job was started. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | end_time | String | Specifies the time when the job was finished. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_code | String | 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 job execution failure. | - | | | | - | | | After the job is executed successfully, the value of this parameter is **null**. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | message | String | Specifies the error message returned when an error occurs in the request to query a job. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | code | String | Specifies the error code returned when an error occurs in the request to query a job. | - | | | | - | | | For details about the error code, see :ref:`Returned Values for General Requests `. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+========================================================================================================================================================================================+ + | status | String | **Definition** | + | | | | + | | | Specifies the job status. | + | | | | + | | | **Range** | + | | | | + | | | - **SUCCESS**: The job is successfully executed. | + | | | - **RUNNING**: The job is in progress. | + | | | - **FAIL**: The job failed. | + | | | - **INIT**: The job is being initialized. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | entities | Object | **Definition** | + | | | | + | | | Specifies the object of the job. The displayed information varies depending on what tasks are executed. For details, see :ref:`Table 3 `. | + | | | | + | | | **Range** | + | | | | + | | | - **server_id**: ECS-related operations | + | | | - **nic_id**: NIC-related operations | + | | | - If a sub-Job is available, the sub-job details are displayed. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | job_id | String | **Definition** | + | | | | + | | | Specifies the ID of an asynchronous job. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | job_type | String | **Definition** | + | | | | + | | | Specifies the type of an asynchronous job. | + | | | | + | | | **Range** | + | | | | + | | | Only some common job types are listed below. For the actual job types, see the response. | + | | | | + | | | The type is the corresponding asynchronous request API. For example: | + | | | | + | | | - createServer: ECS creation | + | | | - createSingleServer: Single ECS creation | + | | | - resizeServer: ECS resizing (specification modification) | + | | | - changeOS: OS change | + | | | - reInitOs: OS reinstallation | + | | | - attachVolume: disk attachment | + | | | - detachVolume: disk detachment | + | | | - deleteVMs: ECS deletion | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | begin_time | String | **Definition** | + | | | | + | | | Specifies the time when the job was started. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | end_time | String | **Definition** | + | | | | + | | | Specifies the time when the job was finished. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | error_code | String | **Definition** | + | | | | + | | | Specifies the returned error code when the job execution fails. | + | | | | + | | | **Range** | + | | | | + | | | After the job is executed successfully, the value of this parameter is **null**. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fail_reason | String | **Definition** | + | | | | + | | | Specifies the cause of the job execution failure. | + | | | | + | | | **Range** | + | | | | + | | | After the job is executed successfully, the value of this parameter is **null**. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | message | String | **Definition** | + | | | | + | | | Specifies the error message returned when an error occurs in the request to query a job. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | code | String | **Definition** | + | | | | + | | | Specifies the error code returned when an error occurs in the request to query a job. | + | | | | + | | | For details about the error code, see :ref:`Returned Values for General Requests `. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _en-us_topic_0022225398__table63816992163249: @@ -92,63 +184,158 @@ Response +-----------------------+-----------------------+-------------------------------------------------------------------------------+ | Parameter | Type | Description | +=======================+=======================+===============================================================================+ - | server_id | String | If the job is an ECS-related operation, the value is **server_id**. | + | server_id | String | **Definition** | + | | | | + | | | Displayed when the job is ECS-related. | + | | | | + | | | **Range** | + | | | | + | | | N/A | +-----------------------+-----------------------+-------------------------------------------------------------------------------+ - | nic_id | String | If the job is a NIC-related operation, the value is **nic_id**. | + | nic_id | String | **Definition** | + | | | | + | | | If the job is a NIC-related operation, the value is **nic_id**. | + | | | | + | | | **Range** | + | | | | + | | | N/A | +-----------------------+-----------------------+-------------------------------------------------------------------------------+ - | sub_jobs_total | Integer | Specifies the number of sub-jobs. | + | sub_jobs_total | Integer | **Definition** | + | | | | + | | | Specifies the number of sub-jobs. | + | | | | + | | | **Range** | + | | | | + | | | N/A | +-----------------------+-----------------------+-------------------------------------------------------------------------------+ - | sub_jobs | Array of objects | Specifies the execution information of a sub-job. | + | sub_jobs | Array of objects | **Definition** | + | | | | + | | | Specifies the execution information of a sub-job. | | | | | | | | For details, see :ref:`Table 4 `. | + | | | | + | | | **Range** | + | | | | + | | | N/A | +-----------------------+-----------------------+-------------------------------------------------------------------------------+ .. _en-us_topic_0022225398__table1500801817135: .. table:: **Table 4** **sub_jobs** field description - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=================================================================================================================================================================================================================================================================================================================+ - | status | String | Specifies the job status. | - | | | | - | | | - **SUCCESS**: indicates the job is successfully executed. | - | | | - **RUNNING**: indicates that the job is in progress. | - | | | - **FAIL**: indicates that the job failed. | - | | | - **INIT**: indicates that the job is being initialized. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | entities | Object | Specifies the object of the job. The value of this parameter varies depending on the type of the job. If the job is an ECS-related operation, the value is **server_id**. If the job is a NIC operation, the value is **nic_id**. For details, see :ref:`Table 5 `. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | job_id | String | Specifies the sub-job ID. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | job_type | String | Specify the sub-job type. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | begin_time | String | Specifies the time when the job was started. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | end_time | String | Specifies the time when the job was finished. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_code | String | 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 job execution failure. | - | | | | - | | | After the job is executed successfully, the value of this parameter is null. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=========================================================================================================+ + | status | String | **Definition** | + | | | | + | | | Specifies the job status. | + | | | | + | | | **Range** | + | | | | + | | | - **SUCCESS**: indicates the job is successfully executed. | + | | | - **RUNNING**: indicates that the job is in progress. | + | | | - **FAIL**: indicates that the job failed. | + | | | - **INIT**: indicates that the job is being initialized. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ + | entities | Object | **Definition** | + | | | | + | | | Specifies the object of the job. The displayed information varies depending on what tasks are executed. | + | | | | + | | | **Range** | + | | | | + | | | - **server_id**: ECS-related operations | + | | | - **nic_id**: NIC-related operations | + | | | | + | | | For details, see :ref:`Table 5 `. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ + | job_id | String | **Definition** | + | | | | + | | | Specifies the sub-job ID. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ + | job_type | String | **Definition** | + | | | | + | | | Specify the sub-job type. | + | | | | + | | | **Range** | + | | | | + | | | Only some common job types are listed below. For the actual job types, see the response. | + | | | | + | | | The type is the corresponding asynchronous request API. For example: | + | | | | + | | | - createSingleServer: Single ECS creation | + | | | - resizeServer: ECS resizing (specification modification) | + | | | - attachVolume: disk attachment | + | | | - detachVolume: disk detachment | + | | | - deleteVM: ECS deletion | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ + | begin_time | String | **Definition** | + | | | | + | | | Specifies the time when the job was started. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ + | end_time | String | **Definition** | + | | | | + | | | Specifies the time when the job was finished. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ + | error_code | String | **Definition** | + | | | | + | | | Specifies the returned error code when the job execution fails. | + | | | | + | | | **Range** | + | | | | + | | | After the job is executed successfully, the value of this parameter is null. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ + | fail_reason | String | **Definition** | + | | | | + | | | Specifies the cause of the job execution failure. | + | | | | + | | | **Range** | + | | | | + | | | After the job is executed successfully, the value of this parameter is null. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------+ .. _en-us_topic_0022225398__table2577901102930: .. table:: **Table 5** **sub_jobs.entities** field description - +-------------------+--------+---------------------------------------------------------------------+ - | Parameter | Type | Description | - +===================+========+=====================================================================+ - | server_id | String | If the job is an ECS-related operation, the value is **server_id**. | - +-------------------+--------+---------------------------------------------------------------------+ - | nic_id | String | If the job is a NIC-related operation, the value is **nic_id**. | - +-------------------+--------+---------------------------------------------------------------------+ - | errorcode_message | String | Indicates the cause of a sub-job execution failure. | - +-------------------+--------+---------------------------------------------------------------------+ + +-----------------------+-----------------------+-----------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=================================================================+ + | server_id | String | **Definition** | + | | | | + | | | Displayed when the job is ECS-related. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+-----------------------------------------------------------------+ + | nic_id | String | **Definition** | + | | | | + | | | If the job is a NIC-related operation, the value is **nic_id**. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+-----------------------------------------------------------------+ + | errorcode_message | String | **Definition** | + | | | | + | | | Specifies the cause of a sub-job execution failure. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+-----------------------------------------------------------------+ Example Request --------------- diff --git a/api-ref/source/apis_recommended/lifecycle_management/creating_ecss.rst b/api-ref/source/apis_recommended/lifecycle_management/creating_ecss.rst index eba111d..b091cbb 100644 --- a/api-ref/source/apis_recommended/lifecycle_management/creating_ecss.rst +++ b/api-ref/source/apis_recommended/lifecycle_management/creating_ecss.rst @@ -51,11 +51,25 @@ POST /v1/{project_id}/cloudservers .. table:: **Table 1** Parameter description - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= + +-----------------------+-----------------------+---------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+===========================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ Request ------- @@ -68,46 +82,46 @@ Request .. table:: **Table 2** Request parameters - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=============================================================================================================+ - | server | Yes | Object | **Definition** | - | | | | | - | | | | Specifies the ECS information. For details, see :ref:`Table 3 `. | - | | | | | - | | | | **Constraints** | - | | | | | - | | | | N/A | - | | | | | - | | | | **Range** | - | | | | | - | | | | N/A | - | | | | | - | | | | **Default Value** | - | | | | | - | | | | N/A | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------+ - | dry_run | No | Boolean | **Definition** | - | | | | | - | | | | Specifies whether to check the request. If this parameter is set to **true**, no instance is created. | - | | | | | - | | | | **Constraints** | - | | | | | - | | | | N/A | - | | | | | - | | | | **Range** | - | | | | | - | | | | - **true**: Check the request. Check items include the mandatory parameters and request format. | - | | | | | - | | | | - If the check fails, the system returns an error. | - | | | | - If the check is successful, the system returns status code 202. | - | | | | | - | | | | - **false**: Send the request without checking the request body. | - | | | | | - | | | | **Default Value** | - | | | | | - | | | | false | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=========================================================================================================================================================+ + | server | Yes | Object | **Definition** | + | | | | | + | | | | Specifies the ECS information. For details, see :ref:`Table 3 `. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dry_run | No | Boolean | **Definition** | + | | | | | + | | | | Specifies whether the system checks the request. If this parameter is set to **true**, the system checks the request, but no instances will be created. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | - **true**: The system checks the request. Check items include mandatory parameters and request format. | + | | | | | + | | | | - If the check fails, the system returns an error. | + | | | | - If the check is successful, the system returns status code 202. | + | | | | | + | | | | - **false**: The system sends the request without checking the request body. | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | false | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _en-us_topic_0020212668__table761103195216: @@ -582,7 +596,7 @@ Request +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | extra_dhcp_opts | No | Array of objects | **Definition** | | | | | | - | | | | Indicates extended DHCP options. For details, see :ref:`Table 13 `. | + | | | | Specifies extended DHCP options. For details, see :ref:`Table 13 `. | | | | | | | | | | **Constraints** | | | | | | @@ -651,20 +665,19 @@ Request | | | | | | | | | - When the disk is created from a backup: | | | | | | - | | | | If the type of the backup's source disk is **SSD**, **SAS**, **SATA**, **GPSSD**, **ESSD**, or **GPSSD2**, you can create disks of any of these types. | + | | | | If the type of the backup's source disk is **SSD**, **SAS**, **SATA**, **GPSSD**, or **ESSD**, you can create disks of any of these types. | | | | | | | | | | If the type of the backup's source disk is **co-p1** or **uh-l1**, you can create disks of any of the two types. | | | | | | | | | | **Range** | | | | | | - | | | | The value can be **ESSD**, **GPSSD2**, **GPSSD**, **SSD**, **SAS**, or **SATA**. | + | | | | The value can be **ESSD**, **GPSSD**, **SSD**, **SAS**, or **SATA**. | | | | | | | | | | - **SSD**: the ultra-high I/O type | | | | | - **SAS**: the high I/O type | | | | | - **SATA**: the common I/O type (end-of-sale) | | | | | - **GPSSD**: the general purpose SSD type | | | | | - **ESSD**: the extreme SSD type | - | | | | - **GPSSD2**: the general purpose SSD V2 type | | | | | | | | | | **Default Value** | | | | | | @@ -746,20 +759,19 @@ Request | | | | | | | | | - When the disk is created from a backup: | | | | | | - | | | | If the type of the backup's source disk is **SSD**, **SAS**, **SATA**, **GPSSD**, **ESSD**, or **GPSSD2**, you can create disks of any of these types. | + | | | | If the type of the backup's source disk is **SSD**, **SAS**, **SATA**, **GPSSD**, or **ESSD**, you can create disks of any of these types. | | | | | | | | | | If the type of the backup's source disk is **co-p1** or **uh-l1**, you can create disks of any of the two types. | | | | | | | | | | **Range** | | | | | | - | | | | The value can be **ESSD**, **GPSSD2**, **GPSSD**, **SSD**, **SAS**, or **SATA**. | + | | | | The value can be **ESSD**, **GPSSD**, **SSD**, **SAS**, or **SATA**. | | | | | | | | | | - **SSD**: the ultra-high I/O type | | | | | - **SAS**: the high I/O type | | | | | - **SATA**: the common I/O type (end-of-sale) | | | | | - **GPSSD**: the general purpose SSD type | | | | | - **ESSD**: the extreme SSD type | - | | | | - **GPSSD2**: the general purpose SSD V2 type | | | | | | | | | | **Default Value** | | | | | | diff --git a/api-ref/source/apis_recommended/lifecycle_management/deleting_ecss.rst b/api-ref/source/apis_recommended/lifecycle_management/deleting_ecss.rst index 18bf3ec..e32db3d 100644 --- a/api-ref/source/apis_recommended/lifecycle_management/deleting_ecss.rst +++ b/api-ref/source/apis_recommended/lifecycle_management/deleting_ecss.rst @@ -25,11 +25,25 @@ POST /v1/{project_id}/cloudservers/delete .. table:: **Table 1** Parameter description - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= + +-----------------------+-----------------------+---------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+===========================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ Request ------- diff --git a/api-ref/source/apis_recommended/lifecycle_management/listing_details_about_ecss.rst b/api-ref/source/apis_recommended/lifecycle_management/listing_details_about_ecss.rst index 5e7da4e..2d76a85 100644 --- a/api-ref/source/apis_recommended/lifecycle_management/listing_details_about_ecss.rst +++ b/api-ref/source/apis_recommended/lifecycle_management/listing_details_about_ecss.rst @@ -23,11 +23,25 @@ GET /v1/{project_id}/cloudservers/detail?flavor={flavor}&name={name}&status={sta .. table:: **Table 1** Path parameters - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= + +-----------------------+-----------------------+---------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+===========================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ .. table:: **Table 2** Query parameters @@ -40,19 +54,17 @@ GET /v1/{project_id}/cloudservers/detail?flavor={flavor}&name={name}&status={sta | | | | | | | | | **Constraints** | | | | | | - | | | | The value must be greater than or equal to **0** and the default value is **1**. | - | | | | | | | | | If the value is **0**, the first page is displayed, which is the same as the value **1**. | | | | | | | | | | You are advised to set this parameter to a value greater than or equal to 1. | | | | | | | | | | **Range** | | | | | | - | | | | N/A | + | | | | >= 0 | | | | | | | | | | **Default Value** | | | | | | - | | | | N/A | + | | | | 1 | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | flavor | No | String | **Definition** | | | | | | @@ -82,7 +94,7 @@ GET /v1/{project_id}/cloudservers/detail?flavor={flavor}&name={name}&status={sta | | | | | | | | | **Range** | | | | | | - | | | | Periods (.) are supported to match any single characters except \\n and \\r. A period is equal to [^\\n\\r]. | + | | | | 1 to 128 characters, including letters, digits, underscores (_), hyphens (-), and periods (.) | | | | | | | | | | **Default Value** | | | | | | @@ -283,8 +295,8 @@ Response | | | | | | | **Range** | | | | | - | | | - The key indicates the network name, for example, **demo_net**. | - | | | - The value indicates the network attribute specified in :ref:`Table 5 `. | + | | | - The key is **vpc_id**. | + | | | - The value is a network attribute specified in :ref:`Table 5 `. | +--------------------------------------+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | key_name | String | **Definition** | | | | | diff --git a/api-ref/source/apis_recommended/lifecycle_management/modifying_ecs_details.rst b/api-ref/source/apis_recommended/lifecycle_management/modifying_ecs_details.rst index a8cafa1..4acfb3a 100644 --- a/api-ref/source/apis_recommended/lifecycle_management/modifying_ecs_details.rst +++ b/api-ref/source/apis_recommended/lifecycle_management/modifying_ecs_details.rst @@ -26,12 +26,41 @@ PUT /v1/{project_id}/cloudservers/{server_id} .. table:: **Table 1** Parameter description - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= + +-----------------------+-----------------------+---------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+===========================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ + | server_id | Yes | **Definition** | + | | | | + | | | Specifies the ECS ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ Request ------- diff --git a/api-ref/source/apis_recommended/lifecycle_management/querying_details_about_an_ecs.rst b/api-ref/source/apis_recommended/lifecycle_management/querying_details_about_an_ecs.rst index 3176c31..c446bc3 100644 --- a/api-ref/source/apis_recommended/lifecycle_management/querying_details_about_an_ecs.rst +++ b/api-ref/source/apis_recommended/lifecycle_management/querying_details_about_an_ecs.rst @@ -23,12 +23,41 @@ GET /v1/{project_id}/cloudservers/{server_id} .. table:: **Table 1** Parameter description - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= + +-----------------------+-----------------------+---------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+===========================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ + | server_id | Yes | **Definition** | + | | | | + | | | Specifies the ECS ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ Request ------- diff --git a/api-ref/source/apis_recommended/metadata_management/updating_ecs_metadata.rst b/api-ref/source/apis_recommended/metadata_management/updating_ecs_metadata.rst index b012b09..513fe39 100644 --- a/api-ref/source/apis_recommended/metadata_management/updating_ecs_metadata.rst +++ b/api-ref/source/apis_recommended/metadata_management/updating_ecs_metadata.rst @@ -10,8 +10,8 @@ Function This API is used to update ECS metadata. -- If the metadata does not contain the target field, the field is automatically added. -- If the metadata contains the target field, the field value is automatically updated. +- If the metadata does not contain the field to be updated, the field is automatically added. +- If the metadata contains the field to be updated, the field value is automatically updated. - If the field in the metadata is not requested, the field value remains unchanged. .. note:: @@ -30,44 +30,86 @@ POST /v1/{project_id}/cloudservers/{server_id}/metadata .. table:: **Table 1** Parameter description - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= + +-----------------------+-----------------------+---------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+===========================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ + | server_id | Yes | **Definition** | + | | | | + | | | Specifies the ECS ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ Request ------- .. table:: **Table 2** Request parameters - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+========================================================================================================================================================================================================================+ - | metadata | Yes | Object | Specifies the user-defined metadata key-value pair. | - | | | | | - | | | | The data structure can be empty. If the value is empty, data is not updated. | - | | | | | - | | | | For a metadata tag: | - | | | | | - | | | | It contains a maximum of 255 Unicode characters and cannot be left blank. A tag can contain uppercase letters (A-Z), lowercase letters (a-z), digits (0-9), hyphens (-), underscores (_), colons (:), and periods (.). | - | | | | | - | | | | For a metadata value: | - | | | | | - | | | | It contains a maximum of 255 Unicode characters. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+====================+=========================================================================================================================================================================================+ + | metadata | Yes | Map | **Definition** | + | | | | | + | | | | This API is used to update ECS metadata. | + | | | | | + | | | | You can use metadata to customize key-value pairs. For details about reserved key-value pairs, see :ref:`Table 9 `. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | If the metadata contains sensitive data, take appropriate measures to protect the sensitive data, for example, controlling access permissions and encrypting the data. | + | | | | | + | | | | **Range** | + | | | | | + | | | | - A metadata key consists of 1 to 255 characters and can only contain uppercase letters, lowercase letters, digits, spaces, hyphens (-), underscores (_), colons (:), and periods (.). | + | | | | - A metadata value consists of a maximum of 255 characters. | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response -------- .. table:: **Table 3** Parameter description - ========= ====== =================================================== - Parameter Type Description - ========= ====== =================================================== - metadata Object Specifies the user-defined metadata key-value pair. - ========= ====== =================================================== + +-----------------------+-----------------------+-----------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=====================================================+ + | metadata | Object | **Definition** | + | | | | + | | | Specifies the user-defined metadata key-value pair. | + | | | | + | | | **Range** | + | | | | + | | | N/A | + +-----------------------+-----------------------+-----------------------------------------------------+ Example Request --------------- diff --git a/api-ref/source/apis_recommended/nic_management/adding_nics_to_an_ecs_in_a_batch.rst b/api-ref/source/apis_recommended/nic_management/adding_nics_to_an_ecs_in_a_batch.rst index 68113e3..1a8d2a6 100644 --- a/api-ref/source/apis_recommended/nic_management/adding_nics_to_an_ecs_in_a_batch.rst +++ b/api-ref/source/apis_recommended/nic_management/adding_nics_to_an_ecs_in_a_batch.rst @@ -28,12 +28,41 @@ POST /v1/{project_id}/cloudservers/{server_id}/nics .. table:: **Table 1** Parameter description - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= + +-----------------------+-----------------------+---------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+===========================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ + | server_id | Yes | **Definition** | + | | | | + | | | Specifies the ECS ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ Request ------- @@ -44,11 +73,25 @@ Request .. table:: **Table 2** Request parameters - +-----------+-----------+------------------+----------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+==================+==========================================================================================================+ - | nics | Yes | Array of objects | Specifies the NICs to be added. For details, see :ref:`Table 3 `. | - +-----------+-----------+------------------+----------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+==================+==========================================================================================================+ + | nics | Yes | Array of objects | **Definition** | + | | | | | + | | | | Specifies the NICs to be added. For details, see :ref:`Table 3 `. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------+ .. _en-us_topic_0020212663__table58396974: @@ -57,30 +100,112 @@ Request +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +=================+=================+==================+=============================================================================================================================================+ - | subnet_id | Yes | String | Specifies the information about the NICs to be added to an ECS. | + | subnet_id | Yes | String | **Definition** | + | | | | | + | | | | Specifies the information about the NICs to be added to an ECS. | | | | | | | | | | The value must be the ID of a created network in UUID format. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | security_groups | No | Array of objects | Specifies the security groups for NICs. For details, see :ref:`Table 4 `. | + | security_groups | No | Array of objects | **Definition** | + | | | | | + | | | | Specifies the security groups for NICs. For details, see :ref:`Table 4 `. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_address | No | String | Specifies the IP address. If this parameter is unavailable, the IP address is automatically assigned. | + | ip_address | No | String | **Definition** | + | | | | | + | | | | Specifies the IP address. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | If this parameter is empty, the IP address is automatically assigned. | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | ipv6_enable | No | Boolean | Indicates whether to support IPv6 addresses. | + | ipv6_enable | No | Boolean | **Definition** | + | | | | | + | | | | Specifies whether IPv6 is supported. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | If this parameter is set to **true**, the NIC supports IPv6. | | | | | | - | | | | If this parameter is set to **true**, the NIC supports IPv6 addresses. | + | | | | **Default Value** | + | | | | | + | | | | N/A | +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | ipv6_bandwidth | No | Object | Specifies the bound shared bandwidth. For details, see :ref:`ipv6_bandwidth Field Description `. | + | ipv6_bandwidth | No | Object | **Definition** | + | | | | | + | | | | Specifies the bound shared bandwidth. For details, see :ref:`ipv6_bandwidth Field Description `. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ .. _en-us_topic_0020212663__table16100147: .. table:: **Table 4** **security_groups** field description - ========= ========= ====== ======================================= - Parameter Mandatory Type Description - ========= ========= ====== ======================================= - id Yes String Specifies the ID of the security group. - ========= ========= ====== ======================================= + +-----------------+-----------------+-----------------+-----------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=========================================+ + | id | Yes | String | **Definition** | + | | | | | + | | | | Specifies the ID of the security group. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+-----------------+-----------------------------------------+ Response -------- diff --git a/api-ref/source/apis_recommended/nic_management/deleting_nics_from_an_ecs_in_a_batch.rst b/api-ref/source/apis_recommended/nic_management/deleting_nics_from_an_ecs_in_a_batch.rst index 766197e..f6380b2 100644 --- a/api-ref/source/apis_recommended/nic_management/deleting_nics_from_an_ecs_in_a_batch.rst +++ b/api-ref/source/apis_recommended/nic_management/deleting_nics_from_an_ecs_in_a_batch.rst @@ -28,12 +28,41 @@ POST /v1/{project_id}/cloudservers/{server_id}/nics/delete .. table:: **Table 1** Parameter description - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= + +-----------------------+-----------------------+---------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+===========================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ + | server_id | Yes | **Definition** | + | | | | + | | | Specifies the ECS ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ Request ------- @@ -44,11 +73,25 @@ Request .. table:: **Table 2** Request parameters - +-----------+-----------+------------------+------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+==================+============================================================================================================+ - | nics | Yes | Array of objects | Specifies the NICs to be deleted. For details, see :ref:`Table 3 `. | - +-----------+-----------+------------------+------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+==================+============================================================================================================+ + | nics | Yes | Array of objects | **Definition** | + | | | | | + | | | | Specifies the NICs to be deleted. For details, see :ref:`Table 3 `. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------+ .. _en-us_topic_0020212665__table43212049: @@ -57,11 +100,25 @@ Request +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +=================+=================+=================+==============================================================================================+ - | id | Yes | String | Specifies the port ID of the NIC. | + | id | Yes | String | **Definition** | + | | | | | + | | | | Specifies the port ID of the NIC. | | | | | | | | | | .. note:: | | | | | | | | | | When the ID is the same as the ECS primary NIC ID, the system will return error code 403. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------+ Response diff --git a/api-ref/source/apis_recommended/nic_management/index.rst b/api-ref/source/apis_recommended/nic_management/index.rst index a6f2e41..c79c723 100644 --- a/api-ref/source/apis_recommended/nic_management/index.rst +++ b/api-ref/source/apis_recommended/nic_management/index.rst @@ -8,6 +8,7 @@ NIC Management - :ref:`Adding NICs to an ECS in a Batch ` - :ref:`Deleting NICs from an ECS in a Batch ` - :ref:`Listing NICs of an ECS ` +- :ref:`Updating NIC Attachment Information of an ECS ` .. toctree:: :maxdepth: 1 @@ -16,3 +17,4 @@ NIC Management adding_nics_to_an_ecs_in_a_batch deleting_nics_from_an_ecs_in_a_batch listing_nics_of_an_ecs + updating_nic_attachment_information_of_an_ecs diff --git a/api-ref/source/apis_recommended/nic_management/listing_nics_of_an_ecs.rst b/api-ref/source/apis_recommended/nic_management/listing_nics_of_an_ecs.rst index 6b833b0..41e6126 100644 --- a/api-ref/source/apis_recommended/nic_management/listing_nics_of_an_ecs.rst +++ b/api-ref/source/apis_recommended/nic_management/listing_nics_of_an_ecs.rst @@ -21,12 +21,41 @@ GET /v1/{project_id}/cloudservers/{server_id}/os-interface .. table:: **Table 1** Parameter description - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= + +-----------------------+-----------------------+---------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+===========================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ + | server_id | Yes | **Definition** | + | | | | + | | | Specifies the ECS ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ Request ------- @@ -75,7 +104,9 @@ Response | | | | | | | **Range** | | | | | - | | | N/A | + | | | - **ACTIVE** | + | | | - **BUILD** | + | | | - **DOWN** | +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------+ | fixed_ips | Array of objects | **Definition** | | | | | diff --git a/api-ref/source/apis_recommended/nic_management/updating_nic_attachment_information_of_an_ecs.rst b/api-ref/source/apis_recommended/nic_management/updating_nic_attachment_information_of_an_ecs.rst new file mode 100644 index 0000000..977a124 --- /dev/null +++ b/api-ref/source/apis_recommended/nic_management/updating_nic_attachment_information_of_an_ecs.rst @@ -0,0 +1,162 @@ +:original_name: en-us_topic_0230783964.html + +.. _en-us_topic_0230783964: + +Updating NIC Attachment Information of an ECS +============================================= + +Function +-------- + +This API is used to update the NIC attachment information of an ECS. Currently, only **delete_on_termination** can be updated. + +URI +--- + +PUT /v1/{project_id}/cloudservers/{server_id}/os-interface/{port_id} + +:ref:`Table 1 ` describes the parameters in the URI. + +.. _en-us_topic_0230783964__table15447181641516: + +.. table:: **Table 1** Parameter description + + +-----------------------+-----------------------+---------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+===========================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ + | server_id | Yes | **Definition** | + | | | | + | | | Specifies the ECS ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ + | port_id | Yes | **Definition** | + | | | | + | | | Specifies the NIC ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ + +Request +------- + +:ref:`Table 2 ` describes the request parameters. + +.. _en-us_topic_0230783964__table184471161152: + +.. table:: **Table 2** Request parameters + + +----------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +======================+=================+=================+===================================================================================================================================================+ + | interface_attachment | Yes | Object | **Definition** | + | | | | | + | | | | Specifies the structure of the ECS NIC information to be updated. For details, see :ref:`Table 3 `. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +----------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _en-us_topic_0230783964__table144481416121516: + +.. table:: **Table 3** **interface_attachment** data structure + + +-----------------------+-----------------+-----------------+------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+=================+=================+======================================================+ + | delete_on_termination | Yes | Boolean | **Definition** | + | | | | | + | | | | Specifies whether to delete a NIC when detaching it. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | - **true**: Delete the NIC. | + | | | | - **false**: Do not delete the NIC. | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------------+-----------------+-----------------+------------------------------------------------------+ + +Response +-------- + +None + +Example Request +--------------- + +.. code-block:: text + + PUT https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/os-interface/{port_id} + + { + "interface_attachment": + { + "delete_on_termination": true + } + } + +Example Response +---------------- + +None + +Returned Values +--------------- + +For details, see :ref:`Returned Values for General Requests `. + +Error Codes +----------- + +For details, see :ref:`Error Codes `. diff --git a/api-ref/source/apis_recommended/status_management/changing_an_ecs_os_using_an_image_with_cloud-init_installed.rst b/api-ref/source/apis_recommended/status_management/changing_an_ecs_os_using_an_image_with_cloud-init_installed.rst index 02b352d..78aef92 100644 --- a/api-ref/source/apis_recommended/status_management/changing_an_ecs_os_using_an_image_with_cloud-init_installed.rst +++ b/api-ref/source/apis_recommended/status_management/changing_an_ecs_os_using_an_image_with_cloud-init_installed.rst @@ -33,12 +33,41 @@ POST /v2/{project_id}/cloudservers/{server_id}/changeos .. table:: **Table 1** Parameter description - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= + +-----------------------+-----------------------+---------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+===========================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ + | server_id | Yes | **Definition** | + | | | | + | | | Specifies the ECS ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ Request ------- diff --git a/api-ref/source/apis_recommended/status_management/cold_migrating_an_ecs.rst b/api-ref/source/apis_recommended/status_management/cold_migrating_an_ecs.rst index 24e10b5..d1b6717 100644 --- a/api-ref/source/apis_recommended/status_management/cold_migrating_an_ecs.rst +++ b/api-ref/source/apis_recommended/status_management/cold_migrating_an_ecs.rst @@ -21,7 +21,7 @@ This API is an asynchronous API. After the cold migration request is successfull Constraints ----------- -- Currently, this API applies only to dedicated hosts. +- Currently, this API only applies to dedicated hosts. - Only a stopped ECS can be cold migrated. - Existing constraints of the native cold migration API are inherited. @@ -36,12 +36,41 @@ POST /v1/{project_id}/cloudservers/{server_id}/migrate .. table:: **Table 1** Parameter description - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= + +-----------------------+-----------------------+---------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+===========================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ + | server_id | Yes | **Definition** | + | | | | + | | | Specifies the ECS ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ Request ------- diff --git a/api-ref/source/apis_recommended/status_management/modifying_the_specifications_of_an_ecs.rst b/api-ref/source/apis_recommended/status_management/modifying_the_specifications_of_an_ecs.rst index 30167bd..e4b3641 100644 --- a/api-ref/source/apis_recommended/status_management/modifying_the_specifications_of_an_ecs.rst +++ b/api-ref/source/apis_recommended/status_management/modifying_the_specifications_of_an_ecs.rst @@ -30,12 +30,41 @@ POST /v1/{project_id}/cloudservers/{server_id}/resize .. table:: **Table 1** Parameter description - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= + +-----------------------+-----------------------+---------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+===========================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ + | server_id | Yes | **Definition** | + | | | | + | | | Specifies the ECS ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ Request ------- @@ -46,46 +75,46 @@ Request .. table:: **Table 2** Request parameters - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===============================================================================================================================+ - | resize | Yes | Object | **Definition** | - | | | | | - | | | | Specifies the operation to modify ECS specifications. For details, see :ref:`Table 3 `. | - | | | | | - | | | | **Constraints** | - | | | | | - | | | | N/A | - | | | | | - | | | | **Range** | - | | | | | - | | | | N/A | - | | | | | - | | | | **Default Value** | - | | | | | - | | | | N/A | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------+ - | dry_run | No | Boolean | **Definition** | - | | | | | - | | | | Specifies whether to check the request. If this parameter is set to **true**, no instance is created. | - | | | | | - | | | | **Constraints** | - | | | | | - | | | | N/A | - | | | | | - | | | | **Range** | - | | | | | - | | | | - **true**: Check the request. Check items include the mandatory parameters and request format. | - | | | | | - | | | | - If the check fails, the system returns an error. | - | | | | - If the check is successful, the system returns status code 202. | - | | | | | - | | | | - **false**: Send the request without checking the request body. | - | | | | | - | | | | **Default Value** | - | | | | | - | | | | false | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=========================================================================================================================================================+ + | resize | Yes | Object | **Definition** | + | | | | | + | | | | Specifies the operation to modify ECS specifications. For details, see :ref:`Table 3 `. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dry_run | No | Boolean | **Definition** | + | | | | | + | | | | Specifies whether the system checks the request. If this parameter is set to **true**, the system checks the request, but no instances will be created. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | - **true**: The system checks the request. Check items include mandatory parameters and request format. | + | | | | | + | | | | - If the check fails, the system returns an error. | + | | | | - If the check is successful, the system returns status code 202. | + | | | | | + | | | | - **false**: The system sends the request without checking the request body. | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | false | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _en-us_topic_0020212653__table7657338: diff --git a/api-ref/source/apis_recommended/status_management/reinstalling_an_ecs_os_using_an_image_with_cloud-init_installed.rst b/api-ref/source/apis_recommended/status_management/reinstalling_an_ecs_os_using_an_image_with_cloud-init_installed.rst index 402119e..b250281 100644 --- a/api-ref/source/apis_recommended/status_management/reinstalling_an_ecs_os_using_an_image_with_cloud-init_installed.rst +++ b/api-ref/source/apis_recommended/status_management/reinstalling_an_ecs_os_using_an_image_with_cloud-init_installed.rst @@ -33,12 +33,41 @@ POST /v2/{project_id}/cloudservers/{server_id}/reinstallos .. table:: **Table 1** Parameter description - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= + +-----------------------+-----------------------+---------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+===========================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ + | server_id | Yes | **Definition** | + | | | | + | | | Specifies the ECS ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ Request ------- diff --git a/api-ref/source/apis_recommended/tag_management/adding_tags_to_an_ecs_in_a_batch.rst b/api-ref/source/apis_recommended/tag_management/adding_tags_to_an_ecs_in_a_batch.rst index 2d51dee..a1edbad 100644 --- a/api-ref/source/apis_recommended/tag_management/adding_tags_to_an_ecs_in_a_batch.rst +++ b/api-ref/source/apis_recommended/tag_management/adding_tags_to_an_ecs_in_a_batch.rst @@ -33,12 +33,41 @@ POST /v1/{project_id}/cloudservers/{server_id}/tags/action .. table:: **Table 1** Parameter description - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= + +-----------------------+-----------------------+---------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+===========================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ + | server_id | Yes | **Definition** | + | | | | + | | | Specifies the ECS ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ Request ------- @@ -49,34 +78,83 @@ Request .. table:: **Table 2** Request parameters - +-----------+-----------+------------------+----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+==================+============================================================================================================================+ - | tags | Yes | Array of objects | Specifies tags. For details, see :ref:`Table 3 `. | - +-----------+-----------+------------------+----------------------------------------------------------------------------------------------------------------------------+ - | action | Yes | String | Specifies the operation. (Only lowercase letters are supported.) For example, **create** indicates the creation operation. | - +-----------+-----------+------------------+----------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+==================+===============================================================================================+ + | tags | Yes | Array of objects | **Definition** | + | | | | | + | | | | Specifies tags. For details, see :ref:`Table 3 `. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------+ + | action | Yes | String | **Definition** | + | | | | | + | | | | Specifies the operation identifier. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | Only lowercase letters are supported. | + | | | | | + | | | | **Range** | + | | | | | + | | | | create | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------+ .. _en-us_topic_0167811963__table1534514266207: .. table:: **Table 3** **tags** field description - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===========================================================================+ - | key | Yes | String | Specifies the tag key. | - | | | | | - | | | | - Cannot be left blank. | - | | | | - Must be unique for each resource. | - | | | | - Contains a maximum of 36 characters. | - | | | | - Can only consist of digits, letters, hyphens (-), and underscores (_). | - | | | | - Must be unique and cannot be left blank. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------+ - | value | No | String | Specifies the tag value. | - | | | | | - | | | | - Contains a maximum of 43 characters. | - | | | | - Can only consist of digits, letters, hyphens (-), and underscores (_). | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================+ + | key | Yes | String | **Definition** | + | | | | | + | | | | Specifies the tag key. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | - A maximum of 36 characters are supported. | + | | | | - Only letters, digits, hyphens (-), and underscores (_) are supported. | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------+ + | value | No | String | **Definition** | + | | | | | + | | | | Specifies the tag value. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | - A maximum of 43 characters are supported. | + | | | | - Only letters, digits, hyphens (-), and underscores (_) are supported. | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------+ Response -------- diff --git a/api-ref/source/apis_recommended/tag_management/deleting_tags_from_an_ecs_in_a_batch.rst b/api-ref/source/apis_recommended/tag_management/deleting_tags_from_an_ecs_in_a_batch.rst index 793f813..b05c4ca 100644 --- a/api-ref/source/apis_recommended/tag_management/deleting_tags_from_an_ecs_in_a_batch.rst +++ b/api-ref/source/apis_recommended/tag_management/deleting_tags_from_an_ecs_in_a_batch.rst @@ -31,12 +31,41 @@ POST /v1/{project_id}/cloudservers/{server_id}/tags/action .. table:: **Table 1** Parameter description - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= + +-----------------------+-----------------------+---------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+===========================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ + | server_id | Yes | **Definition** | + | | | | + | | | Specifies the ECS ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ Request ------- @@ -47,31 +76,85 @@ Request .. table:: **Table 2** Request parameters - +-----------+-----------+------------------+----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+==================+============================================================================================================================+ - | tags | Yes | Array of objects | Specifies tags. For details, see :ref:`Table 3 `. | - +-----------+-----------+------------------+----------------------------------------------------------------------------------------------------------------------------+ - | action | Yes | String | Specifies the operation. (Only lowercase letters are supported.) For example, **delete** indicates the deletion operation. | - +-----------+-----------+------------------+----------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+==================+===============================================================================================+ + | tags | Yes | Array of objects | **Definition** | + | | | | | + | | | | Specifies tags. For details, see :ref:`Table 3 `. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------+ + | action | Yes | String | **Definition** | + | | | | | + | | | | Specifies the operation identifier. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | Only lowercase letters are supported. | + | | | | | + | | | | **Range** | + | | | | | + | | | | delete | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------+ .. _en-us_topic_0167811964__table6449181462417: .. table:: **Table 3** **tags** field description - +-----------------+-----------------+-----------------+---------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=======================================+ - | key | Yes | String | Specifies the tag key. | - | | | | | - | | | | This field cannot be left blank. | - | | | | | - | | | | The tag key of an ECS must be unique. | - +-----------------+-----------------+-----------------+---------------------------------------+ - | value | No | String | Specifies the tag value. | - | | | | | - | | | | This field can be left blank. | - +-----------------+-----------------+-----------------+---------------------------------------+ + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================+ + | key | Yes | String | **Definition** | + | | | | | + | | | | Specifies the tag key. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | - A maximum of 36 characters are supported. | + | | | | - Only letters, digits, hyphens (-), and underscores (_) are supported. | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------+ + | value | No | String | **Definition** | + | | | | | + | | | | Specifies the tag value. | + | | | | | + | | | | This field can be left blank. | + | | | | | + | | | | **Constraints** | + | | | | | + | | | | N/A | + | | | | | + | | | | **Range** | + | | | | | + | | | | - A maximum of 43 characters are supported. | + | | | | - Only letters, digits, hyphens (-), and underscores (_) are supported. | + | | | | | + | | | | **Default Value** | + | | | | | + | | | | N/A | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------+ Response -------- diff --git a/api-ref/source/apis_recommended/tag_management/listing_project_tags.rst b/api-ref/source/apis_recommended/tag_management/listing_project_tags.rst index a586abd..f05307c 100644 --- a/api-ref/source/apis_recommended/tag_management/listing_project_tags.rst +++ b/api-ref/source/apis_recommended/tag_management/listing_project_tags.rst @@ -23,11 +23,25 @@ GET /v1/{project_id}/cloudservers/tags .. table:: **Table 1** Parameter description - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= + +-----------------------+-----------------------+---------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+===========================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ Request ------- @@ -43,30 +57,46 @@ Response .. table:: **Table 2** Response parameters - +-----------+------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+==================+================================================================================================================================+ - | tags | Array of objects | Specifies the tag list. For details, see :ref:`Table 3 `. | - +-----------+------------------+--------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+================================================================================================================================+ + | tags | Array of objects | **Definition** | + | | | | + | | | Specifies the tag list. For details, see :ref:`Table 3 `. | + | | | | + | | | **Range** | + | | | | + | | | A maximum of 10 tags are supported. They cannot start with \_sys_. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ .. _en-us_topic_0167811966__en-us_topic_0102606094_table207611141174713: .. table:: **Table 3** **tag** field description - +-----------------------+-----------------------+---------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===========================================================================+ - | key | String | Specifies the tag key. | - | | | | - | | | - Contains a maximum of 36 Unicode characters. | - | | | - Can only consist of digits, letters, hyphens (-), and underscores (_). | - +-----------------------+-----------------------+---------------------------------------------------------------------------+ - | values | Array of strings | Specifies the tag value. | - | | | | - | | | - Contains a maximum of 43 Unicode characters. | - | | | - Can be left blank. | - | | | - Can only consist of digits, letters, hyphens (-), and underscores (_). | - +-----------------------+-----------------------+---------------------------------------------------------------------------+ + +-----------------------+-----------------------+--------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+==========================================================================+ + | key | String | **Definition** | + | | | | + | | | Specifies the tag key. | + | | | | + | | | **Range** | + | | | | + | | | - It cannot be left blank. | + | | | - It must be unique for each resource. | + | | | - A maximum of 36 characters are supported. | + | | | - Only letters, digits, hyphens (-), and underscores (_) are supported. | + +-----------------------+-----------------------+--------------------------------------------------------------------------+ + | values | Array of strings | **Definition** | + | | | | + | | | Specifies the tag value. | + | | | | + | | | **Range** | + | | | | + | | | - Can be left blank. | + | | | - A maximum of 43 characters are supported. | + | | | - Only letters, digits, hyphens (-), and underscores (_) are supported. | + +-----------------------+-----------------------+--------------------------------------------------------------------------+ Example Request --------------- diff --git a/api-ref/source/apis_recommended/tag_management/querying_tags_of_an_ecs.rst b/api-ref/source/apis_recommended/tag_management/querying_tags_of_an_ecs.rst index d266ac0..4a59dce 100644 --- a/api-ref/source/apis_recommended/tag_management/querying_tags_of_an_ecs.rst +++ b/api-ref/source/apis_recommended/tag_management/querying_tags_of_an_ecs.rst @@ -22,12 +22,41 @@ GET /v1/{project_id}/cloudservers/{server_id}/tags .. table:: **Table 1** Parameter description - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= + +-----------------------+-----------------------+---------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+===========================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ + | server_id | Yes | **Definition** | + | | | | + | | | Specifies the ECS ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ Request ------- @@ -43,22 +72,46 @@ Response .. table:: **Table 2** Response parameters - +-----------+------------------+-----------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+==================+===============================================================================================+ - | tags | Array of objects | Specifies tags. For details, see :ref:`Table 3 `. | - +-----------+------------------+-----------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+===============================================================================================+ + | tags | Array of objects | **Definition** | + | | | | + | | | Specifies tags. For details, see :ref:`Table 3 `. | + | | | | + | | | **Range** | + | | | | + | | | A maximum of 10 tags are supported. They cannot start with \_sys_. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------+ .. _en-us_topic_0167811967__table1148911211295: .. table:: **Table 3** **tags** field description - ========= ====== ======================== - Parameter Type Description - ========= ====== ======================== - key String Specifies the tag key. - value String Specifies the tag value. - ========= ====== ======================== + +-----------------------+-----------------------+--------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+==========================================================================+ + | key | String | **Definition** | + | | | | + | | | Specifies the tag key. | + | | | | + | | | **Range** | + | | | | + | | | - It cannot be left blank. | + | | | - It must be unique for each resource. | + | | | - A maximum of 36 characters are supported. | + | | | - Only letters, digits, hyphens (-), and underscores (_) are supported. | + +-----------------------+-----------------------+--------------------------------------------------------------------------+ + | value | String | **Definition** | + | | | | + | | | Specifies the tag value. | + | | | | + | | | **Range** | + | | | | + | | | - Can be left blank. | + | | | - A maximum of 43 characters are supported. | + | | | - Only letters, digits, hyphens (-), and underscores (_) are supported. | + +-----------------------+-----------------------+--------------------------------------------------------------------------+ Example Request --------------- diff --git a/api-ref/source/apis_recommended/tenant_quota_management/querying_tenant_quotas.rst b/api-ref/source/apis_recommended/tenant_quota_management/querying_tenant_quotas.rst index 50451c1..7b5f1fe 100644 --- a/api-ref/source/apis_recommended/tenant_quota_management/querying_tenant_quotas.rst +++ b/api-ref/source/apis_recommended/tenant_quota_management/querying_tenant_quotas.rst @@ -21,11 +21,25 @@ GET /v1/{project_id}/cloudservers/limits .. table:: **Table 1** Parameter description - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= + +-----------------------+-----------------------+---------------------------+ + | Parameter | Mandatory | Description | + +=======================+=======================+===========================+ + | project_id | Yes | **Definition** | + | | | | + | | | Specifies the project ID. | + | | | | + | | | **Constraints** | + | | | | + | | | N/A | + | | | | + | | | **Range** | + | | | | + | | | N/A | + | | | | + | | | **Default Value** | + | | | | + | | | N/A | + +-----------------------+-----------------------+---------------------------+ Request ------- diff --git a/api-ref/source/appendix/ecs_statuses.rst b/api-ref/source/appendix/ecs_statuses.rst index c62f95a..c8e8d02 100644 --- a/api-ref/source/appendix/ecs_statuses.rst +++ b/api-ref/source/appendix/ecs_statuses.rst @@ -16,7 +16,7 @@ An ECS can be in one of the following statuses specified in ECS APIs: +-------------------+---------------------------------------------------------------------------------------------------------+ | Status | Description | +===================+=========================================================================================================+ - | BUILD | The ECS has been created but is not running. | + | BUILD | The ECS has been created but is not running yet. | +-------------------+---------------------------------------------------------------------------------------------------------+ | REBOOT | The ECS is being restarted. | +-------------------+---------------------------------------------------------------------------------------------------------+ @@ -24,7 +24,7 @@ An ECS can be in one of the following statuses specified in ECS APIs: +-------------------+---------------------------------------------------------------------------------------------------------+ | REBUILD | The ECS is being rebuilt. | +-------------------+---------------------------------------------------------------------------------------------------------+ - | MIGRATING | The ECS is being live migrated. | + | MIGRATING | The ECS is undergoing live migration. | +-------------------+---------------------------------------------------------------------------------------------------------+ | RESIZE | The ECS has received a specifications modification request and has started to perform the modification. | +-------------------+---------------------------------------------------------------------------------------------------------+ @@ -32,11 +32,11 @@ An ECS can be in one of the following statuses specified in ECS APIs: +-------------------+---------------------------------------------------------------------------------------------------------+ | SHUTOFF | The ECS has been properly stopped. | +-------------------+---------------------------------------------------------------------------------------------------------+ - | REVERT_RESIZE | The ECS is rolling back resizing. | + | REVERT_RESIZE | The ECS is rolling back to its previous size. | +-------------------+---------------------------------------------------------------------------------------------------------+ - | VERIFY_RESIZE | The ECS is verifying the modified configuration. | + | VERIFY_RESIZE | The ECS is verifying the new size. | +-------------------+---------------------------------------------------------------------------------------------------------+ - | ERROR | An error has occurred on the ECS. | + | ERROR | The ECS is abnormal. | +-------------------+---------------------------------------------------------------------------------------------------------+ | DELETED | The ECS has been deleted. | +-------------------+---------------------------------------------------------------------------------------------------------+ @@ -49,78 +49,85 @@ An ECS can be in one of the following statuses specified in ECS APIs: .. table:: **Table 2** **OS-EXT-STS:vm_state** statuses - ================= =========================================== - Status Description - ================= =========================================== - building The ECS is being built after being created. - active The ECS is running properly. - stopped The ECS has been properly stopped. - resized The ECS specifications have been modified. - error An error has occurred on the ECS. - deleted The ECS has been deleted. - shelved The ECS booting from an image is shelved. - shelved_offloaded The ECS booting from a volume is shelved. - ================= =========================================== + +-------------------+---------------------------------------------------------------+ + | Status | Description | + +===================+===============================================================+ + | building | The ECS has been created but is not running yet. | + +-------------------+---------------------------------------------------------------+ + | active | The ECS is running properly. | + +-------------------+---------------------------------------------------------------+ + | stopped | The ECS has been properly stopped. | + +-------------------+---------------------------------------------------------------+ + | resized | The ECS has been resized (specifications have been modified). | + +-------------------+---------------------------------------------------------------+ + | error | The ECS is abnormal. | + +-------------------+---------------------------------------------------------------+ + | deleted | The ECS has been deleted. | + +-------------------+---------------------------------------------------------------+ + | shelved | The ECS booting from an image is shelved. | + +-------------------+---------------------------------------------------------------+ + | shelved_offloaded | The ECS booting from a volume is shelved. | + +-------------------+---------------------------------------------------------------+ .. table:: **Table 3** **OS-EXT-STS:task_state** statuses - +-------------------------------+---------------------------------------------------------------------------------+ - | Status | Description | - +===============================+=================================================================================+ - | scheduling | The system is scheduling resources when the ECS is being created. | - +-------------------------------+---------------------------------------------------------------------------------+ - | block_device_mapping | The ECS is being created, and disks are being prepared for the ECS. | - +-------------------------------+---------------------------------------------------------------------------------+ - | networking | The ECS is being created, and network resources are being prepared for the ECS. | - +-------------------------------+---------------------------------------------------------------------------------+ - | spawning | The ECS is being created. | - +-------------------------------+---------------------------------------------------------------------------------+ - | rebooting | The ECS is being restarted. | - +-------------------------------+---------------------------------------------------------------------------------+ - | reboot_pending | The ECS is pending a restart. | - +-------------------------------+---------------------------------------------------------------------------------+ - | reboot_started | The ECS is being restarted. | - +-------------------------------+---------------------------------------------------------------------------------+ - | rebooting_hard | The ECS is being forcibly restarted. | - +-------------------------------+---------------------------------------------------------------------------------+ - | reboot_pending_hard | The ECS is pending a force restart. | - +-------------------------------+---------------------------------------------------------------------------------+ - | reboot_started_hard | The ECS is being forcibly restarted. | - +-------------------------------+---------------------------------------------------------------------------------+ - | rebuilding | The ECS is being rebuilt. | - +-------------------------------+---------------------------------------------------------------------------------+ - | rebuild_block_device_mapping | The ECS is being rebuilt, and disks are being prepared for the ECS. | - +-------------------------------+---------------------------------------------------------------------------------+ - | rebuild_spawning | The ECS is being rebuilt internally. | - +-------------------------------+---------------------------------------------------------------------------------+ - | migrating | The ECS is undergoing live migration. | - +-------------------------------+---------------------------------------------------------------------------------+ - | resize_prep | The ECS is preparing for being resized. | - +-------------------------------+---------------------------------------------------------------------------------+ - | resize_migrating | The ECS is being resized and is currently in the migration phase. | - +-------------------------------+---------------------------------------------------------------------------------+ - | resize_migrated | The ECS is being resized and the migration is complete. | - +-------------------------------+---------------------------------------------------------------------------------+ - | resize_finish | The ECS is being resized and is currently completing the adjustment. | - +-------------------------------+---------------------------------------------------------------------------------+ - | resize_reverting | The instance is being resized and is currently reverting the adjustment. | - +-------------------------------+---------------------------------------------------------------------------------+ - | powering-off | The ECS is being stopped. | - +-------------------------------+---------------------------------------------------------------------------------+ - | powering-on | The ECS is being started. | - +-------------------------------+---------------------------------------------------------------------------------+ - | deleting | The ECS is being deleted. | - +-------------------------------+---------------------------------------------------------------------------------+ - | shelving | The ECS booting from an image is being shelved. | - +-------------------------------+---------------------------------------------------------------------------------+ - | shelving_offloading | The ECS booting from a volume is being shelved. | - +-------------------------------+---------------------------------------------------------------------------------+ - | shelving_image_pending_upload | A shelving image is pending upload. | - +-------------------------------+---------------------------------------------------------------------------------+ - | shelving_image_uploading | A shelving image is being uploaded. | - +-------------------------------+---------------------------------------------------------------------------------+ - | unshelving | The ECS is being unshelved. | - +-------------------------------+---------------------------------------------------------------------------------+ + +-------------------------------+----------------------------------------------------------------------------+ + | Status | Description | + +===============================+============================================================================+ + | scheduling | The system is scheduling resources when the ECS is being created. | + +-------------------------------+----------------------------------------------------------------------------+ + | block_device_mapping | Disks are being prepared for the ECS that is being created. | + +-------------------------------+----------------------------------------------------------------------------+ + | networking | Networking resources are being prepared for the ECS that is being created. | + +-------------------------------+----------------------------------------------------------------------------+ + | spawning | The ECS is being created internally. | + +-------------------------------+----------------------------------------------------------------------------+ + | rebooting | The ECS is being restarted. | + +-------------------------------+----------------------------------------------------------------------------+ + | reboot_pending | The ECS is pending a restart. | + +-------------------------------+----------------------------------------------------------------------------+ + | reboot_started | The ECS is being restarted internally. | + +-------------------------------+----------------------------------------------------------------------------+ + | rebooting_hard | The ECS is being forcibly restarted. | + +-------------------------------+----------------------------------------------------------------------------+ + | reboot_pending_hard | The ECS is pending a force restart. | + +-------------------------------+----------------------------------------------------------------------------+ + | reboot_started_hard | The ECS is being forcibly restarted internally. | + +-------------------------------+----------------------------------------------------------------------------+ + | rebuilding | The ECS is being rebuilt. | + +-------------------------------+----------------------------------------------------------------------------+ + | rebuild_block_device_mapping | Disks are being prepared for the ECS that is being rebuilt. | + +-------------------------------+----------------------------------------------------------------------------+ + | rebuild_spawning | The ECS is being rebuilt internally. | + +-------------------------------+----------------------------------------------------------------------------+ + | migrating | The ECS is undergoing live migration. | + +-------------------------------+----------------------------------------------------------------------------+ + | resize_prep | The ECS is preparing for being resized. | + +-------------------------------+----------------------------------------------------------------------------+ + | resize_migrating | The ECS is undergoing migration during the resize phase. | + +-------------------------------+----------------------------------------------------------------------------+ + | resize_migrated | The ECS has finished migration during the resize phase. | + +-------------------------------+----------------------------------------------------------------------------+ + | resize_finish | The ECS is finishing the resize operation during the resize phase. | + +-------------------------------+----------------------------------------------------------------------------+ + | resize_reverting | The ECS is rolling back to its previous size during the resize phase. | + +-------------------------------+----------------------------------------------------------------------------+ + | powering-off | The ECS is being stopped. | + +-------------------------------+----------------------------------------------------------------------------+ + | powering-on | The ECS is being started. | + +-------------------------------+----------------------------------------------------------------------------+ + | deleting | The ECS is being deleted. | + +-------------------------------+----------------------------------------------------------------------------+ + | shelving | The ECS booting from an image is being shelved. | + +-------------------------------+----------------------------------------------------------------------------+ + | shelving_offloading | The ECS booting from a volume is being shelved. | + +-------------------------------+----------------------------------------------------------------------------+ + | shelving_image_pending_upload | A shelving image is pending upload. | + +-------------------------------+----------------------------------------------------------------------------+ + | shelving_image_uploading | A shelving image is being uploaded. | + +-------------------------------+----------------------------------------------------------------------------+ + | unshelving | The ECS is being unshelved. | + +-------------------------------+----------------------------------------------------------------------------+ .. _en-us_topic_0178420672__table31644622920: diff --git a/api-ref/source/appendix/error_codes.rst b/api-ref/source/appendix/error_codes.rst index d7353fd..0359b3c 100644 --- a/api-ref/source/appendix/error_codes.rst +++ b/api-ref/source/appendix/error_codes.rst @@ -10,7 +10,7 @@ Context - An error code returned by an API does not correspond to one error message. The following table lists only common error messages. - Most ECS APIs are asynchronous. Some error codes are displayed in the returned messages for task viewing requests. HTTP status codes may not be accurate. -- The ECS service is strongly dependent on other services, such as network and storage. If the reported error messages contain information about ECS-dependent services, contact technical support for troubleshooting. +- The ECS service is strongly dependent on other services, such as network and storage services. If the reported error messages contain information about ECS-dependent services, contact technical support for troubleshooting. Error Codes @@ -29,11 +29,11 @@ Error Codes +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 400 | Ecs.0002 | A system exception occurred. Try again later or contact customer service. | Failed to submit the task. | Contact technical support to locate the fault. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | Ecs.0003 | You do not have permission to perform this operation. Contact customer service to obtain permission. | You do not have permission or your balance is insufficient. | Check whether the account balance is insufficient or the account is frozen according to the returned error message. | +| 403 | Ecs.0003 | You do not have permission to perform this operation. Contact customer service to obtain permission. | Your account is restricted. | Check whether the account balance is insufficient or the account is frozen according to the returned error message. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0004 | A system exception occurred. Try again later or contact customer service. | Authentication failed. | For details, see the returned error message or contact technical support. | +| 400 | Ecs.0004 | A system exception occurred. Try again later or contact customer service. | Privilege escalation failed. | For details, see the returned error message or contact technical support. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0005 | Invalid parameter values. Contact customer service. | Invalid parameters. | Check whether the request body is of the correct JSON structure according to the API reference. | +| 400 | Ecs.0005 | Invalid parameter values. Contact customer service. | Invalid parameter. | Check whether the request body is of the correct JSON structure according to the API reference. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 400 | Ecs.0007 | A system exception occurred. Try again later or contact customer service. | Invalid image attributes. | Adjust the specifications or image type. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -51,9 +51,9 @@ Error Codes +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 400 | Ecs.0014 | Incorrect VPC, subnet, or security group parameter values. | Invalid VPC parameters. | Check whether the subnets belong to the same VPC. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0015 | Invalid disk type for this type of ECS. Select a valid disk type and try again. | The disk of this type is not applicable to the ECS. | Check whether the disk type is supported by the flavor. | +| 400 | Ecs.0015 | Invalid disk type for this type of ECS. Select a valid disk type and try again. | The disk of this type is not applicable to the ECS. | Check whether the volume_type is supported by the flavor. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0017 | 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. | 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. | +| 400 | Ecs.0017 | 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 to. | 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. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 400 | Ecs.0021 | Insufficient EVS disk quota. Contact customer service to increase quota. | Insufficient EVS disk quota. | Apply for a higher EVS disk quota. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -133,7 +133,7 @@ Error Codes +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 400 | Ecs.0086 | The interface is not the primary interface. | The NIC is not the primary NIC. | Replace a NIC. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0090 | Image license type is BYOL, the BYOL feature is not supported at this time. | BYOL image features are not supported in this region. | Change the image or contact technical support. | +| 400 | Ecs.0090 | Image license type is BYOL. The BYOL feature is not supported at this time. | BYOL image features are not supported in this region. | Change the image or contact technical support. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 400 | Ecs.0100 | The ECS status does not meet requirements. Make the ECS in the required status and try again. | The ECS status does not meet requirements. | The current ECS status does not support the operation. Change the ECS status to the specified status and try again. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -141,7 +141,7 @@ Error Codes +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 400 | Ecs.0102 | The data disk is currently unresponsive. Try again later or contact customer service. | The system disk status does not allow the disk to be detached. | Check the system disk status. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0103 | The disk can be attached to a server only when it exists and is in the Available state. Check the disk status and try again. | The disk is unavailable. | Check the disk status or contact technical support to change the disk status. | +| 400 | Ecs.0103 | A disk can be attached to a server only if the disk exists and is in the available state. Make sure the disk state is available and try again. | The disk is unavailable. | Check the disk status or contact technical support to change the disk status. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 400 | Ecs.0104 | The number of EVS disks that can be attached to the ECS has reached the maximum number allowed. Detach some disks and try again. | Insufficient ECS disk quota for attaching more disks. | Detach some attached disks from the ECS and try to attach new disks. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -277,7 +277,7 @@ Error Codes +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 400 | Ecs.0907 | Invalid tag character set. | Invalid tag character set. | Create a tag again. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0908 | The tag key cannot be duplicate. | Duplicate tag key. | Create a tag again. | +| 400 | Ecs.0908 | The tag key cannot be duplicated. | Duplicate tag key. | Create a tag again. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 400 | Ecs.0909 | The flavor does not support the disk type. | The flavor does not support the disk type. | Change the flavor or disk type. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -285,13 +285,13 @@ Error Codes +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 400 | Ecs.0912 | Invalid disk encryption key. | Invalid disk encryption attribute. | Modify parameter settings for the disk encryption attribute. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0913 | The number of ECSs to be created exceeds the maximum allowed limit | The number of ECSs to be created exceeds the maximum allowed limit. | Decrease the number of ECSs to be created. | +| 400 | Ecs.0913 | The number of ECSs to be created exceeds the maximum allowed limit. | The number of ECSs to be created exceeds the maximum allowed limit. | Decrease the number of ECSs to be created. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 400 | Ecs.0914 | The length of the ECS name exceeds the maximum allowed limit. | The length of the ECS name exceeds the maximum allowed limit. | Change the ECS name. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 400 | Ecs.0915 | The length of the ECS name exceeds the maximum allowed limit. | The ECS name contains invalid characters. | Change the ECS name. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0919 | The NIC has been attached to another instance. | The port does not allow attaching. | Change the port. | +| 400 | Ecs.0919 | The NIC has been attached to another instance. | The port status does not allow attachment. | Change the port. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 400 | Ecs.1000 | A system exception occurred. Try again later or contact customer service. | Failed to call the Nova API. | Internal calling error. Try again later or contact technical support. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -321,13 +321,13 @@ Error Codes +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 400 | Common.0020 | A system exception occurred. Try again later or contact customer service. | Failed to retry the task. | Contact technical support. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Common.0021 | Subjob fails. | An error has occurred in job query. | Try again later or contact technical support. | +| 400 | Common.0021 | Sub-job fails. | An error has occurred in job query. | Try again later or contact technical support. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 400 | Common.0022 | Mission fails. | An error has occurred in job submission. | Contact technical support. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Common.0999 | The system was broken, exit. | Task terminated. | Contact technical support. | +| 400 | Common.0999 | The system was broken. Exit. | Task terminated. | Contact technical support. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Common.0025 | Query job Error because %s. | An error has occurred in job query. | Try again later or contact technical support. | +| 400 | Common.0025 | Query job error because %s. | An error has occurred in job query. | Try again later or contact technical support. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 400 | Common.0026 | Fail to get Region Info | An error occurred in AZ query. | Try again later or contact technical support. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -335,5 +335,5 @@ Error Codes +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 500 | Common.0001 | A system exception occurred. Try again later or contact customer service. | A system exception occurred. | Contact technical support. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 429 | Common.1503 | Api flow control Error because %s. | Limited by API traffic control. | Too many APIs are being executed. Try again later. | +| 429 | Common.1503 | API flow control error because %s. | Limited by API traffic control. | Too many APIs are being executed. Try again later. | +------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index dc14b33..d527e58 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -8,6 +8,10 @@ Change History +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Released On | Description | +===================================+======================================================================================================================================================================================================================================================================================================================================================================================================================================================+ +| 2026-03-13 | Added the following content: | +| | | +| | :ref:`Updating NIC Attachment Information of an ECS ` | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 2025-12-02 | Added the following content: | | | | | | :ref:`Querying Details of a Single Disk Attached to an ECS ` | @@ -16,10 +20,6 @@ Change History | | | | | Added an API in :ref:`Disk Management `. | +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2025-07-17 | Modified the following content: | -| | | -| | Added support for the general purpose SSD V2 (GPSSD2) disk type in :ref:`Creating ECSs `. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 2025-03-14 | Modified the following content: | | | | | | Updated actions in :ref:`Metadata Management ` and :ref:`Tag Management `. | @@ -165,7 +165,7 @@ Change History | 2019-02-09 | Modified the following content: | | | | | | - Deleted the **final_tenant** field in :ref:`Creating an ECS `. | -| | - Added a request example in :ref:`Creating an ECS `. | +| | - Added a request example of using **block_device_mapping_v2** in :ref:`Creating an ECS `. | | | - Added an API constraint in :ref:`Creating an Image Using an ECS `. | +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 2019-01-30 | Added the following content: | diff --git a/api-ref/source/data_structure/data_structure_for_querying_details_about_ecss.rst b/api-ref/source/data_structure/data_structure_for_querying_details_about_ecss.rst index 5d5ce5c..2ba649d 100644 --- a/api-ref/source/data_structure/data_structure_for_querying_details_about_ecss.rst +++ b/api-ref/source/data_structure/data_structure_for_querying_details_about_ecss.rst @@ -154,7 +154,7 @@ Data Structure for Querying Details About ECSs | | | | | | | **Range** | | | | | - | | | - **normal**: The ECS is not frozen. | + | | | - **normal** or an empty string (""): The ECS is normal (has been unfrozen). | | | | - **freeze**: The ECS has been frozen. | +-----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | metering.image_id | String | **Definition** | @@ -171,9 +171,9 @@ Data Structure for Querying Details About ECSs | | | | | | | **Range** | | | | | - | | | - Public image (**gold**) | - | | | - Private image (**private**) | - | | | - Shared image (**shared**) | + | | | - **gold**: public image | + | | | - **private**: private image | + | | | - **shared**: shared image | +-----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | metering.resourcespeccode | String | **Definition** | | | | | diff --git a/api-ref/source/data_structure/data_structure_for_querying_details_about_specifications.rst b/api-ref/source/data_structure/data_structure_for_querying_details_about_specifications.rst index 5bb8e93..2382744 100644 --- a/api-ref/source/data_structure/data_structure_for_querying_details_about_specifications.rst +++ b/api-ref/source/data_structure/data_structure_for_querying_details_about_specifications.rst @@ -18,7 +18,11 @@ This field is used by the following APIs: +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | +==================================+=======================+============================================================================================================================================================================================================================================================================================================================================================================================================================+ - | ecs:performancetype | String | Specifies the ECS flavor type: | + | ecs:performancetype | String | **Definition** | + | | | | + | | | Specifies the ECS flavor type. | + | | | | + | | | **Range** | | | | | | | | - **normal**: general computing | | | | - **computingv3**: general computing-plus | @@ -30,15 +34,45 @@ This field is used by the following APIs: | | | - **gpu**: GPU-accelerated | | | | - **fpga**: FPGA-accelerated | +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_type | String | Specifies the resource type. **resource_type** is used to differentiate between the types of the physical servers accommodating ECSs. | + | resource_type | String | **Definition** | + | | | | + | | | Specifies the resource type. **resource_type** is used to differentiate between the types of the physical servers accommodating ECSs. | + | | | | + | | | **Range** | + | | | | + | | | N/A | +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_vnic:type | String | Specifies the NIC type. The value of this parameter is consistently **enhanced**, indicating that network enhancement ECSs are to be created. | + | instance_vnic:type | String | **Definition** | + | | | | + | | | Specifies the NIC type. | + | | | | + | | | **Range** | + | | | | + | | | The value is fixed at **enhanced**, indicating that network-enhanced resources are used to create ECSs. | +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_vnic:instance_bandwidth | String | Specifies the maximum bandwidth in the unit of Mbit/s. The maximum value of this parameter is **10,000**. | + | instance_vnic:instance_bandwidth | String | **Definition** | + | | | | + | | | Specifies the maximum bandwidth. | + | | | | + | | | **Range** | + | | | | + | | | Maximum value: 10000 (in Mbit/s) | +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_vnic:max_count | String | Specifies the maximum number of NICs. The maximum value of this parameter is 4. | + | instance_vnic:max_count | String | **Definition** | + | | | | + | | | Specifies the maximum number of NICs. | + | | | | + | | | **Range** | + | | | | + | | | Maximum value: 4 | +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | quota:local_disk | String | The value of this parameter is in format of {type}:{count}:{size}:{safeFormat}. | + | quota:local_disk | String | **Definition** | + | | | | + | | | This field is dedicated for disk-intensive ECSs. | + | | | | + | | | **Range** | + | | | | + | | | 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: | @@ -50,18 +84,20 @@ This field is used by the following APIs: | | | - **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**. | + +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | quota:nvme_ssd | String | **Definition** | | | | | - | | | .. note:: | + | | | This field is dedicated for ultra-high I/O ECSs. | | | | | - | | | This field is dedicated for disk-intensive ECSs. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | quota:nvme_ssd | String | The value of this parameter is in the format of {type}:{spec}:{num}:{size}:{safeFormat}. | + | | | **Range** | + | | | | + | | | 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. | + | | | If **spec** is set to **large**, only the I series (for example, I3) is supported. | | | | | | | | - **num** indicates the number of local disks. | | | | | @@ -69,43 +105,61 @@ This field is used by the following APIs: | | | | | | | - **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. | + | | | If **safeFormat** is set to **True**, only the I series (for example, I3) is supported. | + +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ecs:generation | String | **Definition** | | | | | - | | | .. note:: | + | | | Specifies the generation of an ECS type. | | | | | - | | | This field is dedicated for ultra-high I/O ECSs. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ecs:generation | String | Specifies the generation of an ECS type. | + | | | For example, **3** in **s3** indicates the general computing III generation. For details about flavors and generations, see `ECS Specifications `__ in the *Elastic Cloud Server User Guide*. | | | | | - | | | For example, **3** in **s3** indicates the general-purpose third-generation ECSs. For details about flavors and generations, see `ECS Specifications `__ in the *Elastic Cloud Server User Guide*. | + | | | **Range** | + | | | | + | | | N/A | +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ecs:virtualization_env_types | String | Specifies a virtualization type. | + | ecs:virtualization_env_types | String | **Definition** | + | | | | + | | | Specifies a virtualization type. | + | | | | + | | | **Range** | | | | | | | | - If the parameter value is **FusionCompute**, the ECS uses Xen virtualization. Currently, the Xen virtualization technology is not supported. | | | | - If the parameter value is **CloudCompute**, the ECS uses KVM virtualization. | + +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | pci_passthrough:enable_gpu | String | **Definition** | | | | | - | | | .. note:: | + | | | Specifies whether the GPU is passthrough. | | | | | - | | | This field is optional. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | pci_passthrough:enable_gpu | String | Specifies whether the GPU is passthrough. | + | | | **Range** | | | | | | | | If the value is **true**, the GPU is passthrough. | +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | pci_passthrough:alias | String | Specifies the PCI passthrough device information in the "PCI device name:Quantity" format. Use commas (,) to separate multiple device information records. | + | pci_passthrough:alias | String | **Definition** | + | | | | + | | | Specifies the PCI passthrough device information in the "PCI device name:Quantity" format. Use commas (,) to separate multiple device information records. | | | | | | | | For example, nvidia-a30:1 indicates that the ECS has an A30 GPU attached. | + | | | | + | | | **Range** | + | | | | + | | | N/A | +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cond:operation:status | 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: | + | cond:operation:status | String | **Definition** | | | | | - | | | - **normal**: indicates normal commercial use of the flavor. | + | | | 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 specified or used, the status is **normal**. | + | | | | + | | | **Range** | + | | | | + | | | - **normal**: indicates that the flavor is commercially used. | | | | - **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 | String | This parameter takes effect AZ-wide. If an AZ is not configured in this parameter, the value of the **cond:operation:status** parameter is used by default. This parameter is in the format of "az(xx)". The value in parentheses is the flavor status in an AZ. If the parentheses are left blank, the configuration is invalid. The **cond:operation:az** options are the same as the **cond:operation:status** options. | + | cond:operation:az | String | **Definition** | + | | | | + | | | This parameter takes effect AZ-wide. If an AZ is not configured in this parameter, the value of the **cond:operation:status** parameter is used by default. This parameter is in the format of "az(xx)". The value in parentheses is the flavor status in an AZ. If the parentheses are left blank, the configuration is invalid. The **cond:operation:az** options are the same as the **cond:operation:status** options. | | | | | | | | For example, a flavor is for commercial use in AZs 0 and 3, sold out in AZ 1, for OBT in AZ 2, and is canceled in other AZs. Then, set parameters as follows: | | | | | @@ -115,24 +169,48 @@ This field is used by the following APIs: | | | .. note:: | | | | | | | | Configure this parameter if the flavor status in an AZ is different from the **cond:operation:status** value. | + | | | | + | | | **Range** | + | | | | + | | | N/A | +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | quota:max_rate | String | Specifies the maximum bandwidth. | + | quota:max_rate | String | **Definition** | + | | | | + | | | Specifies the maximum bandwidth. | | | | | - | | | - Unit: Mbit/s. If a bandwidth is in the unit of Gbit/s, it must be divided by 1,000. | + | | | **Range** | + | | | | + | | | Unit: Mbit/s. If the unit is Gbit/s, the value is divided by 1000. | +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | quota:min_rate | String | Specifies the assured bandwidth. | + | quota:min_rate | String | **Definition** | + | | | | + | | | Specifies the assured bandwidth. | + | | | | + | | | **Range** | | | | | - | | | - Unit: Mbit/s. If a bandwidth is in the unit of Gbit/s, it must be divided by 1,000. | + | | | Unit: Mbit/s. If the unit is Gbit/s, the value is divided by 1000. | +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | quota:max_pps | String | Specifies the maximum intranet PPS. | + | quota:max_pps | String | **Definition** | | | | | - | | | - Unit: number. If a value is in the unit of 10,000, it must be divided by 10,000. | + | | | Specifies the maximum intranet PPS. | + | | | | + | | | **Range** | + | | | | + | | | Unit: number. If a value is in the unit of 10000, the value is divided by 10000. | +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cond:operation:charge | String | Specifies a billing type. | + | cond:operation:charge | String | **Definition** | + | | | | + | | | Specifies the billing mode. All billing modes are supported if this parameter is not specified. | | | | | - | | | - All the billing types are supported if this parameter is not set. | + | | | **Range** | + | | | | + | | | N/A | +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cond:compute | String | Specifies computing constraints. | + | cond:compute | String | **Definition** | + | | | | + | | | Specifies compute constraints. | + | | | | + | | | **Range** | | | | | | | | - **autorecovery**: indicates that automatic recovery is supported. | | | | - If this parameter does not exist, automatic recovery is not supported. | diff --git a/api-ref/source/native_openstack_nova_apis/lifecycle_management/creating_an_ecs.rst b/api-ref/source/native_openstack_nova_apis/lifecycle_management/creating_an_ecs.rst index 36407d5..5a81d78 100644 --- a/api-ref/source/native_openstack_nova_apis/lifecycle_management/creating_an_ecs.rst +++ b/api-ref/source/native_openstack_nova_apis/lifecycle_management/creating_an_ecs.rst @@ -33,7 +33,7 @@ POST /v2/{project_id}/servers .. note:: - Alias of the API for creating ECSs: /v2/{project_id}/os-volumes_boot + Alias of the API for creating ECSs: /v2.1/{project_id}/os-volumes_boot This calling mode can only be used in OpenStack client and is not recommended. @@ -133,7 +133,7 @@ Request | | | | | | | | | .. note:: | | | | | | - | | | | The hostname of in the ECS OS must comply with `RFC 952 `__ and `RFC 1123 `__. You are advised to use a name containing letters (a to z), digits (0 to 9), and hyphens (-). | + | | | | The hostname in the ECS OS must comply with `RFC 952 `__ and `RFC 1123 `__. You are advised to use a name containing letters (a to z), digits (0 to 9), and hyphens (-). | +-------------------------+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | metadata | No | Map | Specifies the ECS metadata. For details, see :ref:`Table 4 `. | | | | | | diff --git a/api-ref/source/native_openstack_nova_apis/metadata_management/configuring_ecs_metadata.rst b/api-ref/source/native_openstack_nova_apis/metadata_management/configuring_ecs_metadata.rst index 4e5d702..7c9c619 100644 --- a/api-ref/source/native_openstack_nova_apis/metadata_management/configuring_ecs_metadata.rst +++ b/api-ref/source/native_openstack_nova_apis/metadata_management/configuring_ecs_metadata.rst @@ -46,19 +46,19 @@ Request .. table:: **Table 2** Request parameters - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Mandatory | Description | - +=================+=================+=================+======================================================================================================================================================================================================================+ - | metadata | Object | Yes | Specifies the user-defined metadata key-value pair. | - | | | | | - | | | | For a metadata key: | - | | | | | - | | | | A key contains a maximum of 255 Unicode characters and cannot be empty. A key can contain uppercase letters (A-Z), lowercase letters (a-z), digits (0-9), hyphens (-), underscores (_), colons (:), and periods (.). | - | | | | | - | | | | For a metadata value: | - | | | | | - | | | | A value contains a maximum of 255 Unicode characters. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Mandatory | Description | + +=================+=================+=================+======================================================================================================================================================+ + | metadata | Object | Yes | Specifies the user-defined metadata key-value pair. | + | | | | | + | | | | For a metadata key: | + | | | | | + | | | | It cannot be left blank. Only uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), colons (:), and periods (.) are supported. | + | | | | | + | | | | For a metadata value: | + | | | | | + | | | | A maximum of 255 characters are supported. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ Response -------- diff --git a/api-ref/source/native_openstack_nova_apis/metadata_management/modifying_ecs_metadata_with_a_specified_key.rst b/api-ref/source/native_openstack_nova_apis/metadata_management/modifying_ecs_metadata_with_a_specified_key.rst index 0292f99..d42e25f 100644 --- a/api-ref/source/native_openstack_nova_apis/metadata_management/modifying_ecs_metadata_with_a_specified_key.rst +++ b/api-ref/source/native_openstack_nova_apis/metadata_management/modifying_ecs_metadata_with_a_specified_key.rst @@ -48,19 +48,19 @@ Request .. table:: **Table 2** Request parameters - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+========================================================================================================================================================================================================================+ - | meta | Yes | Object | Specifies the user-defined metadata key pair. | - | | | | | - | | | | For a metadata key: | - | | | | | - | | | | It contains a maximum of 255 Unicode characters and cannot be left blank. A key can contain uppercase letters (A-Z), lowercase letters (a-z), digits (0-9), hyphens (-), underscores (_), colons (:), and periods (.). | - | | | | | - | | | | For a metadata value: | - | | | | | - | | | | It contains a maximum of 255 Unicode characters. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+======================================================================================================================================================+ + | meta | Yes | Object | Specifies the user-defined metadata key pair. | + | | | | | + | | | | For a metadata key: | + | | | | | + | | | | It cannot be left blank. Only uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), colons (:), and periods (.) are supported. | + | | | | | + | | | | For a metadata value: | + | | | | | + | | | | A maximum of 255 characters are supported. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ Response -------- diff --git a/api-ref/source/native_openstack_nova_apis/metadata_management/updating_ecs_metadata.rst b/api-ref/source/native_openstack_nova_apis/metadata_management/updating_ecs_metadata.rst index 860dd3d..2c5c95f 100644 --- a/api-ref/source/native_openstack_nova_apis/metadata_management/updating_ecs_metadata.rst +++ b/api-ref/source/native_openstack_nova_apis/metadata_management/updating_ecs_metadata.rst @@ -48,19 +48,19 @@ Request .. table:: **Table 2** Request parameters - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+========================================================================================================================================================================================================================+ - | metadata | Yes | Object | Specifies the user-defined metadata key-value pair. | - | | | | | - | | | | For a metadata key: | - | | | | | - | | | | It contains a maximum of 255 Unicode characters and cannot be left blank. A key can contain uppercase letters (A-Z), lowercase letters (a-z), digits (0-9), hyphens (-), underscores (_), colons (:), and periods (.). | - | | | | | - | | | | For a metadata value: | - | | | | | - | | | | A value contains a maximum of 255 Unicode characters. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+======================================================================================================================================================+ + | metadata | Yes | Object | Specifies the user-defined metadata key-value pair. | + | | | | | + | | | | For a metadata key: | + | | | | | + | | | | It cannot be left blank. Only uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), colons (:), and periods (.) are supported. | + | | | | | + | | | | For a metadata value: | + | | | | | + | | | | A maximum of 255 characters are supported. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ Response --------