diff --git a/docs/deh/api-ref/ALL_META.TXT.json b/docs/deh/api-ref/ALL_META.TXT.json index cd748d0f..383b9c85 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 7e1fbeec..874522a8 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 fc5f6c21..34e978a4 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

@@ -200,7 +200,7 @@

Response

- @@ -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 0ef4eae4..aefb61a1 100644 --- a/docs/deh/api-ref/deh_02_0021.html +++ b/docs/deh/api-ref/deh_02_0021.html @@ -67,52 +67,53 @@
Table 3 Response parameters

Parameter

In

+

In

Type

-

Example Request

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

Example Request

Query details about the DeH ab910cf0daebca90c4001.

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

Example Response

{
     "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 939944e1..ef916840 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

@@ -205,7 +205,7 @@
- @@ -246,7 +246,7 @@
Table 5 Data structure of the network to which an ECS accesses

Parameter

Type

+

Type

Description

- @@ -265,7 +265,7 @@
Table 6 flavor field description

Parameter

Type

+

Type

Description

- @@ -284,7 +284,7 @@
Table 7 image field description

Parameter

Type

+

Type

Description

- @@ -301,7 +301,8 @@
Table 8 metadata field description

Parameter

Type

+

Type

Description

-

Example Request

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

Example Request

Query ECSs on the DeH ab910cf0daebca90c4001.

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

Example Response

{
     "servers": [
diff --git a/docs/deh/api-ref/deh_02_0024.html b/docs/deh/api-ref/deh_02_0024.html
index af06f485..7c8be5b8 100644
--- a/docs/deh/api-ref/deh_02_0024.html
+++ b/docs/deh/api-ref/deh_02_0024.html
@@ -46,7 +46,8 @@
 

Response

None

-

Example Request

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

Example Request

Release the DeH 74259164-e63a-4ad9-9c77-a1bd2c9aa187.

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

Example Response

Http Response Code: 204
diff --git a/docs/deh/api-ref/deh_02_0025.html b/docs/deh/api-ref/deh_02_0025.html index d310fe75..292fc6ae 100644 --- a/docs/deh/api-ref/deh_02_0025.html +++ b/docs/deh/api-ref/deh_02_0025.html @@ -91,19 +91,20 @@
-

Example Request

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

Example Request

Query the DeH types available in az1.

+
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"
-  }
- ]
+     "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 9ca858e4..25ad9223 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

@@ -93,7 +93,7 @@
- @@ -125,20 +125,22 @@
Table 4 quota_set field description

Parameter

Type

+

Type

Description

-

Example Request

GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/quota-sets/45df5566cb3443ab910cf0daebcapoi8
+

Example Request

Query the DeH quota of the tenant whose ID is 45df5566cb3443ab910cf0daebcapoi8.

+
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
-  }]
+    "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 c6bfeb64..2d448e4c 100644 --- a/docs/deh/api-ref/deh_05_0801.html +++ b/docs/deh/api-ref/deh_05_0801.html @@ -29,7 +29,7 @@
- @@ -84,7 +84,7 @@
Table 2 versions field description

Parameter

Type

+

Type

Description

- @@ -108,7 +108,8 @@
Table 3 links field description

Parameter

Type

+

Type

Description

-

Example Request

GET /
+

Example Request

Query all available API versions of DeH.

+
GET /

Example Response

{
     "versions": [
diff --git a/docs/deh/api-ref/deh_05_0802.html b/docs/deh/api-ref/deh_05_0802.html
index f18c2267..9e7012b7 100644
--- a/docs/deh/api-ref/deh_05_0802.html
+++ b/docs/deh/api-ref/deh_05_0802.html
@@ -49,7 +49,7 @@
 
 
- @@ -104,7 +104,7 @@
Table 3 version field description

Parameter

Type

+

Type

Description

- @@ -128,7 +128,8 @@
Table 4 links field description

Parameter

Type

+

Type

Description

-

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 f7e05f76..9b6b00dd 100644
--- a/docs/deh/api-ref/deh_05_0901.html
+++ b/docs/deh/api-ref/deh_05_0901.html
@@ -47,9 +47,9 @@
 

Request

- - @@ -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 value2
POST 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 63993314..24588dfb 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 2 Request parameters

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 value2
POST 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 49c5d68c..90f605c7 100644
--- a/docs/deh/api-ref/deh_05_0903.html
+++ b/docs/deh/api-ref/deh_05_0903.html
@@ -90,7 +90,8 @@
 
Table 3 tag field description

Parameter

Type

+

Type

Mandatory

+

Mandatory

Description

-

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 de5e3994..cc67fa61 100644
--- a/docs/deh/api-ref/deh_05_0904.html
+++ b/docs/deh/api-ref/deh_05_0904.html
@@ -34,9 +34,9 @@
 

Request

- - @@ -294,8 +294,8 @@
Table 2 Request parameters

Parameter

Type

+

Type

Mandatory

+

Mandatory

Description

-

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 c51615ca..77f8a41e 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

+

-