From bcdc2ecfaa560eab33a6fd031a18cb338a4f958a Mon Sep 17 00:00:00 2001 From: "Zaoxu, Li" Date: Fri, 12 Jan 2024 14:27:11 +0000 Subject: [PATCH] DEH API update1026 Reviewed-by: Pristromskaia, Margarita Co-authored-by: Zaoxu, Li Co-committed-by: Zaoxu, Li --- docs/deh/api-ref/ALL_META.TXT.json | 253 ++++++++++++++++++- docs/deh/api-ref/CLASS.TXT.json | 16 +- docs/deh/api-ref/deh_02_0019.html | 165 ++++++------ docs/deh/api-ref/deh_02_0020.html | 261 ++++++++----------- docs/deh/api-ref/deh_02_0021.html | 108 ++++---- docs/deh/api-ref/deh_02_0022.html | 206 +++++++-------- docs/deh/api-ref/deh_02_0023.html | 62 ++--- docs/deh/api-ref/deh_02_0024.html | 22 +- docs/deh/api-ref/deh_02_0025.html | 74 +++--- docs/deh/api-ref/deh_02_0028.html | 103 ++++---- docs/deh/api-ref/deh_05_0801.html | 84 +++--- docs/deh/api-ref/deh_05_0802.html | 84 +++--- docs/deh/api-ref/deh_05_0901.html | 61 ++--- docs/deh/api-ref/deh_05_0902.html | 61 ++--- docs/deh/api-ref/deh_05_0903.html | 44 ++-- docs/deh/api-ref/deh_05_0904.html | 323 ++++++++++++------------ docs/deh/api-ref/deh_appendix_0003.html | 16 +- 17 files changed, 1076 insertions(+), 867 deletions(-) diff --git a/docs/deh/api-ref/ALL_META.TXT.json b/docs/deh/api-ref/ALL_META.TXT.json index 8490209a..cd748d0f 100644 --- a/docs/deh/api-ref/ALL_META.TXT.json +++ b/docs/deh/api-ref/ALL_META.TXT.json @@ -1,261 +1,498 @@ [ + { + "dockw":"API Reference" + }, { "uri":"deh_02_0001.html", + "node_id":"deh_02_0001.xml", "product_code":"deh", "code":"1", "des":"Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform ", "doc_type":"api", "kw":"API Usage Guidelines,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"API Usage Guidelines", "githuburl":"" }, { "uri":"deh_02_0017.html", + "node_id":"deh_02_0017.xml", "product_code":"deh", "code":"2", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"API", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"API", "githuburl":"" }, { "uri":"deh_02_0019.html", + "node_id":"deh_02_0019.xml", "product_code":"deh", "code":"3", "des":"This API is used to allocate one or more DeHs and set required parameters, such as the flavor, AZ, and quantity.The number of allocatable DeHs depends on the DeH quota ow", "doc_type":"api", "kw":"Allocating DeHs,API,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Allocating DeHs", "githuburl":"" }, { "uri":"deh_02_0020.html", + "node_id":"deh_02_0020.xml", "product_code":"deh", "code":"4", - "des":"This API is used to query the DeH list.GET /v1.0/{project_id}/dedicated-hostsTable 1 describes the parameters.Request parametersYou can add parameters host_type, host_typ", + "des":"This API is used to query the DeH list.GET /v1.0/{project_id}/dedicated-hostsTable 1 describes the parameters.You can add parameters host_type, host_type_name, flavor, de", "doc_type":"api", "kw":"Querying DeHs,API,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Querying DeHs", "githuburl":"" }, { "uri":"deh_02_0021.html", + "node_id":"deh_02_0021.xml", "product_code":"deh", "code":"5", - "des":"This API is used to query details about a DeH.GET /v1.0/{project_id}/dedicated-hosts/{dedicated_host_id}Table 1 describes the parameters.Request parametersNoneNoneExample", + "des":"This API is used to query details about a DeH.GET /v1.0/{project_id}/dedicated-hosts/{dedicated_host_id}Table 1 describes the parameters.NoneSee Status Codes.", "doc_type":"api", "kw":"Querying Details About a DeH,API,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Querying Details About a DeH", "githuburl":"" }, { "uri":"deh_02_0022.html", + "node_id":"deh_02_0022.xml", "product_code":"deh", "code":"6", - "des":"This API is used to query information about deployed ECSs on a DeH.GET /v1.0/{project_id}/dedicated-hosts/{dedicated_host_id}/serversTable 1 describes the parameters.Requ", + "des":"This API is used to query information about deployed ECSs on a DeH.GET /v1.0/{project_id}/dedicated-hosts/{dedicated_host_id}/serversTable 1 describes the parameters.See ", "doc_type":"api", "kw":"Querying ECSs on a DeH,API,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Querying ECSs on a DeH", "githuburl":"" }, { "uri":"deh_02_0023.html", + "node_id":"deh_02_0023.xml", "product_code":"deh", "code":"7", - "des":"This API is used to modify the auto_placement and name attributes of a DeH.PUT /v1.0/{project_id}/dedicated-hosts/{dedicated_host_id}Table 1 describes the parameters.Requ", + "des":"This API is used to modify the auto_placement and name attributes of a DeH.PUT /v1.0/{project_id}/dedicated-hosts/{dedicated_host_id}Table 1 describes the parameters.None", "doc_type":"api", "kw":"Modifying DeH Attributes,API,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Modifying DeH Attributes", "githuburl":"" }, { "uri":"deh_02_0024.html", + "node_id":"deh_02_0024.xml", "product_code":"deh", "code":"8", "des":"This API is used to release a DeH.A DeH accommodating ECSs cannot be released.DELETE /v1.0/{project_id}/dedicated-hosts/{dedicated_host_id}Table 1 describes the parameter", "doc_type":"api", "kw":"Releasing a DeH,API,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Releasing a DeH", "githuburl":"" }, { "uri":"deh_02_0025.html", + "node_id":"deh_02_0025.xml", "product_code":"deh", "code":"9", - "des":"This API is used to query available DeH types in an AZ.Get /v1.0/{project_id}/availability-zone/{availability_zone}/dedicated-host-typesTable 1 describes the parameters.R", + "des":"This API is used to query available DeH types in an AZ.Get /v1.0/{project_id}/availability-zone/{availability_zone}/dedicated-host-typesTable 1 describes the parameters.N", "doc_type":"api", "kw":"Querying Available DeH Types,API,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Querying Available DeH Types", "githuburl":"" }, { "uri":"deh_05_0800.html", + "node_id":"deh_05_0800.xml", "product_code":"deh", "code":"10", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"API Version Query", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"API Version Query", "githuburl":"" }, { "uri":"deh_05_0801.html", + "node_id":"deh_05_0801.xml", "product_code":"deh", "code":"11", - "des":"This API is used to query all API versions available to the DeH service.GET /Request parametersNoneNoneExample requestGET /Response parametersResponse parametersParameter", + "des":"This API is used to query all API versions available to the DeH service.GET /NoneSee Status Codes.", "doc_type":"api", "kw":"Querying API Versions,API Version Query,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Querying API Versions", "githuburl":"" }, { "uri":"deh_05_0802.html", + "node_id":"deh_05_0802.xml", "product_code":"deh", "code":"12", - "des":"This API is used to query a specified API version.GET /{api_version}Table 1 describes the parameters.Request parametersNoneNoneExample requestGET /v1.0Response parameters", + "des":"This API is used to query a specified API version.GET /{api_version}Table 1 describes the parameters.NoneSee Status Codes.", "doc_type":"api", "kw":"Querying an API Version,API Version Query,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Querying an API Version", "githuburl":"" }, { "uri":"deh_05_0900.html", + "node_id":"deh_05_0900.xml", "product_code":"deh", "code":"13", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"DeH Tag Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"DeH Tag Management", "githuburl":"" }, { "uri":"deh_05_0901.html", + "node_id":"deh_05_0901.xml", "product_code":"deh", "code":"14", "des":"This API is used to add tags to a specified DeH in batches.Tag Management Service (TMS) uses this API to batch add tags to a DeH.A DeH allows a maximum of 10 tags.This AP", "doc_type":"api", "kw":"Adding Tags to a DeH in Batches,DeH Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Adding Tags to a DeH in Batches", "githuburl":"" }, { "uri":"deh_05_0902.html", + "node_id":"deh_05_0902.xml", "product_code":"deh", "code":"15", "des":"This API is used to delete tags from a specified DeH in batches.Tag Management Service (TMS) uses this API to batch delete tags from a DeH.A DeH allows a maximum of 10 ta", "doc_type":"api", "kw":"Deleting Tags from a DeH in Batches,DeH Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Deleting Tags from a DeH in Batches", "githuburl":"" }, { "uri":"deh_05_0903.html", + "node_id":"deh_05_0903.xml", "product_code":"deh", "code":"16", "des":"This API is used to query tags of a DeH.Tag Management Service (TMS) uses this API to query all tags of a DeH.GET /v1.0/{project_id}/dedicated-host-tags/{dedicated_host_i", "doc_type":"api", "kw":"Querying Tags of a DeH,DeH Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Querying Tags of a DeH", "githuburl":"" }, { "uri":"deh_05_0904.html", + "node_id":"deh_05_0904.xml", "product_code":"deh", "code":"17", "des":"This API is used to filter DeHs by tag and return the list of all tags of a DeH.Tag Management Service (TMS) uses this API to filter the DeHs.POST /v1.0/{project_id}/dedi", "doc_type":"api", "kw":"Querying DeHs by Tag,DeH Tag Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Querying DeHs by Tag", "githuburl":"" }, { "uri":"deh_02_0026.html", + "node_id":"deh_02_0026.xml", "product_code":"deh", "code":"18", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Quota Configuration", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Quota Configuration", "githuburl":"" }, { "uri":"deh_02_0028.html", + "node_id":"deh_02_0028.xml", "product_code":"deh", "code":"19", - "des":"This API is used to query the DeH quota of a tenant.GET /v1.0/{project_id}/quota-sets/{tenant_id}Table 1 describes the parameters.Request parametersYou can add the resour", + "des":"This API is used to query the DeH quota of a tenant.GET /v1.0/{project_id}/quota-sets/{tenant_id}Table 1 describes the parameters.You can add the resource parameter to th", "doc_type":"api", "kw":"Querying the DeH Quota of a Tenant,Quota Configuration,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Querying the DeH Quota of a Tenant", "githuburl":"" }, { "uri":"deh_06_0001.html", + "node_id":"deh_06_0001.xml", "product_code":"deh", "code":"20", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Permissions and Actions", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Permissions and Actions", "githuburl":"" }, { "uri":"deh_06_0002.html", + "node_id":"deh_06_0002.xml", "product_code":"deh", "code":"21", "des":"This section describes fine-grained permissions management for your DeHs. If your account does not need individual IAM users, you may skip over this section.By default, n", "doc_type":"api", "kw":"Permissions and Supported Actions,Permissions and Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Permissions and Supported Actions", "githuburl":"" }, { "uri":"deh_07_0101.html", + "node_id":"deh_07_0101.xml", "product_code":"deh", "code":"22", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"API Permissions,Permissions and Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"API Permissions", "githuburl":"" }, { "uri":"deh_02_0015.html", + "node_id":"deh_02_0015.xml", "product_code":"deh", "code":"23", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Public Parameters", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Public Parameters", "githuburl":"" }, { "uri":"deh_02_0018.html", + "node_id":"deh_02_0018.xml", "product_code":"deh", "code":"24", "des":"DeH management includes querying the DeH list, viewing DeH details, modifying DeH attributes, allocating a DeH, and releasing a DeH.", "doc_type":"api", "kw":"Object Models,Public Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Object Models", "githuburl":"" }, { "uri":"deh_02_0016.html", + "node_id":"deh_02_0016.xml", "product_code":"deh", "code":"25", "des":"NormalReturned ValueDescription200 OKThe request has been successfully processed.201 CreatedThe request has been successfully processed and a resource has been created.20", "doc_type":"api", "kw":"Status Codes,Public Parameters,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Status Codes", "githuburl":"" }, { "uri":"deh_appendix_0003.html", + "node_id":"deh_appendix_0003.xml", "product_code":"deh", "code":"26", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Change History,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"ims", + "opensource":"true" + } + ], "title":"Change History", "githuburl":"" } diff --git a/docs/deh/api-ref/CLASS.TXT.json b/docs/deh/api-ref/CLASS.TXT.json index b10ecffb..7e1fbeec 100644 --- a/docs/deh/api-ref/CLASS.TXT.json +++ b/docs/deh/api-ref/CLASS.TXT.json @@ -27,7 +27,7 @@ "code":"3" }, { - "desc":"This API is used to query the DeH list.GET /v1.0/{project_id}/dedicated-hostsTable 1 describes the parameters.Request parametersYou can add parameters host_type, host_typ", + "desc":"This API is used to query the DeH list.GET /v1.0/{project_id}/dedicated-hostsTable 1 describes the parameters.You can add parameters host_type, host_type_name, flavor, de", "product_code":"deh", "title":"Querying DeHs", "uri":"deh_02_0020.html", @@ -36,7 +36,7 @@ "code":"4" }, { - "desc":"This API is used to query details about a DeH.GET /v1.0/{project_id}/dedicated-hosts/{dedicated_host_id}Table 1 describes the parameters.Request parametersNoneNoneExample", + "desc":"This API is used to query details about a DeH.GET /v1.0/{project_id}/dedicated-hosts/{dedicated_host_id}Table 1 describes the parameters.NoneSee Status Codes.", "product_code":"deh", "title":"Querying Details About a DeH", "uri":"deh_02_0021.html", @@ -45,7 +45,7 @@ "code":"5" }, { - "desc":"This API is used to query information about deployed ECSs on a DeH.GET /v1.0/{project_id}/dedicated-hosts/{dedicated_host_id}/serversTable 1 describes the parameters.Requ", + "desc":"This API is used to query information about deployed ECSs on a DeH.GET /v1.0/{project_id}/dedicated-hosts/{dedicated_host_id}/serversTable 1 describes the parameters.See ", "product_code":"deh", "title":"Querying ECSs on a DeH", "uri":"deh_02_0022.html", @@ -54,7 +54,7 @@ "code":"6" }, { - "desc":"This API is used to modify the auto_placement and name attributes of a DeH.PUT /v1.0/{project_id}/dedicated-hosts/{dedicated_host_id}Table 1 describes the parameters.Requ", + "desc":"This API is used to modify the auto_placement and name attributes of a DeH.PUT /v1.0/{project_id}/dedicated-hosts/{dedicated_host_id}Table 1 describes the parameters.None", "product_code":"deh", "title":"Modifying DeH Attributes", "uri":"deh_02_0023.html", @@ -72,7 +72,7 @@ "code":"8" }, { - "desc":"This API is used to query available DeH types in an AZ.Get /v1.0/{project_id}/availability-zone/{availability_zone}/dedicated-host-typesTable 1 describes the parameters.R", + "desc":"This API is used to query available DeH types in an AZ.Get /v1.0/{project_id}/availability-zone/{availability_zone}/dedicated-host-typesTable 1 describes the parameters.N", "product_code":"deh", "title":"Querying Available DeH Types", "uri":"deh_02_0025.html", @@ -90,7 +90,7 @@ "code":"10" }, { - "desc":"This API is used to query all API versions available to the DeH service.GET /Request parametersNoneNoneExample requestGET /Response parametersResponse parametersParameter", + "desc":"This API is used to query all API versions available to the DeH service.GET /NoneSee Status Codes.", "product_code":"deh", "title":"Querying API Versions", "uri":"deh_05_0801.html", @@ -99,7 +99,7 @@ "code":"11" }, { - "desc":"This API is used to query a specified API version.GET /{api_version}Table 1 describes the parameters.Request parametersNoneNoneExample requestGET /v1.0Response parameters", + "desc":"This API is used to query a specified API version.GET /{api_version}Table 1 describes the parameters.NoneSee Status Codes.", "product_code":"deh", "title":"Querying an API Version", "uri":"deh_05_0802.html", @@ -162,7 +162,7 @@ "code":"18" }, { - "desc":"This API is used to query the DeH quota of a tenant.GET /v1.0/{project_id}/quota-sets/{tenant_id}Table 1 describes the parameters.Request parametersYou can add the resour", + "desc":"This API is used to query the DeH quota of a tenant.GET /v1.0/{project_id}/quota-sets/{tenant_id}Table 1 describes the parameters.You can add the resource parameter to th", "product_code":"deh", "title":"Querying the DeH Quota of a Tenant", "uri":"deh_02_0028.html", diff --git a/docs/deh/api-ref/deh_02_0019.html b/docs/deh/api-ref/deh_02_0019.html index 923729de..415ad414 100644 --- a/docs/deh/api-ref/deh_02_0019.html +++ b/docs/deh/api-ref/deh_02_0019.html @@ -32,85 +32,85 @@ -

Request

  • Request parameters -
    Table 2 Request parameters

    Parameter

    +

    Request

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -118,45 +118,70 @@
    Table 2 Request parameters

    Parameter

    In

    +

    In

    Type

    +

    Type

    Mandatory

    +

    Mandatory

    Description

    +

    Description

    name

    +

    name

    body

    +

    body

    String

    +

    String

    Yes

    +

    Yes

    Specifies the DeH name.

    +

    Specifies the DeH name.

    auto_placement

    +

    auto_placement

    body

    +

    body

    String

    +

    String

    No

    +

    No

    Specifies whether to allow an ECS to be placed on any available DeH if its DeH ID is not specified during its creation.

    +

    Specifies whether to allow an ECS to be placed on any available DeH if its DeH ID is not specified during its creation.

    The value can be on or off.

    The default value is on.

    availability_zone

    +

    availability_zone

    body

    +

    body

    String

    +

    String

    Yes

    +

    Yes

    Specifies the AZ to which the DeH belongs.

    +

    Specifies the AZ to which the DeH belongs.

    host_type

    +

    host_type

    body

    +

    body

    String

    +

    String

    Yes

    +

    Yes

    Specifies the DeH type.

    +

    Specifies the DeH type.

    quantity

    +

    quantity

    body

    +

    body

    Integer

    +

    Integer

    Yes

    +

    Yes

    Specifies the number of allocatable DeHs.

    +

    Specifies the number of allocatable DeHs.

    tags

    +

    tags

    body

    +

    body

    Array of objects

    +

    Array of objects

    No

    +

    No

    Specifies the DeH tags.

    +

    Specifies the DeH tags.

    For details, see Table 3.
    -
    Table 3 tag field description

    Parameter

    +
    - - - - - - - - - - -
    Table 3 tag field description

    Parameter

    Type

    +

    Type

    Mandatory

    +

    Mandatory

    Description

    +

    Description

    key

    +

    key

    String

    +

    String

    Yes

    +

    Yes

    Specifies the tag key.

    +

    Specifies the tag key.

    • It contains a maximum of 36 Unicode characters.
    • The value cannot be empty.
    • It cannot contain the following ASCII characters: =*<>\|/,
    • It can contain letters, digits, hyphens (-), and underscores (_).

    value

    +

    value

    String

    +

    String

    Yes

    +

    Yes

    Specifies the tag value.

    +

    Specifies the tag value.

    • It contains a maximum of 43 Unicode characters.
    • It cannot contain the following ASCII characters: =*<>\|/,
    • It can contain letters, digits, hyphens (-), and underscores (_).
    -
  • Example request
    POST https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-hosts
+
+
    Response
    
+
    
+
+
+
+
+
+
+
+
+
+
+
+
    Table 4 Response parameters
    Parameter
    
+
    In
    
+
    Type
    
+
    Description
    
+
    dedicated_host_ids
    
+
    body
    
+
    Array of strings
    
+
    Specifies a group of IDs of allocated DeHs. The tenant can create ECSs on these DeHs.
    
+
    
+
    
+
    
+
    Example Request
    Two s3 DeHs are allocated in az1, and the DeH name is General Computing server1.
    POST https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-hosts
 {
      "availability_zone": "dc1.az1",
-     "name": "high performance servers1",
+     "name": "General-Purpose server1",
      "auto_placement": "off",
-     "host_type": "h1",
+     "host_type":"s2",
      "quantity": 2,
      "tags": [
          {
@@ -165,51 +190,27 @@
          }
      ] 
 }
    
-
    • -

    Response

    • Response parameters -
      - - - - - - - - - - - -
      Table 4 Response parameters

      Parameter

      -

      In

      -

      Type

      -

      Description

      -

      dedicated_host_ids

      -

      body

      -

      Array of strings

      -

      Specifies a group of IDs of allocated DeHs. The tenant can create ECSs on these DeHs.

      -
      -
    • Example response
      {
+
      Example Response
      {
     "dedicated_host_ids": ["xxxxxxx1","xxxxxxx2"]
 }
      
-

    Status Code

    -
    Table 5 Returned error codes

    Error Code

    +
    - - - - - diff --git a/docs/deh/api-ref/deh_02_0020.html b/docs/deh/api-ref/deh_02_0020.html index a50dadd5..fc5f6c21 100644 --- a/docs/deh/api-ref/deh_02_0020.html +++ b/docs/deh/api-ref/deh_02_0020.html @@ -30,175 +30,164 @@
    Table 5 Returned error codes

    Error Code

    Description

    +

    Description

    403 Forbidden

    +

    403 Forbidden

    1. Insufficient quota.
    2. The flavor is not supported.
    +
    1. Insufficient quota.
    2. The flavor is not supported.

    404 FlavorNotFound

    +

    404 FlavorNotFound

    Invalid flavor.

    +

    Invalid flavor.
    -

    Request

    • Request parameters

      You can add parameters host_type, host_type_name, flavor, dedicated_host_id, state, tenant, availability_zone, name, limit, marker, tags, instance_uuid, released_at, or changes-since to the URI to filter the search result,

      +

      Request

      You can add parameters host_type, host_type_name, flavor, dedicated_host_id, state, tenant, availability_zone, name, limit, marker, tags, instance_uuid, or changes-since to the URI to filter the search result,

      for example, /v1.0/{project_id}/dedicated-hosts?host_type={host_type}&state={state}.

      -
      Table 2 Request parameters

      Parameter

      +
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Table 2 Request parameters

      Parameter

      In

      +

      In

      Type

      +

      Type

      Mandatory

      +

      Mandatory

      Description

      +

      Description

      dedicated_host_id

      +

      dedicated_host_id

      query

      +

      query

      String

      +

      String

      No

      +

      No

      Specifies the DeH ID.

      +

      Specifies the DeH ID.

      name

      +

      name

      query

      +

      query

      String

      +

      String

      No

      +

      No

      Specifies the DeH name.

      +

      Specifies the DeH name.

      host_type

      +

      host_type

      query

      +

      query

      String

      +

      String

      No

      +

      No

      Specifies the DeH type.

      +

      Specifies the DeH type.

      host_type_name

      +

      host_type_name

      query

      +

      query

      String

      +

      String

      No

      +

      No

      Specifies the name of the DeH type.

      +

      Specifies the name of the DeH type.

      flavor

      +

      flavor

      query

      +

      query

      String

      +

      String

      No

      +

      No

      Specifies the flavor ID.

      +

      Specifies the flavor ID.

      state

      +

      state

      query

      +

      query

      String

      +

      String

      No

      +

      No

      Specifies the DeH status.

      +

      Specifies the DeH status.

      The value can be available, fault, or released.

      tenant

      +

      tenant

      query

      +

      query

      String

      +

      String

      No

      +

      No

      The value can be a tenant ID or all.

      +

      The value can be a tenant ID or all.

      Only users with the DeH administrator permissions can specify this parameter.

      availability_zone

      +

      availability_zone

      query

      +

      query

      String

      +

      String

      No

      +

      No

      Specifies the AZ to which the DeH belongs.

      +

      Specifies the AZ to which the DeH belongs.

      limit

      +

      limit

      query

      +

      query

      String

      +

      String

      No

      +

      No

      Specifies the number of records displayed per page.

      +

      Specifies the number of records displayed per page.

      marker

      +

      marker

      query

      +

      query

      String

      +

      String

      No

      +

      No

      Specifies the ID of the last record on the previous page. If the marker value is invalid, status code 400 is returned.

      +

      Specifies the ID of the last record on the previous page. If the marker value is invalid, status code 400 is returned.

      tags

      +

      tags

      query

      +

      query

      String

      +

      String

      No

      +

      No

      Specifies the DeH tags.

      +

      Specifies the DeH tags.

      instance_uuid

      +

      instance_uuid

      query

      +

      query

      String

      +

      String

      No

      +

      No

      Specifies the ID of the ECS on the DeH.

      +

      Specifies the ID of the ECS on the DeH.

      released_at

      +

      changes-since

      query

      +

      query

      String

      +

      String

      No

      +

      No

      Specifies the time when the DeH is released.

      -

      changes-since

      -

      query

      -

      String

      -

      No

      -

      Filters the response by date and timestamp when the DeH status changes. To help keep track of changes, this parameter may also display recently deleted DeHs.

      +

      Filters the response by date and timestamp when the DeH status changes. To help keep track of changes, this parameter may also display recently deleted DeHs.

      The format of the date and timestamp is ISO 8601:

      CCYY-MM-DDThh:mm:ss±hh:mm

      If the hh:mm value is included, the time zone is returned as the UTC offset, for example, 2015-08-27T09:49:58-05:00. If you omit the time zone, the UTC time zone is assumed.

      @@ -207,118 +196,90 @@
      -
    • Example request
      GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-hosts?state=available
      -
      • -

      Response

      • Response parameters -
        Table 3 Response parameters

        Parameter

        +

        Response

        +
        - - - - - - - - - - -
        Table 3 Response parameters

        Parameter

        In

        +

        In

        Type

        +

        Type

        Description

        +

        Description

        dedicated_hosts

        +

        dedicated_hosts

        body

        +

        body

        Array of objects

        +

        Array of objects

        Specifies the DeHs that meet the search criteria.

        +

        Specifies the DeHs that meet the search criteria.

        For details, see Table 1.

        total

        +

        total

        body

        +

        body

        Integer

        +

        Integer

        Specifies the quantity of DeHs that meet the search criteria.

        +

        Specifies the quantity of DeHs that meet the search criteria.
        -
      • Example response
        {
+
        • +

        Example Request

        Query the DeHs in the available state.
        GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-hosts?state=available
        +
        +
        +

        Example Response

        {
     "dedicated_hosts": [
         {
-            "dedicated_host_id": "ab910cf0daebca90c4001",
-            "name": "high performance servers1",
+            "dedicated_host_id": "d465d0ae-f859-4a83-a508-8db654c05e7e",
+            "name": "DEH001",
             "auto_placement": "off",
-            "availability_zone": "az1",
+            "availability_zone": "eu-de-01",
             "host_properties": {
-                "vcpus": 36,
-                "cores": 12,
+                "vcpus": 74,
+                "cores": 22,
                 "sockets": 2,
-                "memory": 1073741824,
-                "host_type": "h1",
-                "host_type_name": "High performance",
+                "memory": 303104,
+                "host_type": "c4",
+                "host_type_name": "dedicated_general_purpose",
                 "available_instance_capacities": [
                     {
-                        "flavor": "h1.large"
+                        "flavor": "c4.large.4"
                     },
                     {
-                        "flavor": "h1.2large"
+                        "flavor": "c4.xlarge.4"
                     },
                     {
-                        "flavor": "h1.4large"
+                        "flavor": "c4.2xlarge.4"
                     },
                     {
-                        "flavor": "h1.8large"
+                        "flavor": "c4.3xlarge.4"
+                    },
+                    {
+                        "flavor": "c4.6xlarge.4"
+                    },
+                    {
+                        "flavor": "c4.16xlarge.4"
                     }
                 ]
             },
             "state": "available",
             "project_id": "9c53a566cb3443ab910cf0daebca90c4",
             "available_vcpus": 20,
-            "available_memory": 1073201821,
-            "instance_total": 2,
+            "available_memory": 81920,
+            "instance_total": 5,
             "allocated_at": "2016-10-10T14:35:47Z",
             "released_at": null
-            },
-        {
-            "dedicated_host_id": "ab910cf0daebca90c4002",
-            "name": "high performance servers2",
-            "auto_placement": "off",
-            "availability_zone": "az1",
-            "host_properties": {
-                "vcpus": 36,
-                "cores": 12,
-                "sockets": 2,
-                "host_type": "h1",
-                "host_type_name": "High performance",
-                "memory": 1073741824,
-                "available_instance_capacities": [
-                    {
-                        "flavor": "h1.large"
-                    },
-                    {
-                        "flavor": "h1.2large"
-                    },
-                    {
-                        "flavor": "h1.4large"
-                    },
-                    {
-                        "flavor": "h1.8large"
-                    }
-                ]
-            },
-            "state": "available",
-            "project_id": "9c53a566cb3443ab910cf0daebca90c4",
-            "available_vcpus": 20,
-            "available_memory": 1073101821,
-            "instance_total": 3,
-            "allocated_at": "2016-10-10T14:35:47Z",
-            "released_at": null
-            },
+            }
             ],
-    "total": 25
+    "total": 1
 }
        -

        Status Code

        See Status Codes.

        diff --git a/docs/deh/api-ref/deh_02_0021.html b/docs/deh/api-ref/deh_02_0021.html index 25346b71..0ef4eae4 100644 --- a/docs/deh/api-ref/deh_02_0021.html +++ b/docs/deh/api-ref/deh_02_0021.html @@ -33,83 +33,89 @@

        Yes

        Specifies the DeH ID.

        -

        You can obtain the DeH ID from the DeH console or using the Querying DeHs API.

        +

        You can obtain the value from the DeH console or using the API in Querying DeHs.
      -

      Request

      • Request parameters

        None

        -
      • Example request
        GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-hosts/ab910cf0daebca90c4001
        -
      +

      Request

      None

      -

      Response

      • Response parameters -
        Table 2 Response parameters

        Parameter

        +

        Response

        +
        - - - - - - -
        Table 2 Response parameters

        Parameter

        In

        +

        In

        Type

        +

        Type

        Description

        +

        Description

        dedicated_host

        +

        dedicated_host

        body

        +

        body

        Object

        +

        Object

        Specifies the DeH object.

        +

        Specifies the DeH object.

        For details, see Table 1.
        -
      • Example response
        {
+
        • +

        Example Request

        GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-hosts/ab910cf0daebca90c4001
        +
        +

        Example Response

        {
     "dedicated_host": {
-        "dedicated_host_id": "ab910cf0daebca90c4001",
-        "name": "win_2008 servers",
-        "auto_placement": "off",
-        "availability_zone": "az1",
-        "host_properties": {
-            "vcpus": 36,
-            "cores": 12,
-            "sockets": 2,
-            "memory": 1073741824,
-            "host_type": "h1",
-            "host_type_name": "High performance",
-            "available_instance_capacities": [
-                {
-                    "flavor": "h1.large"
-                },
-                {
-                    "flavor": "h1.2large"
-                },
-                {
-                    "flavor": "h1.4large"
-                },
-                {
-                    "flavor": "h1.8large"
-                }
-            ]
-        },
-        "state": "available",
-        "project_id": "9c53a566cb3443ab910cf0daebca90c4",
-        "available_vcpus": 20,
-        "available_memory": 1073201821,
-        "instance_total": 2,
-        "allocated_at": "2016-10-10T14:35:47Z",
-        "released_at": null,
-        "instance_uuids": [
-            "erf5th66cb3443ab912ff0daebca3456",
-            "23457h66cb3443ab912ff0daebcaer45"
+            "dedicated_host_id": "d465d0ae-f859-4a83-a508-8db654c05e7e",
+            "name": "DEH001",
+            "auto_placement": "off",
+            "availability_zone": "eu-de-01",
+            "host_properties": {
+                "vcpus": 74,
+                "cores": 22,
+                "sockets": 2,
+                "memory": 303104,
+                "host_type": "c4",
+                "host_type_name": "dedicated_general_purpose",
+                "available_instance_capacities": [
+                    {
+                        "flavor": "c4.large.4"
+                    },
+                    {
+                        "flavor": "c4.xlarge.4"
+                    },
+                    {
+                        "flavor": "c4.2xlarge.4"
+                    },
+                    {
+                        "flavor": "c4.3xlarge.4"
+                    },
+                    {
+                        "flavor": "c4.6xlarge.4"
+                    },
+                    {
+                        "flavor": "c4.16xlarge.4"
+                    }
+                ]
+            },
+            "state": "available",
+            "project_id": "9c53a566cb3443ab910cf0daebca90c4",
+            "available_vcpus": 20,
+            "available_memory": 81920,
+            "instance_total": 5,
+            "allocated_at": "2016-10-10T14:35:47Z",
+            "released_at": null
+			"instance_uuids": [
+				"erf5th66cb3443ab912ff0daebca3456",
+				"23457h66cb3443ab912ff0daebcaer45"
         ]
     }
 }
        -

        Status Code

        See Status Codes.

        diff --git a/docs/deh/api-ref/deh_02_0022.html b/docs/deh/api-ref/deh_02_0022.html index 8f76e72e..939944e1 100644 --- a/docs/deh/api-ref/deh_02_0022.html +++ b/docs/deh/api-ref/deh_02_0022.html @@ -33,276 +33,277 @@

        Yes

        Specifies the DeH ID.

        -

        You can obtain the DeH ID from the DeH console or using the Querying DeHs API.

        +

        You can obtain the value from the DeH console or using the API in Querying DeHs.
      -

      Request

      • Request parameters -
        Table 2 Request parameters

        Parameter

        +

        Request

        +
        - - - - - - - - - - - - - -
        Table 2 Request parameters

        Parameter

        In

        +

        In

        Type

        +

        Type

        Mandatory

        +

        Mandatory

        Description

        +

        Description

        limit

        +

        limit

        query

        +

        query

        String

        +

        String

        No

        +

        No

        Specifies the number of records displayed per page.

        +

        Specifies the number of records displayed per page.

        marker

        +

        marker

        query

        +

        query

        String

        +

        String

        No

        +

        No

        Specifies the ID of the last record on the previous page. If the marker value is invalid, status code 400 is returned.

        +

        Specifies the ID of the last record on the previous page. If the marker value is invalid, status code 400 is returned.
        -
      • Example request
        GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-hosts/ab910cf0daebca90c4001/servers
        -
        • -

        Response

        • Response parameters -
          Table 3 Response parameters

          Parameter

          +

          Response

          +
          - - - - - - -
          Table 3 Response parameters

          Parameter

          In

          +

          In

          Type

          +

          Type

          Description

          +

          Description

          servers

          +

          servers

          body

          +

          body

          Array of objects

          +

          Array of objects

          Specifies the server object. For details, see Table 4.

          +

          Specifies the server object. For details, see Table 4.
          -
          Table 4 servers field description

          Parameter

          +
          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          Table 4 servers field description

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          addresses

          +

          addresses

          Map<String, Object>

          +

          Map<String, Object>

          Specifies the network addresses of an ECS.

          +

          Specifies the network addresses of an ECS.

          The structure is Map<String, Object>.

          • The key indicates the VPC subnet ID.
          • The value indicates the network attributes specified in Table 5.

          created

          +

          created

          String

          +

          String

          Specifies the time when the ECS was created.

          +

          Specifies the time when the ECS was created.

          flavor

          +

          flavor

          Object

          +

          Object

          Specifies the ECS flavor. For details, see Table 6.

          +

          Specifies the ECS flavor. For details, see Table 6.

          id

          +

          id

          String

          +

          String

          Specifies the ECS ID in UUID format.

          +

          Specifies the ECS ID in UUID format.

          name

          +

          name

          String

          +

          String

          Specifies the ECS name.

          +

          Specifies the ECS name.

          status

          +

          status

          String

          +

          String

          Specifies the ECS status.

          +

          Specifies the ECS status.

          Options:

          ACTIVE, BUILD, DELETED, ERROR, HARD_REBOOT, MIGRATING, PASSWORD, PAUSED, REBOOT, REBUILD, RESIZE, REVERT_RESIZE, SHUTOFF, SHELVED, SHELVED_OFFLOADED, SOFT_DELETED, SUSPENDED, and VERIFY_RESIZE

          tenant_id

          +

          tenant_id

          String

          +

          String

          Specifies the ECS tenant ID in UUID format.

          +

          Specifies the ECS tenant ID in UUID format.

          updated

          +

          updated

          String

          +

          String

          Specifies the time when the ECS was updated last time.

          +

          Specifies the time when the ECS was updated last time.

          user_id

          +

          user_id

          String

          +

          String

          Specifies the ID of the user who has created the ECS. The value is in UUID format.

          +

          Specifies the ID of the user who has created the ECS. The value is in UUID format.

          task_state

          +

          task_state

          String

          +

          String

          Specifies the ECS task status.

          +

          Specifies the ECS task status.

          image

          +

          image

          Object

          +

          Object

          Specifies the ECS image. For details, see Table 7.

          +

          Specifies the ECS image. For details, see Table 7.

          metadata

          +

          metadata

          Object

          +

          Object

          Specifies the ECS metadata. For details, see Table 8.

          +

          Specifies the ECS metadata. For details, see Table 8.
          -
          Table 5 Data structure of the network to which an ECS accesses

          Parameter

          +
          - - - - - - - - - - - - - -
          Table 5 Data structure of the network to which an ECS accesses

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          addr

          +

          addr

          String

          +

          String

          Specifies the IP address.

          +

          Specifies the IP address.

          version

          +

          version

          Integer

          +

          Integer

          Specifies the type of an IP address. The value of this parameter can be 4 or 6.

          +

          Specifies the type of an IP address. The value of this parameter can be 4 or 6.

          • 4: The type of the IP address is IPv4.
          • 6: The type of the IP address is IPv6.

          OS-EXT-IPS-MAC:mac_addr

          +

          OS-EXT-IPS-MAC:mac_addr

          String

          +

          String

          Specifies the MAC address. This is an extended attribute.

          +

          Specifies the MAC address. This is an extended attribute.

          OS-EXT-IPS:type

          +

          OS-EXT-IPS:type

          String

          +

          String

          Specifies the IP address assignment mode. This is an extended attribute.

          +

          Specifies the IP address assignment mode. This is an extended attribute.
          -
          Table 6 flavor field description

          Parameter

          +
          - - - - -
          Table 6 flavor field description

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          id

          +

          id

          String

          +

          String

          Specifies the flavor ID.

          +

          Specifies the flavor ID.
          -
          Table 7 image field description

          Parameter

          +
          - - - - -
          Table 7 image field description

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          id

          +

          id

          String

          +

          String

          Specifies the image UUID.

          +

          Specifies the image UUID.
          -
          Table 8 metadata field description

          Parameter

          +
          - - - - -
          Table 8 metadata field description

          Parameter

          Type

          +

          Type

          Description

          +

          Description

          os_type

          +

          os_type

          String

          +

          String

          Specifies the OS type.

          +

          Specifies the OS type.
          -
        • Example response
          {
+
+
          Example Request
          GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-hosts/ab910cf0daebca90c4001/servers
          
+
          
+
          Example Response
          {
     "servers": [
         {
           "addresses": {
@@ -325,7 +326,7 @@
             }, 
             "name": "new-server-test", 
             "status": "ACTIVE", 
-            "tenant_id": "openstack", 
+            "tenant_id": "a90b2728805d4240a72cc2eeb4e1244d", 
             "updated": "2012-09-07T16:56:37Z", 
             "user_id": "fake",
             "task_state": "",
@@ -335,7 +336,6 @@
         }
     ]
 }
          
-

          • Status Code

          See Status Codes.

          diff --git a/docs/deh/api-ref/deh_02_0023.html b/docs/deh/api-ref/deh_02_0023.html index df5e1b1c..e63ee499 100644 --- a/docs/deh/api-ref/deh_02_0023.html +++ b/docs/deh/api-ref/deh_02_0023.html @@ -33,86 +33,88 @@

          Yes

          Specifies the DeH ID.

          -

          You can obtain the DeH ID from the DeH console or using the Querying DeHs API.

          +

          You can obtain the value from the DeH console or using the API in Querying DeHs.
          -

          Request

          • Request parameters -
            Table 2 Request parameters

            Parameter

            +

            Request

            +
            - - - - - - - +
            Table 2 Request parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description
            dedicated_host

            Yes

            +

            dedicated_host

            Object

            +

            Yes

            Specifies the dedicated host. For details, see Table 3.

            +

            Object

            +

            Specifies the dedicated host. For details, see Table 3.
            -
            Table 3 dedicated_host field data structure description

            Parameter

            +
            - - - - - - - - - - - - - -
            Table 3 dedicated_host field data structure description

            Parameter

            Location

            +

            Location

            Type

            +

            Type

            Mandatory

            +

            Mandatory

            Description

            +

            Description

            auto_placement

            +

            auto_placement

            in

            +

            in

            String

            +

            String

            No

            +

            No

            Specifies whether to allow an ECS to be placed on any available DeH if its DeH ID is not specified during its creation.

            +

            Specifies whether to allow an ECS to be placed on any available DeH if its DeH ID is not specified during its creation.

            The value can be on or off.

            name

            +

            name

            in

            +

            in

            String

            +

            String

            No

            +

            No

            Specifies the DeH name.

            +

            Specifies the DeH name.
            -
          • Example request
            PUT https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-hosts/74259164-e63a-4ad9-9c77-a1bd2c9aa187
+
+
            Response
            None
            
+
            
+
            Example Request
            Set auto_placement to off to not allow an ECS to be placed on any available DeH. Change the name of the DeH to DeH_vm3.
            PUT https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-hosts/74259164-e63a-4ad9-9c77-a1bd2c9aa187
 {
     "dedicated_host": {
         "auto_placement": "off",
         "name": "DeH_vm3"
     }
 }
            
-
            • -

            Response

            • Response parameters

              None

              -
            • Example response
              Http Response Code: 204
              -
            +
            +

            Example Response

            Http Response Code: 204

            Status Code

            See Status Codes.

            diff --git a/docs/deh/api-ref/deh_02_0024.html b/docs/deh/api-ref/deh_02_0024.html index c095e736..af06f485 100644 --- a/docs/deh/api-ref/deh_02_0024.html +++ b/docs/deh/api-ref/deh_02_0024.html @@ -35,31 +35,31 @@

            Yes

            Specifies the DeH ID.

            -

            You can obtain the DeH ID from the DeH console or using the Querying DeHs API.

            +

            You can obtain the value from the DeH console or using the API in Querying DeHs.
            -

            Request

            • Request parameters

              None

              -
            • Example request
              DELETE https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-hosts/74259164-e63a-4ad9-9c77-a1bd2c9aa187
              -
            +

            Request

            None

            -

            Response

            • Response parameters

              None

              -
            • Example response
              Http Response Code: 204
              -
            +

            Response

            None

            +
            +

            Example Request

            DELETE https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-hosts/74259164-e63a-4ad9-9c77-a1bd2c9aa187
            +
            +

            Example Response

            Http Response Code: 204

            Status Code

            -
            Table 2 Returned error codes

            Error Code

            +
            - - - diff --git a/docs/deh/api-ref/deh_02_0025.html b/docs/deh/api-ref/deh_02_0025.html index c0c169c6..d310fe75 100644 --- a/docs/deh/api-ref/deh_02_0025.html +++ b/docs/deh/api-ref/deh_02_0025.html @@ -39,80 +39,72 @@
            Table 2 Returned error codes

            Error Code

            Description

            +

            Description

            409 Conflict

            +

            409 Conflict

            A DeH accommodating ECSs cannot be released.

            +

            A DeH accommodating ECSs cannot be released.
            -

            Request

            • Request parameters

              None

              -
            • Example request
              GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/availability-zone/az1/dedicated-host-types
              -
            +

            Request

            None

            -

            Response

            • Response parameters -
              Table 2 Response parameters

              Parameter

              +

              Response

              +
              - - - - - - -
              Table 2 Response parameters

              Parameter

              In

              +

              In

              Type

              +

              Type

              Description

              +

              Description

              dedicated_host_types

              +

              dedicated_host_types

              body

              +

              body

              Array of objects

              +

              Array of objects

              Specifies the available DeH types. For details, see Table 3.

              +

              Specifies the available DeH types. For details, see Table 3.
              -
              Table 3 dedicated_host_types field description

              Parameter

              +
              - - - - - - - -
              Table 3 dedicated_host_types field description

              Parameter

              Type

              +

              Type

              Description

              +

              Description

              host_type

              +

              host_type

              String

              +

              String

              Specifies the DeH type.

              +

              Specifies the DeH type.

              host_type_name

              +

              host_type_name

              String

              +

              String

              Specifies the name of the DeH type.

              +

              Specifies the name of the DeH type.
              -
            • Example response
              {
-    "dedicated_host_types": [
-        {
-            "host_type": "General",
-            "host_type_name": "General Computing"
-        },
-        {
-            "host_type": "m1",
-            "host_type_name": "Memory-optimized"
-        },
-        {
-            "host_type": "h2",
-            "host_type_name": "High performance"
-        },
-        {
-            "host_type": "d1",
-            "host_type_name": "Disk intensive"
-        }
-    ]
+
+
              Example Request
              GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/availability-zone/az1/dedicated-host-types
              
+
              
+
              Example Response
              {
+ "dedicated_host_types": [
+  {
+   "host_type": "c4",
+   "host_type_name": "dedicated_general_purpose"
+  },
+  {
+   "host_type": "m4",
+   "host_type_name": "memory_optimized"
+  }
+ ]
 }
              
-

              • Status Code

              See Status Codes.

              diff --git a/docs/deh/api-ref/deh_02_0028.html b/docs/deh/api-ref/deh_02_0028.html index 26aead9f..9ca858e4 100644 --- a/docs/deh/api-ref/deh_02_0028.html +++ b/docs/deh/api-ref/deh_02_0028.html @@ -33,59 +33,57 @@

              Yes

              Specifies the tenant ID.

              -

              You can obtain the DeH ID from the DeH console or using the Querying DeHs API.

              +

              You can obtain the value from the DeH console or using the API in Querying DeHs.
              -

              Request

              • Request parameters

                You can add the resource parameter to the URI. For example:

                +

                Request

                You can add the resource parameter to the URI. For example:

                /v1.0/{project_id}/quota-sets/{tenant_id}?resource={resource}

                -
                Table 2 Request parameters

                Parameter

                +
                - - - - - - - - -
                Table 2 Request parameters

                Parameter

                Location

                +

                Location

                Type

                +

                Type

                Mandatory

                +

                Mandatory

                Description

                +

                Description

                resource

                +

                resource

                query

                +

                query

                String

                +

                String

                No

                +

                No

                Specifies the resource type.

                +

                Specifies the resource type.
                -
              • Example request
                GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/quota-sets/45df5566cb3443ab910cf0daebcapoi8
                -
                • -

                Response

                • Response parameters -
                  Table 3 Response parameters

                  Parameter

                  +

                  Response

                  +
                  - - - - - @@ -93,64 +91,55 @@
                  Table 3 Response parameters

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  quota_set

                  +

                  quota_set

                  Array of objects

                  +

                  Array of objects

                  Specifies the quota set of a DeH.

                  +

                  Specifies the quota set of a DeH.

                  For details, see Table 4.
                  -
                  Table 4 quota_set field description

                  Parameter

                  +
                  - - - - - - - - - - -
                  Table 4 quota_set field description

                  Parameter

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  resource

                  +

                  resource

                  String

                  +

                  String

                  Specifies the resource type.

                  +

                  Specifies the resource type.

                  hard_limit

                  +

                  hard_limit

                  Integer

                  +

                  Integer

                  Specifies the quota limit.

                  +

                  Specifies the quota limit.

                  -1 indicates that the resource quota is not limited.

                  used

                  +

                  used

                  Integer

                  +

                  Integer

                  Specifies the used amount of the quota.

                  +

                  Specifies the used amount of the quota.
                  -
                • Example response
                  {
-    "quota_set": [
-        {
-            "resource": "c1",
-            "hard_limit": 5,
-            "used": 2
-        },
-        {
-            "resource": "m1",
-            "hard_limit": 5,
-            "used": 0
-        },
-        {
-            "resource": "h1",
-            "hard_limit": 5,
-            "used": 2
-        },
-        {
-            "resource": "d1",
-            "hard_limit": 5,
-            "used": 2
-        }
-    ]
+
+
                  Example Request
                  GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/quota-sets/45df5566cb3443ab910cf0daebcapoi8
                  
+
                  
+
                  Example Response
                  {
+ "quota_set": [
+  {
+   "used": 0,
+   "resource": "c4",
+   "hard_limit": 5
+  },
+  {
+   "used": 0,
+   "resource": "m4",
+   "hard_limit": 5
+  }]
 }
                  
-

                  • Status Code

                  See Status Codes.

                  diff --git a/docs/deh/api-ref/deh_05_0801.html b/docs/deh/api-ref/deh_05_0801.html index f5057c1f..c6bfeb64 100644 --- a/docs/deh/api-ref/deh_05_0801.html +++ b/docs/deh/api-ref/deh_05_0801.html @@ -5,111 +5,112 @@

                  URI

                  GET /

                  -

                  Request

                  • Request parameters

                    None

                    -
                  • Example request
                    GET /
                    -
                  +

                  Request

                  None

                  -

                  Response

                  • Response parameters -
                    Table 1 Response parameters

                    Parameter

                    +

                    Response

                    +
                    - - - - -
                    Table 1 Response parameters

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    versions

                    +

                    versions

                    Array of objects

                    +

                    Array of objects

                    Specifies the API versions.

                    +

                    Specifies the API versions.
                    -
                    Table 2 versions field description

                    Parameter

                    +
                    - - - - - - - - - - - - - - - - - - - -
                    Table 2 versions field description

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    id

                    +

                    id

                    String

                    +

                    String

                    Specifies the ID of the API version.

                    +

                    Specifies the ID of the API version.

                    links

                    +

                    links

                    Array of objects

                    +

                    Array of objects

                    Specifies the URL of the API version.

                    +

                    Specifies the URL of the API version.

                    min_version

                    +

                    min_version

                    String

                    +

                    String

                    Specifies the microversion. If the APIs of this version support micro-versions, set this parameter to the supported minimum micro-version. If the microversion is not supported, leave this parameter blank.

                    +

                    Specifies the microversion. If the APIs of this version support micro-versions, set this parameter to the supported minimum micro-version. If the microversion is not supported, leave this parameter blank.

                    status

                    +

                    status

                    String

                    +

                    String

                    Specifies the API version status.

                    +

                    Specifies the API version status.

                    • CURRENT: indicates a primary version.
                    • SUPPORTED: indicates an earlier version which is still supported.
                    • DEPRECATED: indicates a deprecated version which may be deleted later.

                    updated

                    +

                    updated

                    String

                    +

                    String

                    Specifies the API version update time, which must be UTC time.

                    +

                    Specifies the API version update time, which must be UTC time.

                    version

                    +

                    version

                    String

                    +

                    String

                    If the APIs of this version support micro-versions, set this parameter to the maximum micro-version supported. If not, leave this parameter blank.

                    +

                    If the APIs of this version support micro-versions, set this parameter to the maximum micro-version supported. If not, leave this parameter blank.
                    -
                    Table 3 links field description

                    Parameter

                    +
                    - - - - - - - -
                    Table 3 links field description

                    Parameter

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    href

                    +

                    href

                    String

                    +

                    String

                    Specifies the URL of the API version.

                    +

                    Specifies the URL of the API version.

                    rel

                    +

                    rel

                    String

                    +

                    String

                    Specifies the API URL dependency.

                    +

                    Specifies the API URL dependency.
                    -
                  • Example response
                    {
+
+
                    Example Request
                    GET /
                    
+
                    
+
                    Example Response
                    {
     "versions": [
         {
             "id": "v1.0",
@@ -126,7 +127,6 @@
         }
     ]
 }
                    
-

                    • Status Code

                    See Status Codes.

                    diff --git a/docs/deh/api-ref/deh_05_0802.html b/docs/deh/api-ref/deh_05_0802.html index 017ea156..f18c2267 100644 --- a/docs/deh/api-ref/deh_05_0802.html +++ b/docs/deh/api-ref/deh_05_0802.html @@ -25,111 +25,112 @@
                    -

                    Request

                    • Request parameters

                      None

                      -
                    • Example request
                      GET /v1.0
                      -
                    +

                    Request

                    None

                    -

                    Response

                    • Response parameters -
                      Table 2 Response parameters

                      Parameter

                      +

                      Response

                      +
                      - - - - -
                      Table 2 Response parameters

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      version

                      +

                      version

                      Object

                      +

                      Object

                      Specifies information about a specified API version.

                      +

                      Specifies information about a specified API version.
                      -
                      Table 3 version field description

                      Parameter

                      +
                      - - - - - - - - - - - - - - - - - - - -
                      Table 3 version field description

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      id

                      +

                      id

                      String

                      +

                      String

                      Specifies the ID of the API version.

                      +

                      Specifies the ID of the API version.

                      links

                      +

                      links

                      Array of objects

                      +

                      Array of objects

                      Specifies the URL of the API version.

                      +

                      Specifies the URL of the API version.

                      min_version

                      +

                      min_version

                      String

                      +

                      String

                      Specifies the microversion. If the APIs of this version support micro-versions, set this parameter to the supported minimum micro-version. If the microversion is not supported, leave this parameter blank.

                      +

                      Specifies the microversion. If the APIs of this version support micro-versions, set this parameter to the supported minimum micro-version. If the microversion is not supported, leave this parameter blank.

                      status

                      +

                      status

                      String

                      +

                      String

                      Specifies the API version status.

                      +

                      Specifies the API version status.

                      • CURRENT: indicates a primary version.
                      • SUPPORTED: indicates an earlier version which is still supported.
                      • DEPRECATED: indicates a deprecated version which may be deleted later.

                      updated

                      +

                      updated

                      String

                      +

                      String

                      Specifies the API version update time.

                      +

                      Specifies the API version update time.

                      version

                      +

                      version

                      String

                      +

                      String

                      If the APIs of this version support micro-versions, set this parameter to the maximum micro-version supported. If not, leave this parameter blank.

                      +

                      If the APIs of this version support micro-versions, set this parameter to the maximum micro-version supported. If not, leave this parameter blank.
                      -
                      Table 4 links field description

                      Parameter

                      +
                      - - - - - - - -
                      Table 4 links field description

                      Parameter

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      href

                      +

                      href

                      String

                      +

                      String

                      Specifies the URL of the API version.

                      +

                      Specifies the URL of the API version.

                      rel

                      +

                      rel

                      String

                      +

                      String

                      Specifies the API URL dependency.

                      +

                      Specifies the API URL dependency.
                      -
                    • Example response
                      {
+
+
                      Example Request
                      GET /v1.0
                      
+
                      
+
                      Example Response
                      {
     "version": {
         "id": "v1.0",
         "links": [
@@ -144,7 +145,6 @@
         "version": ""
     }
 }
                      
-

                      • Status Code

                      See Status Codes.

                      diff --git a/docs/deh/api-ref/deh_05_0901.html b/docs/deh/api-ref/deh_05_0901.html index 32cc1628..f7e05f76 100644 --- a/docs/deh/api-ref/deh_05_0901.html +++ b/docs/deh/api-ref/deh_05_0901.html @@ -37,80 +37,83 @@

                      Yes

                      Specifies the DeH ID.

                      -

                      You can obtain the DeH ID from the DeH console or using the Querying DeHs API.

                      +

                      You can obtain the value from the DeH console or using the API in Querying DeHs.
                      -

                      Request

                      • Request parameters -
                        Table 2 Request parameters

                        Parameter

                        +

                        Request

                        +
                        - - - - - - - - - - -
                        Table 2 Request parameters

                        Parameter

                        Type

                        +

                        Type

                        Mandatory

                        +

                        Mandatory

                        Description

                        +

                        Description

                        tags

                        +

                        tags

                        Array of objects

                        +

                        Array of objects

                        Yes

                        +

                        Yes

                        Specifies the tag list. For details, see Table 3.

                        +

                        Specifies the tag list. For details, see Table 3.

                        action

                        +

                        action

                        String

                        +

                        String

                        Yes

                        +

                        Yes

                        Specifies the operation. Only lowercase letters are supported. For example, create indicates the creation operation.

                        +

                        Specifies the operation. Only lowercase letters are supported. For example, create indicates the creation operation.
                        -
                        Table 3 tag field description

                        Parameter

                        +
                        - - - - - - - - - - -
                        Table 3 tag field description

                        Parameter

                        Type

                        +

                        Type

                        Mandatory

                        +

                        Mandatory

                        Description

                        +

                        Description

                        key

                        +

                        key

                        String

                        +

                        String

                        Yes

                        +

                        Yes

                        Specifies the tag key.

                        +

                        Specifies the tag key.

                        • It contains a maximum of 36 Unicode characters.
                        • The value cannot be empty.
                        • It cannot contain the following ASCII characters: =*<>\|/,
                        • It can contain letters, digits, hyphens (-), and underscores (_).

                        value

                        +

                        value

                        String

                        +

                        String

                        Yes

                        +

                        Yes

                        Specifies the tag value.

                        +

                        Specifies the tag value.

                        • It contains a maximum of 43 Unicode characters.
                        • It cannot contain the following ASCII characters: =*<>\|/,
                        • It can contain letters, digits, hyphens (-), and underscores (_).
                        -
                      • Example request
                        POST https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-host-tags/74259164-e63a-4ad9-9c77-a1bd2c9aa187/tags/action
                        + +

                        Response

                        N/A

                        +
                        +

                        Example Request

                        Add two tags to a DeH in a batch. The keys and corresponding values for these two tags are as follows: key1 and value1; key2 and value2
                        POST https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-host-tags/74259164-e63a-4ad9-9c77-a1bd2c9aa187/tags/action
                        {
     "action": "create",
     "tags": [
@@ -124,9 +127,9 @@
         }
     ]
 }
                        -
                        • -

                        Response

                        N/A

                        +
                        +

                        Example Response

                        N/A

                        Status Code

                        See Status Codes.

                        diff --git a/docs/deh/api-ref/deh_05_0902.html b/docs/deh/api-ref/deh_05_0902.html index 78222515..63993314 100644 --- a/docs/deh/api-ref/deh_05_0902.html +++ b/docs/deh/api-ref/deh_05_0902.html @@ -36,81 +36,84 @@

                        Yes

                        Specifies the DeH ID.

                        -

                        You can obtain the DeH ID from the DeH console or using the Querying DeHs API.

                        +

                        You can obtain the value from the DeH console or using the API in Querying DeHs.
                        -

                        Request

                        • Request parameters -
                          Table 2 Request parameters

                          Parameter

                          +

                          Request

                          +
                          - - - - - - - - - - -
                          Table 2 Request parameters

                          Parameter

                          Type

                          +

                          Type

                          Mandatory

                          +

                          Mandatory

                          Description

                          +

                          Description

                          tags

                          +

                          tags

                          Array of objects

                          +

                          Array of objects

                          Yes

                          +

                          Yes

                          Specifies the tag list.

                          +

                          Specifies the tag list.

                          For details, see Table 3.

                          action

                          +

                          action

                          String

                          +

                          String

                          Yes

                          +

                          Yes

                          Specifies the operation. Only lowercase letters are supported. For example, delete indicates the deletion operation.

                          +

                          Specifies the operation. Only lowercase letters are supported. For example, delete indicates the deletion operation.
                          -
                          Table 3 tag field description

                          Parameter

                          +
                          - - - - - - - - - - -
                          Table 3 tag field description

                          Parameter

                          Type

                          +

                          Type

                          Mandatory

                          +

                          Mandatory

                          Description

                          +

                          Description

                          key

                          +

                          key

                          String

                          +

                          String

                          Yes

                          +

                          Yes

                          Specifies the tag key.

                          +

                          Specifies the tag key.

                          • It contains a maximum of 36 Unicode characters.
                          • The value cannot be empty.
                          • It cannot contain the following ASCII characters: =*<>\|/,
                          • It can contain letters, digits, hyphens (-), and underscores (_).

                          value

                          +

                          value

                          String

                          +

                          String

                          Yes

                          +

                          Yes

                          Specifies the tag value.

                          +

                          Specifies the tag value.

                          • It contains a maximum of 43 Unicode characters.
                          • It cannot contain the following ASCII characters: =*<>\|/,
                          • It can contain letters, digits, hyphens (-), and underscores (_).
                          -
                        • Example request
                          POST https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-host-tags/74259164-e63a-4ad9-9c77-a1bd2c9aa187/tags/action
                          + +

                          Response

                          N/A

                          +
                          +

                          Example Request

                          Delete two tags from a DeH in a batch. The keys and corresponding values for these two tags are as follows: key1 and value1; key2 and value2
                          POST https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-host-tags/74259164-e63a-4ad9-9c77-a1bd2c9aa187/tags/action
                          {
     "action": "delete",
     "tags": [
@@ -124,9 +127,9 @@
         }
     ]
 }
                          -
                          • -

                          Response

                          N/A

                          +
                          +

                          Example Response

                          N/A

                          Status Code

                          See Status Codes.

                          diff --git a/docs/deh/api-ref/deh_05_0903.html b/docs/deh/api-ref/deh_05_0903.html index 551e0500..49c5d68c 100644 --- a/docs/deh/api-ref/deh_05_0903.html +++ b/docs/deh/api-ref/deh_05_0903.html @@ -34,31 +34,29 @@

                          Yes

                          Specifies the DeH ID.

                          -

                          You can obtain the DeH ID from the DeH console or using the Querying DeHs API.

                          +

                          You can obtain the value from the DeH console or using the API in Querying DeHs.
                          -

                          Request

                          • Request parameters

                            None

                            -
                          • Example request
                            GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-host-tags/74259164-e63a-4ad9-9c77-a1bd2c9aa187/tags
                            -
                          +

                          Request

                          None

                          -

                          Response

                          • Response parameters -
                            Table 2 Response parameters

                            Parameter

                            +

                            Response

                            +
                            - - - - - @@ -66,32 +64,35 @@
                            Table 2 Response parameters

                            Parameter

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            tags

                            +

                            tags

                            Array of objects

                            +

                            Array of objects

                            Specifies the list of tags.

                            +

                            Specifies the list of tags.

                            For details, see Table 3.
                            -
                            Table 3 tag field description

                            Parameter

                            +
                            - - - - - - - -
                            Table 3 tag field description

                            Parameter

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            key

                            +

                            key

                            String

                            +

                            String

                            Specifies the tag key.

                            +

                            Specifies the tag key.

                            value

                            +

                            value

                            String

                            +

                            String

                            Specifies the tag value.

                            +

                            Specifies the tag value.
                            -
                          • Example response
                            {
+
+
                            Example Request
                            GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-host-tags/74259164-e63a-4ad9-9c77-a1bd2c9aa187/tags
                            
+
                            
+
                            Example Response
                            {
     "tags": [
         {
             "key": "key1", 
@@ -103,7 +104,6 @@
         }
     ]
 }
                            
-

                            • Status Code

                            See Status Codes.

                            diff --git a/docs/deh/api-ref/deh_05_0904.html b/docs/deh/api-ref/deh_05_0904.html index 90e51ad2..de5e3994 100644 --- a/docs/deh/api-ref/deh_05_0904.html +++ b/docs/deh/api-ref/deh_05_0904.html @@ -31,95 +31,95 @@
                            -

                            Request

                            • Request parameters -
                              Table 2 Request parameters

                              Parameter

                              +

                              Request

                              +
                              - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -127,33 +127,33 @@
                              Table 2 Request parameters

                              Parameter

                              Type

                              +

                              Type

                              Mandatory

                              +

                              Mandatory

                              Description

                              +

                              Description

                              tags

                              +

                              tags

                              Array of objects

                              +

                              Array of objects

                              No

                              +

                              No

                              Displays all DeHs with specified tags. For more information, see Table 3.

                              +

                              Displays all DeHs with specified tags. For more information, see Table 3.

                              • A maximum of 10 keys can be included. Each key can have a maximum of 10 values.
                              • The structure body must be included.
                              • The tag key cannot be left blank or set to an empty string.
                              • A key must be unique.
                              • Values of the same key must be unique.

                              not_tags

                              +

                              not_tags

                              Array of objects

                              +

                              Array of objects

                              No

                              +

                              No

                              Displays the DeHs with none of specified tags. For more information, see Table 3.

                              +

                              Displays the DeHs with none of specified tags. For more information, see Table 3.

                              • A maximum of 10 keys can be included. Each key can have a maximum of 10 values.
                              • The structure body must be included.
                              • The tag key cannot be left blank or set to an empty string.
                              • Keys must be unique.
                              • Values of the same key must be unique.

                              limit

                              +

                              limit

                              Integer

                              +

                              Integer

                              No

                              +

                              No

                              Limits the maximum number of queried DeHs. The value cannot be a negative number. The maximum value is 1000.

                              +

                              Limits the maximum number of queried DeHs. The value cannot be a negative number. The maximum value is 1000.

                              • If the action value is count, this parameter is invalid.
                              • If the action value is filter, the default value is 1000.

                              offset

                              +

                              offset

                              Integer

                              +

                              Integer

                              No

                              +

                              No

                              Specifies the index position. The query starts from the next piece of data indexed by this parameter. The value must be a non-negative number.

                              +

                              Specifies the index position. The query starts from the next piece of data indexed by this parameter. The value must be a non-negative number.

                              You do not need to specify this parameter when querying resources on the first page. When you query resources on subsequent pages, set the value of offset to the location returned in the response body for the previous query.

                              • If the action value is count, this parameter is invalid.
                              • If the action value is filter, the default value is 0.

                              action

                              +

                              action

                              String

                              +

                              String

                              Yes

                              +

                              Yes

                              Specifies the operation, which can be filter or count.

                              +

                              Specifies the operation, which can be filter or count.

                              • filter: Filters DeHs by tag and lists DeHs that meet the search criteria. Listed DeHs are queried by page.
                              • count: Searches for DeHs by tag and returns the number of DeHs that meet the search criteria.

                              tags_any

                              +

                              tags_any

                              Array of objects

                              +

                              Array of objects

                              No

                              +

                              No

                              Includes any of the specified tags. For more information, see Table 3.

                              +

                              Includes any of the specified tags. For more information, see Table 3.

                              • This field contains a maximum of 10 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing.
                              • Each key must be unique, and cannot contain duplicate values.
                              • The response returns resources containing the tags in this list. Keys in this list are in an OR relationship and values in each key-value structure are also in an OR relationship.
                              • If no tag filtering condition is specified, full data is returned.

                              not_tags_any

                              +

                              not_tags_any

                              Array of objects

                              +

                              Array of objects

                              No

                              +

                              No

                              Excludes any of the specified tags. For more information, see Table 3.

                              +

                              Excludes any of the specified tags. For more information, see Table 3.

                              • This field contains a maximum of 10 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing.
                              • Each key must be unique, and cannot contain duplicate values.
                              • The response returns resources containing no tags in this list. Keys in this list are in an OR relationship and values in each key-value structure are also in an OR relationship.
                              • If no tag filtering condition is specified, full data is returned.

                              matches

                              +

                              matches

                              Array of objects

                              +

                              Array of objects

                              No

                              +

                              No

                              Specifies the search field, which is used to search for DeHs by condition.

                              +

                              Specifies the search field, which is used to search for DeHs by condition.

                              Currently, only resource_name can be used for search. For more information, see Table 4.
                              -
                              Table 3 tag field description

                              Parameter

                              +
                              - - - - - - - - - - - @@ -161,42 +161,140 @@
                              Table 3 tag field description

                              Parameter

                              Type

                              +

                              Type

                              Mandatory

                              +

                              Mandatory

                              Description

                              +

                              Description

                              key

                              +

                              key

                              String

                              +

                              String

                              Yes

                              +

                              Yes

                              Specifies the tag key.

                              +

                              Specifies the tag key.

                              • It contains a maximum of 127 Unicode characters.
                              • This field cannot be left blank.

                              values

                              +

                              values

                              Array of strings

                              +

                              Array of strings

                              No

                              +

                              No

                              Specifies the tag values.

                              +

                              Specifies the tag values.

                              • Each tag contains a maximum of 10 values.
                              • Values of the same tag must be unique.
                              • Each value can contain a maximum of 255 Unicode characters.
                              • If this parameter is not specified, any value can be used.
                              • The resources containing one or more values listed in values will be found and displayed.
                              -
                              - + + + + + +
                              Table 4 match field description

                              Parameter

                              +
                              - - - - - - - - - - -
                              Table 4 match field description

                              Parameter

                              Type

                              +

                              Type

                              Mandatory

                              +

                              Mandatory

                              Description

                              +

                              Description

                              key

                              +

                              key

                              String

                              +

                              String

                              Yes

                              +

                              Yes

                              Specifies the key parameter to be matched.

                              +

                              Specifies the key parameter to be matched.

                              • The key must be unique, and the value is used for matching.
                              • The key field is a fixed dictionary value.
                              • This field cannot be left blank.
                              NOTE:

                              The parameter value can only be resource_name, which is the DeH name.

                              value

                              +

                              value

                              String

                              +

                              String

                              Yes

                              +

                              Yes

                              Specifies the tag value.

                              +

                              Specifies the tag value.

                              • Each value can contain a maximum of 255 Unicode characters.
                              • This field cannot be left blank.
                              -
                            • Example request
                              POST https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-host-tags/resource_instances/action
                              + +

                              Response

                              +
                              + + + + + + + + + + + + + +
                              Table 5 Response parameters

                              Parameter

                              +

                              Type

                              +

                              Description

                              +

                              resources

                              +

                              Array of objects

                              +

                              Specifies the returned DeH list. For details, see Table 6.

                              +

                              total_count

                              +

                              Integer

                              +

                              Specifies the total number of resources.

                              +
                              +
                              + +
                              + + + + + + + + + + + + + + + + + + + + + +
                              Table 6 Description of the resource field

                              Parameter

                              +

                              Type

                              +

                              Description

                              +

                              resource_id

                              +

                              String

                              +

                              Specifies the DeH ID.

                              +

                              resouce_detail

                              +

                              String

                              +

                              Specifies the DeH details.

                              +

                              This field is used for future extension and is left empty by default.

                              +

                              tags

                              +

                              Array of objects

                              +

                              Specifies the tag list.

                              +

                              For details, see Table 7.

                              +

                              resource_name

                              +

                              String

                              +

                              Specifies the resource name.

                              +
                              +
                              + +
                              + + + + + + + + + + + + + +
                              Table 7 tag field description

                              Parameter

                              +

                              Type

                              +

                              Description

                              +

                              key

                              +

                              String

                              +

                              Specifies the tag key.

                              +
                              • It contains a maximum of 36 Unicode characters.
                              • This field cannot be left blank.
                              • It cannot contain the following ASCII characters: =*<>\|/,
                              +

                              value

                              +

                              String

                              +

                              Specifies the tag value.

                              +
                              • Each value contains a maximum of 43 Unicode characters.
                              • This field can be left blank.
                              • It cannot contain the following ASCII characters: =*<>\|/,
                              +
                              +
                              +
                              +

                              Example Request

                              Filter DeHs by tag. From the first data record, query the DeH using the search field (field: resource_name; value: resource1) and the tag (key: key1; value: value1).
                              POST https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-host-tags/resource_instances/action 
                              { 
     "offset": "0",
     "limit": "100",
@@ -214,105 +312,9 @@
         }
     ]
 }
                              -
                              • -

                              Response

                              • Response parameters -
                                - - - - - - - - - - - - - -
                                Table 5 Response parameters

                                Parameter

                                -

                                Type

                                -

                                Description

                                -

                                resources

                                -

                                Array of objects

                                -

                                Specifies the returned DeH list. For details, see Table 6.

                                -

                                total_count

                                -

                                Integer

                                -

                                Specifies the total number of resources.

                                -
                                - -
                                - - - - - - - - - - - - - - - - - - - - - -
                                Table 6 Description of the resource field

                                Parameter

                                -

                                Type

                                -

                                Description

                                -

                                resource_id

                                -

                                String

                                -

                                Specifies the DeH ID.

                                -

                                resouce_detail

                                -

                                String

                                -

                                Specifies the DeH details.

                                -

                                This field is used for future extension and is left empty by default.

                                -

                                tags

                                -

                                Array of objects

                                -

                                Specifies the tag list.

                                -

                                For details, see Table 7.

                                -

                                resource_name

                                -

                                String

                                -

                                Specifies the resource name.

                                -
                                -
                                - -
                                - - - - - - - - - - - - - -
                                Table 7 tag field description

                                Parameter

                                -

                                Type

                                -

                                Description

                                -

                                key

                                -

                                String

                                -

                                Specifies the tag key.

                                -
                                • It contains a maximum of 36 Unicode characters.
                                • This field cannot be left blank.
                                • It cannot contain the following ASCII characters: =*<>\|/,
                                -

                                value

                                -

                                String

                                -

                                Specifies the tag value.

                                -
                                • Each value contains a maximum of 43 Unicode characters.
                                • This field can be left blank.
                                • It cannot contain the following ASCII characters: =*<>\|/,
                                -
                                -
                                -
                              • Example response

                                Response body when action is set to filter

                                +

                                Example Response

                                Response body when action is set to filter

                                {
     "resources": [
         {
@@ -329,11 +331,10 @@
     ],
     "total_count": 1
 }
                                -

                                Response body when action is set to count

                                +

                                Response body when action is set to count

                                {
     "total_count": 100
 }
                                -

                              Status Code

                              See Status Codes.

                              diff --git a/docs/deh/api-ref/deh_appendix_0003.html b/docs/deh/api-ref/deh_appendix_0003.html index b9f7d122..aed66311 100644 --- a/docs/deh/api-ref/deh_appendix_0003.html +++ b/docs/deh/api-ref/deh_appendix_0003.html @@ -8,7 +8,21 @@

                              2023-05-09

                              +

                              2023-11-04

                              +

                              This issue is the thirteenth official release.

                              +

                              It incorporates the following changes:

                              + +

                              2023-10-20

                              +

                              This issue is the twelfth official release.

                              +

                              It incorporates the following changes:

                              + +

                              2023-05-09

                              This issue is the eleventh official release.

                              It incorporates the following changes: