From 6edd5bfe3a3a0276498a8255ccf6b9b542c7c44d Mon Sep 17 00:00:00 2001 From: guoyanyan Date: Tue, 28 Feb 2023 07:26:15 +0000 Subject: [PATCH] ecs_api_0216 Reviewed-by: Hasko, Vladimir Co-authored-by: guoyanyan Co-committed-by: guoyanyan --- docs/ecs/api-ref/en-us_topic_0020212668.html | 16 ++--- docs/ecs/api-ref/en-us_topic_0020212688.html | 2 +- docs/ecs/api-ref/en-us_topic_0020212689.html | 8 +-- docs/ecs/api-ref/en-us_topic_0020212690.html | 4 +- docs/ecs/api-ref/en-us_topic_0020212692.html | 2 +- docs/ecs/api-ref/en-us_topic_0022067717.html | 66 ++++++++++++++++++++ docs/ecs/api-ref/en-us_topic_0022067719.html | 13 ++-- docs/ecs/api-ref/en-us_topic_0024734483.html | 12 +++- docs/ecs/api-ref/en-us_topic_0065817694.html | 6 +- docs/ecs/api-ref/en-us_topic_0065817708.html | 2 +- docs/ecs/api-ref/en-us_topic_0065820822.html | 2 +- docs/ecs/api-ref/en-us_topic_0065820825.html | 2 +- docs/ecs/api-ref/en-us_topic_0065820826.html | 2 +- docs/ecs/api-ref/en-us_topic_0065820827.html | 2 +- docs/ecs/api-ref/en-us_topic_0067876349.html | 2 +- docs/ecs/api-ref/en-us_topic_0067876971.html | 2 +- docs/ecs/api-ref/en-us_topic_0068473331.html | 6 +- docs/ecs/api-ref/en-us_topic_0094148849.html | 2 +- docs/ecs/api-ref/en-us_topic_0094148850.html | 1 + docs/ecs/api-ref/en-us_topic_0102606095.html | 10 +-- docs/ecs/api-ref/en-us_topic_0118308527.html | 2 +- docs/ecs/api-ref/en-us_topic_0167957246.html | 10 +-- 22 files changed, 121 insertions(+), 53 deletions(-) diff --git a/docs/ecs/api-ref/en-us_topic_0020212668.html b/docs/ecs/api-ref/en-us_topic_0020212668.html index 04a49ee96..e623ed9b7 100644 --- a/docs/ecs/api-ref/en-us_topic_0020212668.html +++ b/docs/ecs/api-ref/en-us_topic_0020212668.html @@ -91,7 +91,7 @@

String

Specifies the ID of the system image used for creating ECSs. The ID is in Universally Unique Identifier (UUID) format.

-
NOTE:
  • Certain ECS flavors cannot support all public images provided on the public cloud platform. To obtain the images supported by an ECS flavor, log in to the management console, view the images displayed on the Create ECS page, and obtain the image IDs on the Image Management Service page.
  • If the creation fails, modify the parameter settings.
+
NOTE:
  • Certain ECS flavors cannot support all public images provided on the cloud service platform. To obtain the images supported by an ECS flavor, log in to the management console, view the images displayed on the Create ECS page, and obtain the image IDs on the Image Management Service page.
  • If the creation fails, modify the parameter settings.
@@ -318,7 +318,7 @@ echo 111 > c:\aaa.txt

String

Specifies the subnet of the ECS.

-

The value must be the ID of the subnet created in the VPC specified by vpcid and in the format of the UUID.

+

The value must be the ID of the subnet created in the VPC specified by vpcid and in the format of the UUID.

ip_address

@@ -373,7 +373,7 @@ echo 111 > c:\aaa.txt

String

Specifies the ECS system disk type, which must be one of available disk types.

-
The value can be SSD, SAS, SATA, co-p1, or uh-l1.
  • SSD: the ultra-high I/O type
  • SAS: the high I/O type
  • SATA: the common I/O type
  • co-p1: the high I/O (performance-optimized I) type
  • uh-l1: the ultra-high I/O (latency-optimized) type
  • The co-p1 and uh-l1 types of disks are used exclusively for HPC ECSs and SAP HANA ECSs.

    +
    The value can be ESSD, SSD, SAS, SATA, co-p1, or uh-l1.
    • SSD: the ultra-high I/O type
    • SAS: the high I/O type
    • SATA: the common I/O type
    • co-p1: the high I/O (performance-optimized I) type
    • uh-l1: the ultra-high I/O (latency-optimized) type
    • ESSD: the extreme SSD type

      The co-p1 and uh-l1 types of disks are used exclusively for HPC ECSs and SAP HANA ECSs.

    If the specified disk type is not available in the AZ, the disk will fail to be created.

    @@ -438,7 +438,7 @@ echo 111 > c:\aaa.txt

    String

    Specifies the type of the ECS data disk, which must be one of available disk types.

    -
    The value can be SSD, SAS, SATA, co-p1, or uh-l1.
    • SSD: the ultra-high I/O type
    • SAS: the high I/O type
    • SATA: the common I/O type
    • co-p1: the high I/O (performance-optimized I) type
    • uh-l1: the ultra-high I/O (latency-optimized) type
    • The co-p1 and uh-l1 types of disks are used exclusively for HPC ECSs and SAP HANA ECSs.

      +
      The value can be ESSD, SSD, SAS, SATA, co-p1, or uh-l1.
      • SSD: the ultra-high I/O type
      • SAS: the high I/O type
      • SATA: the common I/O type
      • co-p1: the high I/O (performance-optimized I) type
      • uh-l1: the ultra-high I/O (latency-optimized) type
      • ESSD: the extreme SSD type

        The co-p1 and uh-l1 types of disks are used exclusively for HPC ECSs and SAP HANA ECSs.

      If the specified disk type is not available in the AZ, the disk will fail to be created.

      @@ -477,7 +477,7 @@ echo 111 > c:\aaa.txt

      Specifies the shared disk information.

      • true: indicates that the created disk is a shared disk.
      • false: indicates that the created disk is a common EVS disk.
      -
      NOTE:

      The shareable field is not used anymore. If both shareable and multiattach must be used, ensure that the values of the two fields are the same. If this parameter is not specified, common EVS disks are created by default.

      +
      NOTE:
      • If this parameter is set to true, the type of the shared disk is SCSI.
      • The shareable field is not used anymore. If both shareable and multiattach must be used, ensure that the values of the two fields are the same. If this parameter is not specified, common EVS disks are created by default.
      @@ -517,7 +517,7 @@ echo 111 > c:\aaa.txt

      Object

      -

      Specifies the EVS disk metadata. Ensure that key and value in the metadata contain at most 255 bytes.

      +

      Specifies the EVS disk metadata. Ensure that key and value in the metadata contain at most 255 bytes.

      This field is used only when an encrypted disk is created.

      If data disks are created using a data disk image, this field cannot be used.

      For details, see metadata Field Description for Creating Disks.

      @@ -549,11 +549,11 @@ echo 111 > c:\aaa.txt

      For details about abnormal responses, see Responses (Task).

      -

      Example Request

      The public cloud platform provides various ECS types. The flavor name/ID varies depending on ECS types and specifications. When you use APIs to create ECSs with different specifications, the request bodies are the same. You only need to change the parameter values in the following request example based on the parameters described in Request.

      +

      Example Request

      The cloud service platform provides various ECS types. The flavor name/ID varies depending on ECS types and specifications. When you use APIs to create ECSs with different specifications, the request bodies are the same. You only need to change the parameter values in the following request example based on the parameters described in Request.

      • Example URL request
        POST https://{endpoint}/v1/{project_id}/cloudservers
      -
      • An ECS with flavor ID m3.larger is to be created, where the image ID is imageid_123, disk type is SSD, and VPC ID is 0dae26c9-9a70-4392-93f3-87d53115d171. An example request is as follows:
        {
        +
        • An ECS with flavor ID m3.larger is to be created, where the image ID is imageid_123, disk type is SSD, and VPC ID is 0dae26c9-9a70-4392-93f3-87d53115d171. An example request is as follows:
          {
               "server": {
                   "availability_zone":"az1-dc1",
                   "name": "newserver", 
          diff --git a/docs/ecs/api-ref/en-us_topic_0020212688.html b/docs/ecs/api-ref/en-us_topic_0020212688.html
          index 14d4d1faf..8dc58e00e 100644
          --- a/docs/ecs/api-ref/en-us_topic_0020212688.html
          +++ b/docs/ecs/api-ref/en-us_topic_0020212688.html
          @@ -123,7 +123,7 @@
           
           

          Queries ECSs with tags not containing the specified value. The value is the tag key.

          For details about key rules, see Tag Types.

          -
          NOTE:

          Tag functions have been upgraded on the public cloud. If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key".

          +
          NOTE:

          Tag functions have been upgraded on the cloud service platform. If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key".

          For example, an existing tag is a.b. After the tag function upgrade, query the tag using "not-tags=a".

          diff --git a/docs/ecs/api-ref/en-us_topic_0020212689.html b/docs/ecs/api-ref/en-us_topic_0020212689.html index 2c223e59b..d8d81db6c 100644 --- a/docs/ecs/api-ref/en-us_topic_0020212689.html +++ b/docs/ecs/api-ref/en-us_topic_0020212689.html @@ -123,7 +123,7 @@

          Queries ECSs with tags not containing the specified value. The value is the tag key.

          For details about key rules, see Tag Types.

          -
          NOTE:

          Tag functions have been upgraded on the public cloud. If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key".

          +
          NOTE:

          Tag functions have been upgraded on the cloud service platform. If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key".

          For example, an existing tag is a.b. After the tag function upgrade, query the tag using "not-tags=a".

          @@ -232,7 +232,7 @@

          String

          -

          Specifies the time when the ECS was updated last time. The time is in the format of "2019-05-22T07:48:53Z".

          +

          Specifies the last time when the ECS was updated, such as started, stopped, or restarted. The time is in the format of "2019-05-22T07:48:53Z".

          flavor

          @@ -493,7 +493,7 @@

          Specifies ECS tags.

          This parameter is supported in microversion 2.26 and later. If the microversion is not used for query, the response does not contain the tags field.

          -
          Tag functions have been upgraded on the public cloud. After the upgrade, the tag values returned by the system comply with the following rules:
          • The key and value of a tag are connected using an equal sign (=), for example, key=value.
          • If the value is empty, only the key is returned.
          +
          Tag functions have been upgraded on the cloud service platform. After the upgrade, the tag values returned by the system comply with the following rules:
          • The key and value of a tag are connected using an equal sign (=), for example, key=value.
          • If the value is empty, only the key is returned.

          For more details about upgraded tag functions, see Tag Types.

          @@ -777,7 +777,7 @@
          -
          - + + + diff --git a/docs/ecs/api-ref/en-us_topic_0065820825.html b/docs/ecs/api-ref/en-us_topic_0065820825.html index 48e9d014d..cdddef4c9 100644 --- a/docs/ecs/api-ref/en-us_topic_0065820825.html +++ b/docs/ecs/api-ref/en-us_topic_0065820825.html @@ -35,7 +35,7 @@ diff --git a/docs/ecs/api-ref/en-us_topic_0065820826.html b/docs/ecs/api-ref/en-us_topic_0065820826.html index bee9fa1d3..76c9660d5 100644 --- a/docs/ecs/api-ref/en-us_topic_0065820826.html +++ b/docs/ecs/api-ref/en-us_topic_0065820826.html @@ -33,7 +33,7 @@ diff --git a/docs/ecs/api-ref/en-us_topic_0065820827.html b/docs/ecs/api-ref/en-us_topic_0065820827.html index 7f913703c..45c9806d0 100644 --- a/docs/ecs/api-ref/en-us_topic_0065820827.html +++ b/docs/ecs/api-ref/en-us_topic_0065820827.html @@ -35,7 +35,7 @@ diff --git a/docs/ecs/api-ref/en-us_topic_0067876349.html b/docs/ecs/api-ref/en-us_topic_0067876349.html index 42b8fc755..496d52bc4 100644 --- a/docs/ecs/api-ref/en-us_topic_0067876349.html +++ b/docs/ecs/api-ref/en-us_topic_0067876349.html @@ -118,7 +118,7 @@ diff --git a/docs/ecs/api-ref/en-us_topic_0067876971.html b/docs/ecs/api-ref/en-us_topic_0067876971.html index 685f53643..007302b2e 100644 --- a/docs/ecs/api-ref/en-us_topic_0067876971.html +++ b/docs/ecs/api-ref/en-us_topic_0067876971.html @@ -128,7 +128,7 @@ diff --git a/docs/ecs/api-ref/en-us_topic_0068473331.html b/docs/ecs/api-ref/en-us_topic_0068473331.html index 3babbde43..37c712481 100644 --- a/docs/ecs/api-ref/en-us_topic_0068473331.html +++ b/docs/ecs/api-ref/en-us_topic_0068473331.html @@ -31,7 +31,7 @@

          Constraints

          1. This API is native, which does not support the creation of ECSs using full-ECS images. To use full-ECS images to create ECSs, refer to Creating an ECS.
          2. During the creation of an ECS using this API, you cannot bind an EIP to the ECS. If you want to create an ECS and bind an EIP to it, refer to Creating an ECS.
          3. Parameter port in the three network parameters (port, uuid, and fixed_ip) has the highest priority. If parameter fixed_ip is set, you must specify the UUID.
          4. A file injection failure will result in the ECS creation failure.
          5. The following restrictions apply when you create ECSs using an image:
            1. You cannot create an ECS on a specified host.
            2. If a tenant backs up a disk in an ECS, the disk can be deleted only after the tenant deletes all the snapshots of the disk.
            3. The flavors with different resource types cannot be adjusted if you adjust the specifications of an ECS created using an image.
            -
          6. Native APIs /v2/{project_id}/servers and /v2.1/{project_id}/servers provided by the public cloud platform is developed based on and compatible with the community-version native OpenStack API.
            Compared with the community-version native API, this API has the following restrictions when you create an ECS using a specified image:
            • Community-version native OpenStack API: creates an ECS using the local disk by default.
            • Native API provided by the public cloud platform: creates an ECS using the shared storage as the system disk.
            +
          7. Native APIs /v2/{project_id}/servers and /v2.1/{project_id}/servers provided by the cloud service platform is developed based on and compatible with the community-version native OpenStack API.
            Compared with the community-version native API, this API has the following restrictions when you create an ECS using a specified image:
            • Community-version native OpenStack API: creates an ECS using the local disk by default.
            • Native API provided by the cloud service platform: creates an ECS using the shared storage as the system disk.
            Specifically, when you use the native API to create an ECS:
            1. You can query information about the disks attached to the ECS.
            2. The ECS system disk uses the EVS disk quota.
            3. You cannot query ECSs created based on a specified image using the image filtering function.
            @@ -92,7 +92,7 @@
          @@ -472,7 +472,7 @@ echo 111 > c:\aaa.txt - diff --git a/docs/ecs/api-ref/en-us_topic_0094148849.html b/docs/ecs/api-ref/en-us_topic_0094148849.html index 9593faca3..e9ec64203 100644 --- a/docs/ecs/api-ref/en-us_topic_0094148849.html +++ b/docs/ecs/api-ref/en-us_topic_0094148849.html @@ -78,7 +78,7 @@ - diff --git a/docs/ecs/api-ref/en-us_topic_0094148850.html b/docs/ecs/api-ref/en-us_topic_0094148850.html index 58b4ba62e..c36db92e1 100644 --- a/docs/ecs/api-ref/en-us_topic_0094148850.html +++ b/docs/ecs/api-ref/en-us_topic_0094148850.html @@ -64,6 +64,7 @@ @@ -240,7 +240,7 @@
          Table 11 image field description

          Parameter

          +
          diff --git a/docs/ecs/api-ref/en-us_topic_0020212690.html b/docs/ecs/api-ref/en-us_topic_0020212690.html index d95cb0fce..d24ca5e2f 100644 --- a/docs/ecs/api-ref/en-us_topic_0020212690.html +++ b/docs/ecs/api-ref/en-us_topic_0020212690.html @@ -98,7 +98,7 @@ - diff --git a/docs/ecs/api-ref/en-us_topic_0020212692.html b/docs/ecs/api-ref/en-us_topic_0020212692.html index a49212aa7..248c0bf8d 100644 --- a/docs/ecs/api-ref/en-us_topic_0020212692.html +++ b/docs/ecs/api-ref/en-us_topic_0020212692.html @@ -258,7 +258,7 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -167,7 +161,8 @@
          Table 11 image field description

          Parameter

          Type

          String

          Specifies the time when the ECS was updated last time. The time is in the format of "2019-05-22T07:48:19Z".

          +

          Specifies the last time when the ECS was updated, such as started, stopped, or restarted. The time is in the format of "2019-05-22T07:48:19Z".

          flavor

          @@ -180,7 +180,7 @@

          Specifies ECS tags.

          This parameter is supported in microversion 2.26 and later. If the microversion is not used for query, the response does not contain the tags field.

          -
          Tag functions have been upgraded on the public cloud. After the upgrade, the tag values returned by the system comply with the following rules:
          • The key and value of a tag are connected using an equal sign (=), for example, key=value.
          • If the value is empty, only the key is returned.
          +
          Tag functions have been upgraded on the cloud service platform. After the upgrade, the tag values returned by the system comply with the following rules:
          • The key and value of a tag are connected using an equal sign (=), for example, key=value.
          • If the value is empty, only the key is returned.

          For more details about upgraded tag functions, see Tag Types.

          Specifies ECS tags.

          This parameter is supported in microversion 2.26 and later. If the microversion is not used for query, the response does not contain the tags field.

          -
          Tag functions have been upgraded on the public cloud. After the upgrade, the tag values returned by the system comply with the following rules:
          • The key and value of a tag are connected using an equal sign (=), for example, key=value.
          • If the value is empty, only the key is returned.
          +
          Tag functions have been upgraded on the cloud service platform. After the upgrade, the tag values returned by the system comply with the following rules:
          • The key and value of a tag are connected using an equal sign (=), for example, key=value.
          • If the value is empty, only the key is returned.
          • The key and value of a tag are connected using an equal sign (=), for example, key=value.
          • If the value is empty, only the key is returned.

          For more details about upgraded tag functions, see Tag Types.

          diff --git a/docs/ecs/api-ref/en-us_topic_0022067717.html b/docs/ecs/api-ref/en-us_topic_0022067717.html index 76e327f0e..63e4cf3fa 100644 --- a/docs/ecs/api-ref/en-us_topic_0022067717.html +++ b/docs/ecs/api-ref/en-us_topic_0022067717.html @@ -500,6 +500,72 @@

          Adjust the NIC parameter settings.

          403

          +

          Ecs.0066

          +

          This operation cannot be performed because real-name authentication has not been completed.

          +

          Restricted due to lack of real-name authentication.

          +

          Check whether the account is restricted due to lack of real-name authentication.

          +

          403

          +

          Ecs.0067

          +

          Insufficient account balance.

          +

          Restricted due to insufficient balance.

          +

          Check whether the account is restricted due to insufficient balance.

          +

          403

          +

          Ecs.0068

          +

          This operation cannot be performed by partners.

          +

          Restricted due to a non-partner.

          +

          Check whether the account is restricted due to a non-partner.

          +

          403

          +

          Ecs.0069

          +

          You have not associated a payment method with your account.

          +

          Restricted due to incomplete payment information.

          +

          Check whether the payment information of the account is complete.

          +

          403

          +

          Ecs.0070

          +

          Insufficient budget. Contact the enterprise administrator and request for a budget increase.

          +

          Restricted because account budget of the enterprise department is insufficient.

          +

          Check whether the budget of the enterprise department account is sufficient.

          +

          403

          +

          Ecs.0071

          +

          This operation cannot be performed because your account has been suspended.

          +

          Restricted due to a malicious account.

          +

          Check whether the account is malicious.

          +

          400

          Ecs.0073

          diff --git a/docs/ecs/api-ref/en-us_topic_0022067719.html b/docs/ecs/api-ref/en-us_topic_0022067719.html index a9954a12c..c85bcd871 100644 --- a/docs/ecs/api-ref/en-us_topic_0022067719.html +++ b/docs/ecs/api-ref/en-us_topic_0022067719.html @@ -27,8 +27,6 @@

          0% to 100%

          ECS monitored

          -
          NOTE:

          The metrics collected using OTC Tools are accurate.

          -

          mem_util

          @@ -40,8 +38,6 @@

          0% to 100%

          ECS monitored

          -
          NOTE:

          This metric is unavailable if the image has no OTC Tools installed.

          -

          disk_util_inband

          @@ -53,8 +49,6 @@

          0% to 100%

          ECS monitored

          -
          NOTE:

          This metric is unavailable if the image has no OTC Tools installed.

          -

          disk_read_bytes_rate

          @@ -154,8 +148,8 @@

          InfiniBand NIC status

          This metric is used to monitor the status of an InfiniBand NIC on a high-performance h2 ECS to ensure proper InfiniBand NIC running.

          -

          The system periodically checks the NIC status and returns check results using value 0 or 1.

          -
          • 0: The system is running properly. That is, the InfiniBand NIC is functional.
          • 1: The system is not running properly. That is, the InfiniBand NIC malfunctions.
          +

          The system periodically checks the NIC status and returns check results using value 0 or 1.

          +
          • 0: The system is running properly. That is, the InfiniBand NIC is functional.
          • 1: The system is not running properly. That is, the InfiniBand NIC malfunctions.

          0 or 1

          -

          The image based on which the target ECS is created must have OTC Tools installed. Otherwise, the Memory Usage and Disk Usage metrics are unavailable. For details about how to install the OTC Tools, visit https://github.com/UVP-Tools/UVP-Tools/.

          +
          To monitor the memory usage and disk usage, you need to install the agent on your ECS. +

          Dimension

          diff --git a/docs/ecs/api-ref/en-us_topic_0024734483.html b/docs/ecs/api-ref/en-us_topic_0024734483.html index c9fd37e9e..5c1d7cd07 100644 --- a/docs/ecs/api-ref/en-us_topic_0024734483.html +++ b/docs/ecs/api-ref/en-us_topic_0024734483.html @@ -8,7 +8,13 @@

          2022-11-25

          +

          2022-12-20

          +

          Modified the following content:

          +

          Modified the value range of volumetype and added ESSD in Creating an ECS.

          +

          2022-11-25

          Modified the following content:

          Modified the value range of volumetype and deleted GPSSD and ESSD in Creating an ECS.

          @@ -216,13 +222,13 @@

          2018-05-31

          Modified the following content:

          -
          • Fixed 59 UAT issues in Elastic Cloud Server API Reference 27.
          +
          • Fixed 59 UAT issues in Elastic Cloud Server API Reference 27.

          2018-05-21

          Modified the following content:

          - +

          2018-03-30

          diff --git a/docs/ecs/api-ref/en-us_topic_0065817694.html b/docs/ecs/api-ref/en-us_topic_0065817694.html index 8b4f8bb0a..6fb9487bb 100644 --- a/docs/ecs/api-ref/en-us_topic_0065817694.html +++ b/docs/ecs/api-ref/en-us_topic_0065817694.html @@ -4,10 +4,10 @@

          Function

          This API is used to create an image using an ECS. After the creation, you can use this image to create ECSs.

          Images created using an ECS are stored on storage nodes as snapshots.

          -

          This API is a native OpenStack API that is not applicable to the images on the public cloud platform.

          -
          • To create a system disk image or data disk image, use the IMS API (POST /v2/cloudimages/action). For details, see "Creating an Image" in Image Management Service API Reference.
          • To create a full-ECS image, use the IMS API (POST /v1/cloudimages/wholeimages/action). For details, see "Creating a Full-ECS Image" in Image Management Service API Reference.
          +

          This API is a native OpenStack API that is not applicable to the images on cloud service platform.

          +
          • To create a system disk image or data disk image, use the IMS API (POST /v2/cloudimages/action). For details, see "Creating an Image" in Image Management Service API Reference.
          • To create a full-ECS image, use the IMS API (POST /v1/cloudimages/wholeimages/action). For details, see "Creating a Full-ECS Image" in Image Management Service API Reference.
          -

          Constraints

          1. An ECS in the error state cannot be used to create an image.
          2. If an image created using an ECS is used to create a new ECS, the new ECS must be located in the same AZ as the original ECS.
          3. After an ECS is deleted, the images and snapshots created using this ECS will not be automatically deleted. You must manually delete them.
          4. After an image created using an ECS is deleted, the associated snapshots will not be automatically deleted (this function is implemented by native OpenStack). You must manually delete such snapshots.
          5. The image created using an ECS cannot be used to create data disks.
          6. The images created using the API described in this section (URI: POST /v2/{project_id}/servers/{server_id}/action or POST /v2.1/{project_id}/servers/{server_id}/action) cannot be exported to OBS buckets. If such images must be exported, use the IMS API (POST /v2/cloudimages/action). For details, see "Creating an Image" in Image Management Service API Reference.
          +

          Constraints

          1. An ECS in the error state cannot be used to create an image.
          2. If an image created using an ECS is used to create a new ECS, the new ECS must be located in the same AZ as the original ECS.
          3. After an ECS is deleted, the images and snapshots created using this ECS will not be automatically deleted. You must manually delete them.
          4. After an image created using an ECS is deleted, the associated snapshots will not be automatically deleted (this function is implemented by native OpenStack). You must manually delete such snapshots.
          5. The image created using an ECS cannot be used to create data disks.
          6. The images created using the API described in this section (URI: POST /v2/{project_id}/servers/{server_id}/action or POST /v2.1/{project_id}/servers/{server_id}/action) cannot be exported to OBS buckets. If such images must be exported, use the IMS API (POST /v2/cloudimages/action). For details, see "Creating an Image" in Image Management Service API Reference.

          URI

          POST /v2.1/{project_id}/servers/{server_id}/action

          POST /v2/{project_id}/servers/{server_id}/action

          diff --git a/docs/ecs/api-ref/en-us_topic_0065817708.html b/docs/ecs/api-ref/en-us_topic_0065817708.html index ae8b19341..32c778d9e 100644 --- a/docs/ecs/api-ref/en-us_topic_0065817708.html +++ b/docs/ecs/api-ref/en-us_topic_0065817708.html @@ -47,7 +47,7 @@

          Specifies the AZ to which the volume to be created belongs.

          If the specified AZ does not exist, creating the volume failed, and the volume is in error state.

          -

          The AZ to which the volume to be created belongs must be specified in the public cloud system.

          +

          The AZ to which the volume to be created belongs must be specified in the cloud service system.

          display_description

          diff --git a/docs/ecs/api-ref/en-us_topic_0065820822.html b/docs/ecs/api-ref/en-us_topic_0065820822.html index 7db165763..c008f8f29 100644 --- a/docs/ecs/api-ref/en-us_topic_0065820822.html +++ b/docs/ecs/api-ref/en-us_topic_0065820822.html @@ -49,7 +49,7 @@

          Array of strings

          Specifies ECS tags.

          -

          Tag functions have been upgraded on the public cloud. After the upgrade, the tag values returned by the system comply with the following rules:

          +

          Tag functions have been upgraded on the cloud service platform. After the upgrade, the tag values returned by the system comply with the following rules:

          • The key and value of a tag are connected using an equal sign (=), for example, key=value.
          • If the value is empty, only the key is returned.

          For more details about upgraded tag functions, see Tag Types.

          Specifies the key of the tag to be added.

          For details about key rules, see Tag Types.

          -
          NOTE:

          Tag functions have been upgraded on the public cloud. If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key".

          +
          NOTE:

          Tag functions have been upgraded on the cloud service platform. If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key".

          For example, an existing tag is "a.b". The tag can be queried in the format of "tag=a.b" before and in the format of "tag=a" now according to the new tag rules.

          Specifies the key of the tag to be queried. If no key is specified, all tags of the ECS will be displayed.

          For details about key rules, see Tag Types.

          -
          NOTE:

          Tag functions have been upgraded on the public cloud. If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key".

          +
          NOTE:

          Tag functions have been upgraded on the cloud service platform. If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key".

          For example, an existing tag is "a.b". The tag can be queried in the format of "tag=a.b" before and in the format of "tag=a" now according to the new tag rules.

          Specifies the key of the tag to be deleted. If no key is specified, all tags of the ECS will be deleted.

          For details about key rules, see Tag Types.

          -
          NOTE:

          Tag functions have been upgraded on the public cloud. If the tags added before the function upgrade are in the format of "Key.Value", delete tags using "Key".

          +
          NOTE:

          Tag functions have been upgraded on the cloud service platform. If the tags added before the function upgrade are in the format of "Key.Value", delete tags using "Key".

          For example, an existing tag is a.b. After the tag function upgrade, delete the tag using "a".

          String

          Specifies whether a user has the license of an image.

          -
          • If this parameter is set to true, the license file delivered with the image is used, indicating that BYOL is used.
          • If this parameter is set to a value other than true, BYOL is not used, and the license file provided by the public cloud platform must be used.
          +
          • If this parameter is set to true, the license file delivered with the image is used, indicating that BYOL is used.
          • If this parameter is set to a value other than true, BYOL is not used, and the license file provided by the cloud service platform must be used.

          The default value is not true, indicating that BYOL is not used.

          String

          Specifies whether a user has the license of an image.

          -
          • If this parameter is set to true, the license file delivered with the image is used, indicating that BYOL is used.
          • If this parameter is set to a value other than true, BYOL is not used, and the license file provided by the public cloud platform must be used.
          +
          • If this parameter is set to true, the license file delivered with the image is used, indicating that BYOL is used.
          • If this parameter is set to a value other than true, BYOL is not used, and the license file provided by the cloud service platform must be used.

          The default value is not true, indicating that BYOL is not used.

          Specifies the ECS image ID or URL.

          • Example image ID: 3b8d6fef-af77-42ab-b8b7-5a7f0f0af8f2
          • Example image URL: http://glance.openstack.example.com/images/3b8d6fef-af77-42ab-b8b7-5a7f0f0af8f2
          • If you use a specified disk as the system disk to create an ECS, this parameter is not required. If you do not use a disk to create an ECS, you must set a valid UUID. Otherwise, the API will return error code 400.
          -
          NOTE:
          • Certain ECS flavors cannot support all public images provided on the public cloud platform. To obtain the images supported by an ECS flavor, log in to the management console, view the images displayed on the Create ECS page, and obtain the image IDs on the Image Management Service page.
          • If the creation fails, modify the parameter settings.
          +
          NOTE:
          • Certain ECS flavors cannot support all public images provided on the cloud service platform. To obtain the images supported by an ECS flavor, log in to the management console, view the images displayed on the Create ECS page, and obtain the image IDs on the Image Management Service page.
          • If the creation fails, modify the parameter settings.

          String

          Specifies the fixed IP address. Parameter port in the three network parameters (port, uuid, and fixed_ip) has the highest priority. If parameter fixed_ip is set, you must specify the UUID.

          +

          Specifies the fixed IP address. Parameter port in the three network parameters (port, uuid, and fixed_ip) has the highest priority. If parameter fixed_ip is set, you must specify the UUID.

          String

          Specifies the time when the ECS was updated last time.

          +

          Specifies the last time when the ECS was updated, such as started, stopped, or restarted.

          The time is in the format of "2019-05-22T03:30:52Z".

          String

          Specifies the ECS name, which is fuzzy matched.

          +

          Periods (.) are supported to match any single characters except \n and \r. A period is equal to [^\n\r].

          status

          diff --git a/docs/ecs/api-ref/en-us_topic_0102606095.html b/docs/ecs/api-ref/en-us_topic_0102606095.html index f633d9905..d6fc5647a 100644 --- a/docs/ecs/api-ref/en-us_topic_0102606095.html +++ b/docs/ecs/api-ref/en-us_topic_0102606095.html @@ -43,7 +43,7 @@

          Array of objects

          Displays the ECSs with all the specified tags. For details, see Table 3.

          -
          • A maximum of 10 keys are included. Each key can have a maximum of 10 values.
          • The structure body must be included.
          • This field cannot be left blank.
          • A key must be unique.
          • Values of the same key must be unique.
          +
          • The structure body must be included.
          • This field cannot be left blank.
          • A key must be unique.
          • Values of the same key must be unique.

          not_tags

          @@ -53,7 +53,7 @@

          Array of strings

          Displays the ECSs with none of specified tags.

          -
          • A maximum of 10 keys are included. Each key can have a maximum of 10 values.
          • The structure body must be included.
          • This field cannot be left blank.
          • Keys must be unique.
          • Values of the same key must be unique.
          +
          • The structure body must be included.
          • This field cannot be left blank.
          • Keys must be unique.
          • Values of the same key must be unique.

          limit

          @@ -128,7 +128,7 @@

          Array of strings

          Specifies the tag value.

          -
          • Each tag contains a maximum of 10 values.
          • Values of the same tag must be unique.
          • Each value contains a maximum of 255 Unicode characters.
          • If this parameter is not specified, any value can be used.
          • The values are in the OR relationship.
          +
          • Values of the same tag must be unique.
          • Each value contains a maximum of 255 Unicode characters.
          • If this parameter is not specified, any value can be used.
          • The values are in the OR relationship.
          -
          Table 7 resource_tag field description

          Parameter

          +
          @@ -305,7 +305,7 @@ "total_count": 1000 } -
          • Response body when action is set to count
            {
            +
            • Response body when action is set to count
              {
                      "total_count": 1000
               }
            diff --git a/docs/ecs/api-ref/en-us_topic_0118308527.html b/docs/ecs/api-ref/en-us_topic_0118308527.html index 63bde4686..842c8c800 100644 --- a/docs/ecs/api-ref/en-us_topic_0118308527.html +++ b/docs/ecs/api-ref/en-us_topic_0118308527.html @@ -271,7 +271,7 @@
          diff --git a/docs/ecs/api-ref/en-us_topic_0167957246.html b/docs/ecs/api-ref/en-us_topic_0167957246.html index d4029631c..9490bc112 100644 --- a/docs/ecs/api-ref/en-us_topic_0167957246.html +++ b/docs/ecs/api-ref/en-us_topic_0167957246.html @@ -168,7 +168,7 @@

          extendparam Field Description for Creating Disks

          This field is used by the following APIs:

          • Creating ECSs /v1/{project_id}/cloudservers
          -
          Table 7 resource_tag field description

          Parameter

          Type

          Specifies ECS tags.

          This parameter is supported in microversion 2.26 and later. If the microversion is not used for query, the response does not contain the tags field.

          -
          Tag functions have been upgraded on the public cloud. After the upgrade, the tag values returned by the system comply with the following rules:
          • The key and value of a tag are connected using an equal sign (=), for example, key=value.
          • If the value is empty, only the key is returned.
          +
          Tag functions have been upgraded on the cloud service platform. After the upgrade, the tag values returned by the system comply with the following rules:
          • The key and value of a tag are connected using an equal sign (=), for example, key=value.
          • If the value is empty, only the key is returned.

          For more details about upgraded tag functions, see Tag Types.

          Table 5 extendparam field description for creating disks

          Parameter

          +
          @@ -188,7 +188,7 @@

          Application scenarios:

          This parameter is used if an ECS is created using a full-ECS image, and the image contains one or more data disks.

          If you use a full-ECS image to create an ECS, the system automatically restores the data type and data from the data disks in the image. The snapshotId parameter allows you to specify the disk type for the original data disk after restoration.

          -
          NOTE:
          • You are advised to set snapshotId for each original data disk. Otherwise, the original data disks without snapshotId specified will use the default settings.
          • If you are required to change a disk size, ensure that the changed disk size is greater than or equal to the size of the original data disk. Otherwise, restoring data of the original data disk will fail.
          +
          NOTE:
          • You are advised to specify snapshotId for each original data disk.
          • If you are required to change a disk size, ensure that the changed disk size is greater than or equal to the size of the original data disk. Otherwise, restoring data of the original data disk will fail.
          • To set disk sharing, you need to specify the sharing attribute.
          • To set disk encryption, you need to specify the encryption attribute in the metadata field.

          Working rules:

          snapshotId uniquely identifies an original data disk contained in a full-ECS image. You can use snapshotId to obtain the information of the original data disk for data restoration.

          @@ -401,7 +401,7 @@
          @@ -449,7 +449,7 @@

          extra_dhcp_opts Field Description

          This field is used by the following APIs:
          • Creating ECSs: /v1/{project_id}/cloudservers
          -
          Table 5 extendparam field description for creating disks

          Parameter

          Mandatory

          Array of strings

          Creates ECSs on a dedicated or shared host.

          -

          The value of this parameter can be dedicated or shared.

          +

          The value of this parameter can be dedicated or shared.

          dedicated_host_id

          @@ -409,7 +409,7 @@

          Array of strings

          Specifies the dedicated host ID.

          -
          NOTE:

          A DeH ID takes effect only when tenancy is set to dedicated.

          +
          NOTE:

          A DeH ID takes effect only when tenancy is set to dedicated.

          Table 12 extra_dhcp_opts field description

          Parameter

          +
          Table 12 extra_dhcp_opts field description

          Parameter

          Mandatory