diff --git a/docs/deh/api-ref/ALL_META.TXT.json b/docs/deh/api-ref/ALL_META.TXT.json index cd748d0f0..383b9c85f 100644 --- a/docs/deh/api-ref/ALL_META.TXT.json +++ b/docs/deh/api-ref/ALL_META.TXT.json @@ -14,7 +14,7 @@ "metedata":[ { "documenttype":"api", - "prodname":"ims", + "prodname":"deh;ims", "opensource":"true" } ], @@ -33,7 +33,7 @@ "metedata":[ { "documenttype":"api", - "prodname":"ims", + "prodname":"deh;ims", "opensource":"true" } ], @@ -52,7 +52,7 @@ "metedata":[ { "documenttype":"api", - "prodname":"ims", + "prodname":"deh;ims", "opensource":"true" } ], @@ -71,7 +71,7 @@ "metedata":[ { "documenttype":"api", - "prodname":"ims", + "prodname":"deh;ims", "opensource":"true" } ], @@ -83,14 +83,14 @@ "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.NoneSee Status Codes.", + "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.NoneQuery details about the DeH a", "doc_type":"api", "kw":"Querying Details About a DeH,API,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "prodname":"ims", + "prodname":"deh;ims", "opensource":"true" } ], @@ -102,14 +102,14 @@ "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.See ", + "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.Quer", "doc_type":"api", "kw":"Querying ECSs on a DeH,API,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "prodname":"ims", + "prodname":"deh;ims", "opensource":"true" } ], @@ -128,7 +128,7 @@ "metedata":[ { "documenttype":"api", - "prodname":"ims", + "prodname":"deh;ims", "opensource":"true" } ], @@ -147,7 +147,7 @@ "metedata":[ { "documenttype":"api", - "prodname":"ims", + "prodname":"deh;ims", "opensource":"true" } ], @@ -166,7 +166,7 @@ "metedata":[ { "documenttype":"api", - "prodname":"ims", + "prodname":"deh;ims", "opensource":"true" } ], @@ -185,7 +185,7 @@ "metedata":[ { "documenttype":"api", - "prodname":"ims", + "prodname":"deh;ims", "opensource":"true" } ], @@ -197,14 +197,14 @@ "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 /NoneSee Status Codes.", + "des":"This API is used to query all API versions available to the DeH service.GET /NoneQuery all available API versions of DeH.See Status Codes.", "doc_type":"api", "kw":"Querying API Versions,API Version Query,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "prodname":"ims", + "prodname":"deh;ims", "opensource":"true" } ], @@ -216,14 +216,14 @@ "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.NoneSee Status Codes.", + "des":"This API is used to query a specified API version.GET /{api_version}Table 1 describes the parameters.NoneQuery the information about API v1.0 of DeH.See Status Codes.", "doc_type":"api", "kw":"Querying an API Version,API Version Query,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "prodname":"ims", + "prodname":"deh;ims", "opensource":"true" } ], @@ -242,7 +242,7 @@ "metedata":[ { "documenttype":"api", - "prodname":"ims", + "prodname":"deh;ims", "opensource":"true" } ], @@ -261,7 +261,7 @@ "metedata":[ { "documenttype":"api", - "prodname":"ims", + "prodname":"deh;ims", "opensource":"true" } ], @@ -280,7 +280,7 @@ "metedata":[ { "documenttype":"api", - "prodname":"ims", + "prodname":"deh;ims", "opensource":"true" } ], @@ -299,7 +299,7 @@ "metedata":[ { "documenttype":"api", - "prodname":"ims", + "prodname":"deh;ims", "opensource":"true" } ], @@ -318,7 +318,7 @@ "metedata":[ { "documenttype":"api", - "prodname":"ims", + "prodname":"deh;ims", "opensource":"true" } ], @@ -337,7 +337,7 @@ "metedata":[ { "documenttype":"api", - "prodname":"ims", + "prodname":"deh;ims", "opensource":"true" } ], @@ -356,7 +356,7 @@ "metedata":[ { "documenttype":"api", - "prodname":"ims", + "prodname":"deh;ims", "opensource":"true" } ], @@ -375,7 +375,7 @@ "metedata":[ { "documenttype":"api", - "prodname":"ims", + "prodname":"deh;ims", "opensource":"true" } ], @@ -394,7 +394,7 @@ "metedata":[ { "documenttype":"api", - "prodname":"ims", + "prodname":"deh;ims", "opensource":"true" } ], @@ -413,7 +413,7 @@ "metedata":[ { "documenttype":"api", - "prodname":"ims", + "prodname":"deh;ims", "opensource":"true" } ], @@ -432,7 +432,7 @@ "metedata":[ { "documenttype":"api", - "prodname":"ims", + "prodname":"deh;ims", "opensource":"true" } ], @@ -451,7 +451,7 @@ "metedata":[ { "documenttype":"api", - "prodname":"ims", + "prodname":"deh;ims", "opensource":"true" } ], @@ -470,7 +470,7 @@ "metedata":[ { "documenttype":"api", - "prodname":"ims", + "prodname":"deh;ims", "opensource":"true" } ], @@ -489,7 +489,7 @@ "metedata":[ { "documenttype":"api", - "prodname":"ims", + "prodname":"deh;ims", "opensource":"true" } ], diff --git a/docs/deh/api-ref/CLASS.TXT.json b/docs/deh/api-ref/CLASS.TXT.json index 7e1fbeece..874522a81 100644 --- a/docs/deh/api-ref/CLASS.TXT.json +++ b/docs/deh/api-ref/CLASS.TXT.json @@ -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.NoneSee Status Codes.", + "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.NoneQuery details about the DeH a", "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.See ", + "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.Quer", "product_code":"deh", "title":"Querying ECSs on a DeH", "uri":"deh_02_0022.html", @@ -90,7 +90,7 @@ "code":"10" }, { - "desc":"This API is used to query all API versions available to the DeH service.GET /NoneSee Status Codes.", + "desc":"This API is used to query all API versions available to the DeH service.GET /NoneQuery all available API versions of DeH.See 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.NoneSee Status Codes.", + "desc":"This API is used to query a specified API version.GET /{api_version}Table 1 describes the parameters.NoneQuery the information about API v1.0 of DeH.See Status Codes.", "product_code":"deh", "title":"Querying an API Version", "uri":"deh_05_0802.html", diff --git a/docs/deh/api-ref/deh_02_0020.html b/docs/deh/api-ref/deh_02_0020.html index fc5f6c21c..34e978a49 100644 --- a/docs/deh/api-ref/deh_02_0020.html +++ b/docs/deh/api-ref/deh_02_0020.html @@ -39,7 +39,7 @@
Type
Mandatory
+Mandatory
Description
Parameter |
-In + | In |
Type |
@@ -275,9 +275,9 @@
"available_memory": 81920,
"instance_total": 5,
"allocated_at": "2016-10-10T14:35:47Z",
- "released_at": null
- }
- ],
+ "released_at": ""
+ }
+ ],
"total": 1
}
diff --git a/docs/deh/api-ref/deh_02_0021.html b/docs/deh/api-ref/deh_02_0021.html
index 0ef4eae4a..aefb61a1e 100644
--- a/docs/deh/api-ref/deh_02_0021.html
+++ b/docs/deh/api-ref/deh_02_0021.html
@@ -67,52 +67,53 @@
|---|
GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-hosts/ab910cf0daebca90c4001
+Query details about the DeH ab910cf0daebca90c4001.
+GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-hosts/ab910cf0daebca90c4001
{
"dedicated_host": {
- "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"
+ "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": "",
+ "instance_uuids": [
+ "erf5th66cb3443ab912ff0daebca3456",
+ "23457h66cb3443ab912ff0daebcaer45"
]
}
}
diff --git a/docs/deh/api-ref/deh_02_0022.html b/docs/deh/api-ref/deh_02_0022.html
index 939944e1f..ef916840b 100644
--- a/docs/deh/api-ref/deh_02_0022.html
+++ b/docs/deh/api-ref/deh_02_0022.html
@@ -47,7 +47,7 @@
Type
Mandatory
+Mandatory
Description
Parameter |
-Type + | Type |
Description |
@@ -246,7 +246,7 @@
|---|
Parameter |
-Type + | Type |
Description |
@@ -265,7 +265,7 @@
|---|
Parameter |
-Type + | Type |
Description |
@@ -284,7 +284,7 @@
-
|---|
GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/availability-zone/az1/dedicated-host-types
+Query the DeH types available in az1.
+GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/availability-zone/az1/dedicated-host-types
{
- "dedicated_host_types": [
- {
- "host_type": "c4",
- "host_type_name": "dedicated_general_purpose"
- },
- {
- "host_type": "m4",
- "host_type_name": "memory_optimized"
- }
- ]
+ "dedicated_host_types": [
+ {
+ "host_type": "c4",
+ "host_type_name": "dedicated_general_purpose"
+ },
+ {
+ "host_type": "m4",
+ "host_type_name": "memory_optimized"
+ }
+ ]
}
See Status Codes.
diff --git a/docs/deh/api-ref/deh_02_0028.html b/docs/deh/api-ref/deh_02_0028.html index 9ca858e43..25ad9223d 100644 --- a/docs/deh/api-ref/deh_02_0028.html +++ b/docs/deh/api-ref/deh_02_0028.html @@ -49,7 +49,7 @@Type
Mandatory
+Mandatory
Description
GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/quota-sets/45df5566cb3443ab910cf0daebcapoi8
+Query the DeH quota of the tenant whose ID is 45df5566cb3443ab910cf0daebcapoi8.
+GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/quota-sets/45df5566cb3443ab910cf0daebcapoi8
{
- "quota_set": [
- {
- "used": 0,
- "resource": "c4",
- "hard_limit": 5
- },
- {
- "used": 0,
- "resource": "m4",
- "hard_limit": 5
- }]
+ "quota_set": [
+ {
+ "used": 0,
+ "resource": "c4",
+ "hard_limit": 5
+ },
+ {
+ "used": 0,
+ "resource": "m4",
+ "hard_limit": 5
+ }
+ ]
}
See Status Codes.
diff --git a/docs/deh/api-ref/deh_05_0801.html b/docs/deh/api-ref/deh_05_0801.html index c6bfeb645..2d448e4c4 100644 --- a/docs/deh/api-ref/deh_05_0801.html +++ b/docs/deh/api-ref/deh_05_0801.html @@ -29,7 +29,7 @@Parameter |
-Type + | Type |
Description |
@@ -84,7 +84,7 @@
|---|
Parameter |
-Type + | Type |
Description |
@@ -108,7 +108,8 @@
|---|
GET /+
Query all available API versions of DeH.
+GET /
{
"versions": [
diff --git a/docs/deh/api-ref/deh_05_0802.html b/docs/deh/api-ref/deh_05_0802.html
index f18c22678..9e7012b76 100644
--- a/docs/deh/api-ref/deh_05_0802.html
+++ b/docs/deh/api-ref/deh_05_0802.html
@@ -49,7 +49,7 @@
Table 3 version field description Parameter
-Type
+Type
Description
@@ -104,7 +104,7 @@
Table 4 links field description Parameter
-Type
+Type
Description
@@ -128,7 +128,8 @@
-Example Request
GET /v1.0
+Example Request
Query the information about API v1.0 of DeH.
+GET /v1.0
Example Response
{
"version": {
diff --git a/docs/deh/api-ref/deh_05_0901.html b/docs/deh/api-ref/deh_05_0901.html
index f7e05f767..9b6b00ddb 100644
--- a/docs/deh/api-ref/deh_05_0901.html
+++ b/docs/deh/api-ref/deh_05_0901.html
@@ -47,9 +47,9 @@
Request
Table 2 Request parameters Parameter
-Type
+Type
-Mandatory
+Mandatory
Description
@@ -113,8 +113,8 @@
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 value2POST https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-host-tags/74259164-e63a-4ad9-9c77-a1bd2c9aa187/tags/action
-{
+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": [
{
diff --git a/docs/deh/api-ref/deh_05_0902.html b/docs/deh/api-ref/deh_05_0902.html
index 639933149..24588dfbf 100644
--- a/docs/deh/api-ref/deh_05_0902.html
+++ b/docs/deh/api-ref/deh_05_0902.html
@@ -46,9 +46,9 @@
Request
Table 2 Request parameters Parameter
-Type
+Type
-Mandatory
+Mandatory
Description
@@ -79,9 +79,9 @@
Table 3 tag field description Parameter
-Type
+Type
-Mandatory
+Mandatory
Description
@@ -113,8 +113,8 @@
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 value2POST https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-host-tags/74259164-e63a-4ad9-9c77-a1bd2c9aa187/tags/action
-{
+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": [
{
diff --git a/docs/deh/api-ref/deh_05_0903.html b/docs/deh/api-ref/deh_05_0903.html
index 49c5d68c2..90f605c7d 100644
--- a/docs/deh/api-ref/deh_05_0903.html
+++ b/docs/deh/api-ref/deh_05_0903.html
@@ -90,7 +90,8 @@
-Example Request
GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-host-tags/74259164-e63a-4ad9-9c77-a1bd2c9aa187/tags
+Example Request
Query the tags of the DeH 74259164-e63a-4ad9-9c77-a1bd2c9aa187.
+GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-host-tags/74259164-e63a-4ad9-9c77-a1bd2c9aa187/tags
Example Response
{
"tags": [
diff --git a/docs/deh/api-ref/deh_05_0904.html b/docs/deh/api-ref/deh_05_0904.html
index de5e39947..cc67fa613 100644
--- a/docs/deh/api-ref/deh_05_0904.html
+++ b/docs/deh/api-ref/deh_05_0904.html
@@ -34,9 +34,9 @@
Request
Table 2 Request parameters Parameter
-Type
+Type
-Mandatory
+Mandatory
Description
@@ -294,8 +294,8 @@
-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
-{
+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",
"action": "filter",
@@ -331,7 +331,7 @@
],
"total_count": 1
}
-Response body when action is set to count
+Response body when action is set to count
{
"total_count": 100
}
diff --git a/docs/deh/api-ref/deh_06_0001.html b/docs/deh/api-ref/deh_06_0001.html
index c51615cae..77f8a41ec 100644
--- a/docs/deh/api-ref/deh_06_0001.html
+++ b/docs/deh/api-ref/deh_06_0001.html
@@ -1,11 +1,8 @@
-
- Permissions and Actions
-
-
+Permissions and Actions
+
-
- Permissions and Supported Actions
diff --git a/docs/deh/api-ref/deh_07_0101.html b/docs/deh/api-ref/deh_07_0101.html
index f6ecf2c77..f62ae3dae 100644
--- a/docs/deh/api-ref/deh_07_0101.html
+++ b/docs/deh/api-ref/deh_07_0101.html
@@ -27,17 +27,6 @@
×
-Querying Flavors Bound to a DeH Resource Type
-
-GET /v1.0/{admin_tenant_id}/dedicated-host-resource-types/{dedicated_host_resource_type_id}/flavors
-
-deh:dedicatedHostResourcesType:get
-
-√
-
-×
-
-
Querying Details About a DeH
GET /v1.0/{tenant_id}/dedicated-hosts/{dedicated_host_id}
@@ -46,7 +35,7 @@
√
-√
+×
Releasing a DeH
@@ -68,7 +57,7 @@
√
-√
+×
Allocating One or Multiple DeHs to a Tenant
@@ -90,7 +79,7 @@
√
-√
+×
Creating DeH Tags in a Batch
@@ -101,18 +90,7 @@
√
-√
-
-
-Querying DeH Resource Types in an AZ
-
-GET /v1.0/{tenant_id}/availablity-zone/{availablity_zone}/dedicated-host-types
-
-deh:dedicatedHostResourceTypes:list
-
-√
-
-×
+×
Querying Tags of a Specified DeH
@@ -123,7 +101,7 @@
√
-√
+×
Querying DeHs
@@ -134,7 +112,7 @@
√
-√
+×
Querying DeHs by Tag
@@ -145,10 +123,10 @@
√
-√
+×
-Querying Available DeH Types
+Querying Available DeH Types
Get /v1.0/{project_id}/availability-zone/{availability_zone}/dedicated-host-types
diff --git a/docs/deh/api-ref/deh_appendix_0003.html b/docs/deh/api-ref/deh_appendix_0003.html
index aed663117..05c1963be 100644
--- a/docs/deh/api-ref/deh_appendix_0003.html
+++ b/docs/deh/api-ref/deh_appendix_0003.html
@@ -8,7 +8,21 @@
-2023-11-04
+2024-09-12
+
+This issue is the fifteenth official release.
+It incorporates the following change:
+- Deleted actions Querying Flavors Bound to a DeH Resource Type and Querying DeH Resource Types in an AZ from API Permissions.
- Modified the formats of the examples in Querying DeHs, Querying Details About a DeH, Querying Available DeH Types, and Querying the DeH Quota of a Tenant.
+
+
+2023-12-12
+
+This issue is the fourteenth official release.
+It incorporates the following changes:
+- Corrected the value of released_at in the example responses of Querying DeHs and Querying Details About a DeH.
- Added descriptions for the example requests and combined the API URL and API body in the example requests in API.
+
+
+2023-11-04
This issue is the thirteenth official release.
It incorporates the following changes: