diff --git a/docs/ecs/dev/ALL_META.TXT.json b/docs/ecs/dev/ALL_META.TXT.json index 101bc813f..899dfbdc9 100644 --- a/docs/ecs/dev/ALL_META.TXT.json +++ b/docs/ecs/dev/ALL_META.TXT.json @@ -13,7 +13,7 @@ "uri":"en-us_topic_0134327704.html", "product_code":"ecs", "code":"2", - "des":"Before using ECS through APIs, learn how to call ECS APIs. For details about how to call REST APIs, see section API Usage Guidelines.", + "des":"Before using ECS through APIs, learn how to call ECS APIs. For details about how to call REST APIs, see API Usage Guidelines.", "doc_type":"devg", "kw":"Notes,Developer Guide", "title":"Notes", diff --git a/docs/ecs/dev/CLASS.TXT.json b/docs/ecs/dev/CLASS.TXT.json index b1484a2c2..aed291e46 100644 --- a/docs/ecs/dev/CLASS.TXT.json +++ b/docs/ecs/dev/CLASS.TXT.json @@ -9,7 +9,7 @@ "code":"1" }, { - "desc":"Before using ECS through APIs, learn how to call ECS APIs. For details about how to call REST APIs, see section API Usage Guidelines.", + "desc":"Before using ECS through APIs, learn how to call ECS APIs. For details about how to call REST APIs, see API Usage Guidelines.", "product_code":"ecs", "title":"Notes", "uri":"en-us_topic_0134327704.html", diff --git a/docs/ecs/dev/en-us_topic_0134192987.html b/docs/ecs/dev/en-us_topic_0134192987.html index 7187eb4a9..b5a23a243 100644 --- a/docs/ecs/dev/en-us_topic_0134192987.html +++ b/docs/ecs/dev/en-us_topic_0134192987.html @@ -40,7 +40,7 @@
  • Select a flavor based on site requirements and record the flavor ID.
  • Determine the image.

    1. View images.
      • API

        URI format: GET /v2/{tenant_id}/images/detail

        -

        For details, see section "Querying Image Details" in Elastic Cloud Server API Reference.

        +

        For details, see section "Querying Image Details" in Elastic Cloud Server API Reference.

      • Request example

        GET: https://{endpoint}/v2/74610f3a5ad941998e91f076297ecf27/images/detail

        Obtain the endpoint from Regions and Endpoints.

      • Response example
        {
        @@ -90,7 +90,7 @@
         
    2. Select an image based on site requirements and record the image ID.

  • Determine the network configuration.

    1. View networks.
      • API

        URI format: GET /v2/{tenant_id}/os-networks

        -

        For details, see section "Querying Networks" in Elastic Cloud Server API Reference.

        +

        For details, see section "Querying Networks" in Elastic Cloud Server API Reference.

      • Request example

        GET: https://{endpoint}/v2/74610f3a5ad941998e91f076297ecf27/os-networks

        Obtain the endpoint from Regions and Endpoints.

      • Response example
        {
        @@ -113,7 +113,7 @@
         
    2. Select a network based on site requirements and record the network ID.

  • Set the login mode to key pair.

    1. Create a key pair.
      • API

        URI format: POST /v2/{tenant_id}/os-keypairs

        -

        For details, see section "Creating and Importing an SSH Key Pair" in Elastic Cloud Server API Reference.

        +

        For details, see section "Creating and Importing an SSH Key Pair" in Elastic Cloud Server API Reference.

      • Request example

        POST: https://{endpoint}/v2/74610f3a5ad941998e91f076297ecf27/os-keypairs

        Obtain the endpoint from Regions and Endpoints.

        Body

        @@ -135,7 +135,7 @@ }
    2. Import the key pair.
      • API

        URI format: POST /v2/{tenant_id}/os-keypairs

        -

        For details, see section "Creating and Importing an SSH Key Pair" in Elastic Cloud Server API Reference.

        +

        For details, see section "Creating and Importing an SSH Key Pair" in Elastic Cloud Server API Reference.

      • Request example

        POST: https://{endpoint}/v2/74610f3a5ad941998e91f076297ecf27/os-keypairs

        Obtain the endpoint from Regions and Endpoints.

        Body

        @@ -160,7 +160,7 @@

      • Create an ECS authenticated using the key pair.

        • API

          URI format: POST /v2/{tenant_id}/servers

          For details about API constraints and request parameters, see section "Creating an ECS" in Elastic Cloud Server API Reference.

          In this example, the ECS is created using a specified image. Therefore,

          -
          • In block_device_mapping_v2, set source_type to image, uuid to the image ID, destination_type to volume, and boot_index to 0.
          • The volume_size must be greater than or equal to the minimum value specified in the image metadata.
          +
          • In block_device_mapping_v2, set source_type to image, uuid to the image ID, destination_type to volume, and boot_index to 0.
          • The volume_size must be greater than or equal to the minimum value specified in the image metadata.
        • Request example

          POST: https://{endpoint}/v2/74610f3a5ad941998e91f076297ecf27/servers

          Obtain the endpoint from Regions and Endpoints.

          @@ -209,7 +209,7 @@ }

      • Verify the ECS creation.

        • API

          URI format: GET /v2/{tenant_id}/servers/{server_id}

          -

          For details, see section "Querying Details About an ECS" in Elastic Cloud Server API Reference.

          +

          For details, see section "Querying Details About an ECS" in Elastic Cloud Server API Reference.

        • Request example

          GET: https://{endpoint}/v2/74610f3a5ad941998e91f076297ecf27/servers/0c71c0da-8852-4c56-a1d1-3a9b9bcb6da6

          Where,

          0c71c0da-8852-4c56-a1d1-3a9b9bcb6da6 is the UUID of the created ECS.

          diff --git a/docs/ecs/dev/en-us_topic_0134192993.html b/docs/ecs/dev/en-us_topic_0134192993.html index 572efe0ff..423cc34f1 100644 --- a/docs/ecs/dev/en-us_topic_0134192993.html +++ b/docs/ecs/dev/en-us_topic_0134192993.html @@ -9,7 +9,7 @@
          • API for modifying the specifications of an ECS
          • API for confirming ECS specifications modification
          • API for rolling back ECS specifications modification

          Procedure

          1. Modify the ECS specifications.

            • API

              URI format: POST /v2/{tenant_id}/servers/{server_id}/action

              -

              For details, see section "Modifying the Specifications of an ECS" in Elastic Cloud Server API Reference.

              +

              For details, see section "Modifying the Specifications of an ECS" in Elastic Cloud Server API Reference.

            • Request example
              {
                   "resize": {
                                 "flavorRef": "4"
              @@ -18,7 +18,7 @@
               
            • Response example

              N/A

          2. Confirm the specifications modification.

            The ECS must be in resized state. That is, the OS-EXT-STS:vm_state value of the ECS must be resized.
            • API

              URI format: POST /v2/{tenant_id}/servers/{server_id}/action

              -

              For details, see section "Confirming ECS Specifications Modification" in Elastic Cloud Server API Reference.

              +

              For details, see section "Confirming ECS Specifications Modification" in Elastic Cloud Server API Reference.

            • Request example
              {
                  "confirmResize": null
               }
              @@ -29,7 +29,7 @@

              The ECS must be in resized state. That is, the OS-EXT-STS:vm_state value of the ECS must be resized.

              The data modified during specifications modification will be lost after the rollback.

              • API

                URI format: POST /v2/{tenant_id}/servers/{server_id}/action

                -

                For details, see section "Rolling Back ECS Specifications Modification" in Elastic Cloud Server API Reference.

                +

                For details, see section "Rolling Back ECS Specifications Modification" in Elastic Cloud Server API Reference.

              • Request example
                {
                     "revertResize": null
                 }
                diff --git a/docs/ecs/dev/en-us_topic_0134193006.html b/docs/ecs/dev/en-us_topic_0134193006.html index 680930346..5899273f7 100644 --- a/docs/ecs/dev/en-us_topic_0134193006.html +++ b/docs/ecs/dev/en-us_topic_0134193006.html @@ -1,15 +1,15 @@

                Microversions

                -

                v2.1 APIs support microversions for small/medium API changes or document changes.

                -

                Users can use a microversion to obtain the latest API microversion supported by a cloud service. A cloud service that has been upgraded to the latest microversion is compatible with the original microversions. Users can also use a microversion to obtain new cloud service properties.

                -

                The version API returns the minimum and maximum microversions. The client uses the two values to specify the microversion range supported by an API.

                +

                v2.1 APIs support microversions for small/medium API changes or document changes.

                +

                Users can use a microversion to obtain the latest API microversion supported by a cloud service. A cloud service that has been upgraded to the latest microversion is compatible with the original microversions. Users can also use a microversion to obtain new cloud service properties.

                +

                The version API returns the minimum and maximum microversions. The client uses the two values to specify the microversion range supported by an API.

                Microversion Response Example

                If the values of version and min_version are null, the endpoint does not support microversions.

                -
                • version: indicates the maximum microversion.
                • min_version: indicates the minimum microversion.
                -

                A microversion on the client must be within the range specified by version and min_version to access the endpoint. The client uses the following HTTP header to specify a microversion:

                -

                X-OpenStack-Nova-API-Version: 2.4

                -

                Since microversion 2.27, the client can also use the following header to specify a microversion:

                -

                Openstack-API-Version: compute 2.27

                +
                • version: indicates the maximum microversion.
                • min_version: indicates the minimum microversion.
                +

                A microversion on the client must be within the range specified by version and min_version to access the endpoint. The client uses the following HTTP header to specify a microversion:

                +

                X-OpenStack-Nova-API-Version: 2.4

                +

                Since microversion 2.27, the client can also use the following header to specify a microversion:

                +

                Openstack-API-Version: compute 2.27

                In the following response example, the maximum microversion is 2.14 and the minimum one is 2.1:

                {
                   "versions": [
                @@ -42,9 +42,8 @@
                   ]
                 }
                -

                Microversion Request Example

                For example, you are required to use the API for details about an ECS to view the OS-EXT-SRV-ATTR:hostname field.

                -
                -
                • Using a v2 API without a microversion
                  • GET: https://{endpoint}/v2/74610f3a5ad941998e91f076297ecf27/servers/detail

                    Obtain the endpoint from Regions and Endpoints.

                    +

                    Microversion Request Example

                    For example, you are required to use the API for details about an ECS to view the OS-EXT-SRV-ATTR:hostname field.

                    +
                    • Using a v2 API without a microversion
                      • GET: https://{endpoint}/v2/74610f3a5ad941998e91f076297ecf27/servers/detail

                        Obtain the endpoint from Regions and Endpoints.

                      • Headers
                        @@ -83,7 +82,7 @@ "metadata": {}, "OS-EXT-STS:task_state": null, "OS-DCF:diskConfig": "MANUAL", - "OS-EXT-AZ:availability_zone": "eu-de-01", + "OS-EXT-AZ:availability_zone":"az1-dc1", "links": [ { "rel": "self", @@ -144,9 +143,9 @@ } ] } -
                      • Conclusion: The response body does not contain the OS-EXT-SRV-ATTR:hostname field.
                      • +
                      • Conclusion: The response body does not contain the OS-EXT-SRV-ATTR:hostname field.
                      • -
                        • Using a v2.1 API with a microversion
                          • GET: https://{endpoint}/v2.1/74610f3a5ad941998e91f076297ecf27/servers/detail

                            Obtain the endpoint from Regions and Endpoints.

                            +
                            • Using a v2.1 API with a microversion
                              • GET: https://{endpoint}/v2.1/74610f3a5ad941998e91f076297ecf27/servers/detail

                                Obtain the endpoint from Regions and Endpoints.

                              • Headers

                        Content-Type

                        @@ -263,9 +262,10 @@ } ] } -
                      • Conclusion: The response body contains the OS-EXT-SRV-ATTR:hostname field.
                      • +
                      • Conclusion: The response body contains the OS-EXT-SRV-ATTR:hostname field.
                      • +
                        - + + +

                        Content-Type

                        2021-10-20

                        +

                        2022-10-30

                        +

                        This issue is the third official release.

                        + +

                        2021-10-20

                        This issue is the second official release.

                        Optimized descriptions in Overview.

                        diff --git a/docs/ecs/dev/public_sys-resources/commonrtl.css b/docs/ecs/dev/public_sys-resources/commonrtl.css index 947a9a033..f261da752 100644 --- a/docs/ecs/dev/public_sys-resources/commonrtl.css +++ b/docs/ecs/dev/public_sys-resources/commonrtl.css @@ -1,2 +1,2 @@ -.msgph{font-family:Courier New}.unresolved{background-color:#87ceeb}.noTemplate{background-color:#ff0}.base{background-color:#fff}/*! Add space for top level topics */.nested0,.p{margin-top:1em}/*! div with class=p is used for paragraphs that contain blocks, to keep the XHTML valid *//*! Default of italics to set apart figure captions */.figcap,.italic,.var{font-style:italic}.figdesc{font-style:normal}/*! Use @frame to create frames on figures */.figborder{padding-left:3px;padding-right:3px;margin-top:1em;border:2px solid Silver}.figsides{margin-top:1em;padding-left:3px;padding-right:3px;border-left:2px solid Silver;border-right:2px solid Silver}.figtop{border-top:2px solid Silver;margin-top:1em}.figbottom{border-bottom:2px solid Silver}.figtopbot{border-top:2px solid Silver;border-bottom:2px solid Silver;margin-top:1em}/*! Most link groups are created with
                        . Ensure they have space before and after. */.ullinks,ul.simple{list-style-type:none}.attention,.danger,.ddexpand,.dlexpand,.example,.fastpath,.important,.liexpand,.linklist,.note,.notice,.olchildlink,.relconcepts,.relinfo,.relref,.reltasks,.remember,.restriction,.section,.sliexpand,.stepexpand,.substepexpand,.tip,.ulchildlink,.warning{margin-top:1em;margin-bottom:1em}.linklistwithchild,.sublinklist{margin-top:1em;margin-right:1.5em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-right:20px}/*! Set heading sizes, getting smaller for deeper nesting */.topictitle1{font-size:1.34em;margin-top:0;margin-bottom:.1em}.topictitle2,.topictitle3,.topictitle4,.topictitle5,.topictitle6,.sectiontitle{font-size:1.17em}.topictitle2{margin-top:1pc;margin-bottom:.45em}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-weight:700}.topictitle4{margin-top:.83em;font-weight:700}.topictitle5{font-weight:700}.topictitle6{font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:0;color:#000;font-weight:700}/*! All note formats have the same default presentation */.attentiontitle,.bold,.cautiontitle,.dangertitle,.dlterm,.fastpathtitle,.firstcol,.importanttitle,.notelisttitle,.notetitle,.noticetitle,.parmname,.remembertitle,.restrictiontitle,.tiptitle,.uicontrol,.warningtitle{font-weight:700}.caution{font-weight:700;margin-bottom:1em}/*! Simple lists do not get a bullet *//*! Used on the first column of a table, when rowheader="firstcol" is used *//*! Various basic phrase styles */.boldItalic{font-weight:700;font-style:italic}.shortcut,.underlined{text-decoration:underline}/*! 2008-10-27 keyword采用跟随上下文的样式 +/*! Copyright (c) Huawei Technologies Co., Ltd. 2020-2022. All rights reserved. */.msgph{font-family:Courier New}.unresolved{background-color:#87ceeb}.noTemplate{background-color:#ff0}.base{background-color:#fff}/*! Add space for top level topics */.nested0,.p{margin-top:1em}/*! div with class=p is used for paragraphs that contain blocks, to keep the XHTML valid *//*! Default of italics to set apart figure captions */.figcap,.italic,.var{font-style:italic}.figdesc{font-style:normal}/*! Use @frame to create frames on figures */.figborder{padding-left:3px;padding-right:3px;margin-top:1em;border:2px solid Silver}.figsides{margin-top:1em;padding-left:3px;padding-right:3px;border-left:2px solid Silver;border-right:2px solid Silver}.figtop{border-top:2px solid Silver;margin-top:1em}.figbottom{border-bottom:2px solid Silver}.figtopbot{border-top:2px solid Silver;border-bottom:2px solid Silver;margin-top:1em}/*! Most link groups are created with
                        . Ensure they have space before and after. */.ullinks,ul.simple{list-style-type:none}.attention,.danger,.ddexpand,.dlexpand,.example,.fastpath,.important,.liexpand,.linklist,.note,.notice,.olchildlink,.relconcepts,.relinfo,.relref,.reltasks,.remember,.restriction,.section,.sliexpand,.stepexpand,.substepexpand,.tip,.ulchildlink,.warning{margin-top:1em;margin-bottom:1em}.linklistwithchild,.sublinklist{margin-top:1em;margin-right:1.5em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-right:20px}/*! Set heading sizes, getting smaller for deeper nesting */.topictitle1{font-size:1.34em;margin-top:0;margin-bottom:.1em}.topictitle2,.topictitle3,.topictitle4,.topictitle5,.topictitle6,.sectiontitle{font-size:1.17em}.topictitle2{margin-top:1pc;margin-bottom:.45em}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-weight:700}.topictitle4{margin-top:.83em;font-weight:700}.topictitle5{font-weight:700}.topictitle6{font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:0;color:#000;font-weight:700}/*! All note formats have the same default presentation */.attentiontitle,.bold,.cautiontitle,.dangertitle,.dlterm,.fastpathtitle,.firstcol,.importanttitle,.notelisttitle,.notetitle,.noticetitle,.parmname,.remembertitle,.restrictiontitle,.tiptitle,.uicontrol,.warningtitle{font-weight:700}.caution{font-weight:700;margin-bottom:1em}/*! Simple lists do not get a bullet *//*! Used on the first column of a table, when rowheader="firstcol" is used *//*! Various basic phrase styles */.boldItalic{font-weight:700;font-style:italic}.shortcut,.underlined{text-decoration:underline}/*! 2008-10-27 keyword采用跟随上下文的样式 *//*! Default of bold for definition list terms *//*! Use CSS to expand lists with @compact="no" */.dltermexpand{font-weight:700;margin-top:1em}[compact="yes"]>li{margin-top:0}[compact="no"]>li{margin-top:.53em}/*! Align images based on @align on topic/image */div.imageleft,.text-align-left{text-align:left}div.imagecenter,.text-align-center{text-align:center}div.imageright,.text-align-right{text-align:right}div.imagejustify,.text-align-justify{text-align:justify}.cellrowborder{border-right:0;border-top:0;border-left:1px solid;border-bottom:1px solid}.row-nocellborder{border-left:hidden;border-right:0;border-top:0;border-bottom:1px solid}.cell-norowborder{border-top:0;border-bottom:hidden;border-right:0;border-left:1px solid}.nocellnorowborder{border:0;border-left:hidden;border-bottom:hidden}pre.codeblock,pre.screen{padding:5px;border:outset;background-color:#ccc;margin-top:2px;margin-bottom:2px;white-space:pre} \ No newline at end of file diff --git a/docs/ecs/dev/public_sys-resources/imageclose.gif b/docs/ecs/dev/public_sys-resources/imageclose.gif index 56818c26b..3a3344af4 100644 Binary files a/docs/ecs/dev/public_sys-resources/imageclose.gif and b/docs/ecs/dev/public_sys-resources/imageclose.gif differ diff --git a/docs/ecs/dev/public_sys-resources/imageclosehover.gif b/docs/ecs/dev/public_sys-resources/imageclosehover.gif index 3bcf231f1..8699d5e36 100644 Binary files a/docs/ecs/dev/public_sys-resources/imageclosehover.gif and b/docs/ecs/dev/public_sys-resources/imageclosehover.gif differ diff --git a/docs/ecs/dev/public_sys-resources/imagemax.gif b/docs/ecs/dev/public_sys-resources/imagemax.gif index 49fe390b1..99c07dc25 100644 Binary files a/docs/ecs/dev/public_sys-resources/imagemax.gif and b/docs/ecs/dev/public_sys-resources/imagemax.gif differ diff --git a/docs/ecs/dev/public_sys-resources/imagemaxhover.gif b/docs/ecs/dev/public_sys-resources/imagemaxhover.gif index 387b0a981..d01d77d6e 100644 Binary files a/docs/ecs/dev/public_sys-resources/imagemaxhover.gif and b/docs/ecs/dev/public_sys-resources/imagemaxhover.gif differ diff --git a/docs/ecs/dev/public_sys-resources/macFFBgHack.png b/docs/ecs/dev/public_sys-resources/macFFBgHack.png index c6473b324..ec811470c 100644 Binary files a/docs/ecs/dev/public_sys-resources/macFFBgHack.png and b/docs/ecs/dev/public_sys-resources/macFFBgHack.png differ