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 Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.
+Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted using JSON messages, with the media type represented by Application/json.
+For details about how to use APIs, see API Usage Guidelines.
+Returned Value + |
+Description + |
+
|---|---|
200 OK + |
+The server has successfully processed the request. + |
+
201 Created + |
+The request is successful and a resource is created on the server. + |
+
202 Accepted + |
+The request has been accepted, but the processing has been delayed. + |
+
204 No Content + |
+The server has processed the request but did not return any content. + |
+
Returned Value + |
+Description + |
+
|---|---|
400 Bad Request + |
+The server failed to process the request. + |
+
401 Unauthorized + |
+You must enter a username and password to access the requested page. + |
+
403 Forbidden + |
+You are forbidden to access the requested page. + |
+
404 Not Found + |
+The server could not find the requested page. + |
+
405 Method Not Allowed + |
+You are not allowed to use the method specified in the request. + |
+
406 Not Acceptable + |
+The response generated by the server could not be accepted by the client. + |
+
407 Proxy Authentication Required + |
+You must use the proxy server for authentication so that the request can be processed. + |
+
408 Request Timeout + |
+The request timed out. + |
+
409 Conflict + |
+The request could not be processed due to a conflict. + |
+
500 Internal Server Error + |
+Failed to complete the request because of an internal service error. + |
+
501 Not Implemented + |
+Failed to complete the request because the server does not support the requested function. + |
+
502 Bad Gateway + |
+Failed to complete the request because the server has received an invalid response. + |
+
503 Service Unavailable + |
+Failed to complete the request because the service is unavailable. + |
+
504 Gateway Timeout + |
+A gateway timeout error occurred. + |
+
DeH management includes querying the DeH list, viewing DeH details, modifying DeH attributes, allocating a DeH, and releasing a DeH.
+Parameter + |
+Type + |
+CRUD + |
+Default Value + |
+Constraint + |
+Description + |
+
|---|---|---|---|---|---|
dedicated_host_id + |
+String + |
+R + |
+N/A + |
+N/A + |
+N/A + |
+
name + |
+String + |
+CUR + |
+N/A + |
+N/A + |
+Specifies the DeH name. +The name can contain a maximum of 255 characters and cannot start or end with spaces. + |
+
auto_placement + |
+String + |
+CUR + |
+on + |
+The value can be on or off. + |
+Specifies whether to allow an ECS to be placed on any available DeH if its DeH ID is not specified during its creation. + |
+
availability_zone + |
+String + |
+CR + |
+N/A + |
+N/A + |
+Specifies the AZ to which the DeH belongs. + |
+
project_id + |
+String + |
+CR + |
+N/A + |
+N/A + |
+Specifies the tenant who owns the DeH. + |
+
host_properties + |
+Dict +For details, see Table 2. + |
+R + |
+N/A + |
+N/A + |
+Specifies the DeH properties. + |
+
state + |
+String + |
+R + |
+N/A + |
+The value can be available, fault, or released. + |
+Specifies the DeH status. + |
+
available_vcpus + |
+Int + |
+R + |
+N/A + |
+N/A + |
+Specifies the number of available vCPUs for the DeH. + |
+
available_memory + |
+Int + |
+R + |
+N/A + |
+N/A + |
+Specifies the available memory size of the DeH. + |
+
allocated_at + |
+String + |
+R + |
+N/A + |
+N/A + |
+Specifies the time when the DeH is allocated. + |
+
released_at + |
+String + |
+R + |
+N/A + |
+N/A + |
+Specifies the time when the DeH is released. + |
+
instance_total + |
+Int + |
+R + |
+N/A + |
+N/A + |
+Specifies the total number of ECSs on the DeH. + |
+
instance_uuids + |
+List <String> + |
+R + |
+N/A + |
+N/A + |
+Specifies the UUIDs of the ECSs running on the DeH. +This parameter is not displayed on the interface for querying DeHs. + |
+
tags + |
+Dict(str:str) + |
+R + |
+N/A + |
+N/A + |
+Specifies the DeH tags. + |
+
sys_tags + |
+Dict(str:str) + |
+R + |
+N/A + |
+N/A + |
+Specifies the DeH system tags. + |
+
Parameter + |
+Type + |
+CRUD + |
+Default Value + |
+Constraint + |
+Description + |
+
|---|---|---|---|---|---|
host_type + |
+String + |
+R + |
+N/A + |
+N/A + |
+Specifies the DeH type. + |
+
host_type_name + |
+String + |
+R + |
+N/A + |
+N/A + |
+Specifies the name of the DeH type. + |
+
vcpus + |
+Int + |
+R + |
+N/A + |
+N/A + |
+Specifies the number of vCPUs on the DeH. + |
+
cores + |
+Int + |
+R + |
+N/A + |
+N/A + |
+Specifies the number of physical cores on the DeH. + |
+
sockets + |
+Int + |
+R + |
+N/A + |
+N/A + |
+Specifies the number of physical sockets on the DeH. + |
+
memory + |
+Int + |
+R + |
+N/A + |
+N/A + |
+Specifies the size of physical memory on the DeH. + |
+
available_instance_capacities + |
+List +For details, see Table 3. + |
+R + |
+N/A + |
+N/A + |
+Specifies the flavors of ECSs placed on the DeH. + |
+
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 owned by the tenant.
+POST /v1.0/{project_id}/dedicated-hosts
+Table 1 describes the parameters.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies the project ID. +For details about how to obtain the project ID, see Obtaining Required Information. + |
+
Parameter + |
+In + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|---|
name + |
+body + |
+String + |
+Yes + |
+Specifies the DeH name. + |
+
auto_placement + |
+body + |
+String + |
+No + |
+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 + |
+body + |
+String + |
+Yes + |
+Specifies the AZ to which the DeH belongs. + |
+
host_type + |
+body + |
+String + |
+Yes + |
+Specifies the DeH type. + |
+
quantity + |
+body + |
+Integer + |
+Yes + |
+Specifies the number of allocatable DeHs. + |
+
tags + |
+body + |
+Array of objects + |
+No + |
+Specifies the DeH tags. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key + |
+String + |
+Yes + |
+Specifies the tag key. +
|
+
value + |
+String + |
+Yes + |
+Specifies the tag value. +
|
+
POST https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-hosts
+{
+ "availability_zone": "dc1.az1",
+ "name": "high performance servers1",
+ "auto_placement": "off",
+ "host_type": "h1",
+ "quantity": 2,
+ "tags": [
+ {
+ "key": "key1",
+ "value": "value1"
+ }
+ ]
+}
+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. + |
+
{
+ "dedicated_host_ids": ["xxxxxxx1","xxxxxxx2"]
+}
+Error Code + |
+Description + |
+
|---|---|
403 Forbidden + |
+
|
+
404 FlavorNotFound + |
+Invalid flavor. + |
+
For more status codes, see Status Codes.
+This API is used to query the DeH list.
+GET /v1.0/{project_id}/dedicated-hosts
+Table 1 describes the parameters.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies the project ID. +For details about how to obtain the project ID, see Obtaining Required Information. + |
+
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,
+for example, /v1.0/{project_id}/dedicated-hosts?host_type={host_type}&state={state}.
+ +Parameter + |
+In + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|---|
dedicated_host_id + |
+query + |
+String + |
+No + |
+Specifies the DeH ID. + |
+
name + |
+query + |
+String + |
+No + |
+Specifies the DeH name. + |
+
host_type + |
+query + |
+String + |
+No + |
+Specifies the DeH type. + |
+
host_type_name + |
+query + |
+String + |
+No + |
+Specifies the name of the DeH type. + |
+
flavor + |
+query + |
+String + |
+No + |
+Specifies the flavor ID. + |
+
state + |
+query + |
+String + |
+No + |
+Specifies the DeH status. +The value can be available, fault, or released. + |
+
tenant + |
+query + |
+String + |
+No + |
+The value can be a tenant ID or all. +Only the administrator can specify this parameter. + |
+
availability_zone + |
+query + |
+String + |
+No + |
+Specifies the AZ to which the DeH belongs. + |
+
limit + |
+query + |
+String + |
+No + |
+Specifies the number of records displayed per page. + |
+
marker + |
+query + |
+String + |
+No + |
+Specifies the ID of the last record on the previous page. If the marker value is invalid, status code 400 is returned. + |
+
tags + |
+query + |
+String + |
+No + |
+Specifies the DeH tags. + |
+
instance_uuid + |
+query + |
+String + |
+No + |
+Specifies the ID of the ECS on the DeH. + |
+
released_at + |
+query + |
+String + |
+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. +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. + |
+
GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-hosts?state=available
+Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
dedicated_hosts + |
+body + |
+Array of objects +For details, see Table 1. + |
+Specifies the DeHs that meet the search criteria. + |
+
total + |
+body + |
+Integer + |
+Specifies the quantity of DeHs that meet the search criteria. + |
+
{
+ "dedicated_hosts": [
+ {
+ "dedicated_host_id": "ab910cf0daebca90c4001",
+ "name": "high performance servers1",
+ "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
+ },
+ {
+ "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
+}
+See Status Codes.
+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.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies the project ID. +For details about how to obtain the project ID, see Obtaining Required Information. + |
+
dedicated_host_id + |
+String + |
+Yes + |
+Specifies the DeH ID. +You can obtain the DeH ID from the DeH console or using the Querying DeHs API. + |
+
Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
dedicated_host + |
+body + |
+Object +For details, see Table 1. + |
+Specifies the DeH object. + |
+
{
+ "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"
+ ]
+ }
+}
+See Status Codes.
+This API is used to query information about deployed ECSs on a DeH.
+GET /v1.0/{project_id}/dedicated-hosts/{dedicated_host_id}/servers
+Table 1 describes the parameters.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies the project ID. +For details about how to obtain the project ID, see Obtaining Required Information. + |
+
dedicated_host_id + |
+String + |
+Yes + |
+Specifies the DeH ID. +You can obtain the DeH ID from the DeH console or using the Querying DeHs API. + |
+
Parameter + |
+In + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|---|
limit + |
+query + |
+String + |
+No + |
+Specifies the number of records displayed per page. + |
+
marker + |
+query + |
+String + |
+No + |
+Specifies the ID of the last record on the previous page. If the marker value is invalid, status code 400 is returned. + |
+
GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-hosts/ab910cf0daebca90c4001/servers
+Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
servers + |
+body + |
+Array of objects + |
+Specifies the server object. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
addresses + |
+Object (string:array) + |
+Specifies the network attribute of the ECS. +For details, see the addresses field description. + |
+
created + |
+String + |
+Specifies the time when the ECS was created. + |
+
flavor + |
+Object (string:string) + |
+Specifies the ECS flavor. + |
+
id + |
+String + |
+Specifies the ECS ID in UUID format. + |
+
name + |
+String + |
+Specifies the ECS name. + |
+
status + |
+String + |
+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 + |
+String + |
+Specifies the ECS tenant ID in UUID format. + |
+
updated + |
+String + |
+Specifies the time when the ECS was updated last time. + |
+
user_id + |
+String + |
+Specifies the ID of the user who has created the ECS. The value is in UUID format. + |
+
task_state + |
+String + |
+Specifies the ECS task status. + |
+
image + |
+Object (string:string) + |
+Specifies the ECS image. + |
+
metadata + |
+Object (string:string) + |
+Specifies the ECS metadata. + |
+
{
+ "servers": [
+ {
+ "addresses": {
+ "68269e6e-4a27-441b-8029-35373ad50bd9": [
+ {
+ "addr": "192.168.0.3",
+ "version": 4
+ }
+ ]
+ },
+ "created": "2012-09-07T16:56:37Z",
+ "flavor": {
+ "id": "1"
+ },
+ "id": "05184ba3-00ba-4fbc-b7a2-03b62b884931",
+ "metadata": {
+ "os_type": "Linux"
+ },
+ "name": "new-server-test",
+ "status": "ACTIVE",
+ "tenant_id": "openstack",
+ "updated": "2012-09-07T16:56:37Z",
+ "user_id": "fake",
+ "task_state": "",
+ "image": {
+ "id": "1ce5800a-e487-4c1b-b264-3353a39e2b4b"
+ }
+ }
+ ]
+}
+See Status Codes.
+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.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies the project ID. +For details about how to obtain the project ID, see Obtaining Required Information. + |
+
dedicated_host_id + |
+String + |
+Yes + |
+Specifies the DeH ID. +You can obtain the DeH ID from the DeH console or using the Querying DeHs API. + |
+
Parameter + |
+In + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|---|
auto_placement + |
+in + |
+String + |
+No + |
+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 + |
+in + |
+String + |
+No + |
+Specifies the DeH name. + |
+
PUT https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-hosts/74259164-e63a-4ad9-9c77-a1bd2c9aa187
+{
+ "dedicated_host": {
+ "auto_placement": "off",
+ "name": "DeH_vm3"
+ }
+}
+See Status Codes.
+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 parameters.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies the project ID. +For details about how to obtain the project ID, see Obtaining Required Information. + |
+
dedicated_host_id + |
+String + |
+Yes + |
+Specifies the DeH ID. +You can obtain the DeH ID from the DeH console or using the Querying DeHs API. + |
+
Error Code + |
+Description + |
+
|---|---|
409 Conflict + |
+A DeH accommodating ECSs cannot be released. + |
+
For more status codes, see Status Codes.
+This API is used to query available DeH types in an AZ.
+Get /v1.0/{project_id}/availability-zone/{availability_zone}/dedicated-host-types
+Table 1 describes the parameters.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies the project ID. +For details about how to obtain the project ID, see Obtaining Required Information. + |
+
availability_zone + |
+String + |
+Yes + |
+Specifies the AZ. + |
+
Parameter + |
+In + |
+Type + |
+Description + |
+
|---|---|---|---|
dedicated_host_types + |
+body + |
+Array of objects + |
+Specifies the available DeH types. + |
+
host_type + |
+body + |
+String + |
+Specifies the DeH type. + |
+
host_type_name + |
+body + |
+String + |
+Specifies the name of the DeH type. + |
+
{
+ "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"
+ }
+ ]
+}
+See Status Codes.
+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.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies the project ID. +For details about how to obtain the project ID, see Obtaining Required Information. + |
+
tenant_id + |
+String + |
+Yes + |
+Specifies the tenant ID. +You can obtain the DeH ID from the DeH console or using the Querying DeHs API. + |
+
You can add the resource parameter to the URI. For example:
+/v1.0/{project_id}/quota-sets/{tenant_id}?resource={resource}
+ +Parameter + |
+In + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|---|
resource + |
+query + |
+String + |
+No + |
+Specifies the resource type. + |
+
GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/quota-sets/45df5566cb3443ab910cf0daebcapoi8
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
quota_set + |
+Array of objects + |
+Specifies the quota set of a DeH. + |
+
resource + |
+String + |
+Specifies the resource type. + |
+
hard_limit + |
+Integer + |
+Specifies the quota limit. +-1 indicates that the resource quota is not limited. + |
+
used + |
+Integer + |
+Specifies the used amount of the quota. + |
+
{
+ "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
+ }
+ ]
+}
+See Status Codes.
+This API is used to query all API versions available to the DeH service.
+GET /
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
versions + |
+Array of objects + |
+Specifies the API versions. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the ID of the API version. + |
+
links + |
+Array of objects + |
+Specifies the URL of the API version. + |
+
min_version + |
+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. + |
+
status + |
+String + |
+Specifies the API version status. +
|
+
updated + |
+String + |
+Specifies the API version update time, which must be UTC time. + |
+
version + |
+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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
href + |
+String + |
+Specifies the URL of the API version. + |
+
rel + |
+String + |
+Specifies the API URL dependency. + |
+
{
+ "versions": [
+ {
+ "id": "v1.0",
+ "links": [
+ {
+ "href": "https//deh.xxx.com/v1.0/",
+ "rel": "self"
+ }
+ ],
+ "min_version": "",
+ "status": "SUPPORTED",
+ "updated": "2016-12-01T11:33:21Z",
+ "version": ""
+ }
+ ]
+}
+See Status Codes.
+This API is used to query a specified API version.
+Parameter + |
+Type + |
+Description + |
+
|---|---|---|
version + |
+Object + |
+Specifies information about a specified API version. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Specifies the ID of the API version. + |
+
links + |
+Array of objects + |
+Specifies the URL of the API version. + |
+
min_version + |
+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. + |
+
status + |
+String + |
+Specifies the API version status. +
|
+
updated + |
+String + |
+Specifies the API version update time. + |
+
version + |
+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. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
href + |
+String + |
+Specifies the URL of the API version. + |
+
rel + |
+String + |
+Specifies the API URL dependency. + |
+
{
+ "version": {
+ "id": "v1.0",
+ "links": [
+ {
+ "href": "https//deh.xxx.com/v1.0/",
+ "rel": "self"
+ }
+ ],
+ "min_version": "",
+ "status": "SUPPORTED",
+ "updated": "2016-12-01T11:33:21Z",
+ "version": ""
+ }
+}
+See Status Codes.
+During tag creation, if a tag exists (both the key and value are the same as those of an existing tag), the tag is successfully processed by default.
+POST /v1.0/{project_id}/dedicated-host-tags/{dedicated_host_id}/tags/action
+Table 1 describes the parameters.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies the project ID. +For details about how to obtain the project ID, see Obtaining Required Information. + |
+
dedicated_host_id + |
+String + |
+Yes + |
+Specifies the DeH ID. +You can obtain the DeH ID from the DeH console or using the Querying DeHs API. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
tags + |
+Array of objects + |
+Yes + |
+Specifies the tag list. + |
+
action + |
+String + |
+Yes + |
+Specifies the operation. Only lowercase letters are supported. For example, create indicates the creation operation. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key + |
+String + |
+Yes + |
+Specifies the tag key. +
|
+
value + |
+String + |
+Yes + |
+Specifies the tag value. +
|
+
POST https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-host-tags/74259164-e63a-4ad9-9c77-a1bd2c9aa187/tags/action
+{
+ "action": "create",
+ "tags": [
+ {
+ "key": "key1",
+ "value": "value1"
+ },
+ {
+ "key": "key2",
+ "value": "value2"
+ }
+ ]
+}
+N/A
+See Status Codes.
+A DeH allows a maximum of 10 tags.
+POST /v1.0/{project_id}/dedicated-host-tags/{dedicated_host_id}/tags/action
+Table 1 describes the parameters.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies the project ID. +For details about how to obtain the project ID, see Obtaining Required Information. + |
+
dedicated_host_id + |
+String + |
+Yes + |
+Specifies the DeH ID. +You can obtain the DeH ID from the DeH console or using the Querying DeHs API. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
tags + |
+Array of objects + |
+Yes + |
+Specifies the tag list. + |
+
action + |
+String + |
+Yes + |
+Specifies the operation. Only lowercase letters are supported. For example, delete indicates the deletion operation. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key + |
+String + |
+Yes + |
+Specifies the tag key. +
|
+
value + |
+String + |
+No + |
+Specifies the tag value. +
|
+
POST https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-host-tags/74259164-e63a-4ad9-9c77-a1bd2c9aa187/tags/action
+{
+ "action": "delete",
+ "tags": [
+ {
+ "key": "key1",
+ "value": "value1"
+ },
+ {
+ "key": "key2",
+ "value": "value2"
+ }
+ ]
+}
+N/A
+See Status Codes.
+GET /v1.0/{project_id}/dedicated-host-tags/{dedicated_host_id}/tags
+Table 1 describes the parameters.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies the project ID. +For details about how to obtain the project ID, see Obtaining Required Information. + |
+
dedicated_host_id + |
+String + |
+Yes + |
+Specifies the DeH ID. +You can obtain the DeH ID from the DeH console or using the Querying DeHs API. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
tags + |
+Array of objects + |
+Specifies the list of tags. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
key + |
+String + |
+Specifies the tag key. + |
+
value + |
+String + |
+Specifies the tag value. + |
+
{
+ "tags": [
+ {
+ "key": "key1",
+ "value": "value1"
+ },
+ {
+ "key": "key2",
+ "value": "value2"
+ }
+ ]
+}
+See Status Codes.
+POST /v1.0/{project_id}/dedicated-host-tags/resource_instances/action
+Table 1 describes the parameters.
+ +Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
project_id + |
+String + |
+Yes + |
+Specifies the project ID. +For details about how to obtain the project ID, see Obtaining Required Information. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
tags + |
+Array of objects + |
+No + |
+Displays all DeHs with specified tags. For more information, see Table 3. +
|
+
not_tags + |
+Array of objects + |
+No + |
+Displays the DeHs with none of specified tags. +
|
+
limit + |
+String + |
+No + |
+Limits the maximum number of queried DeHs. The value cannot be a negative number. The maximum value is 1000. +
|
+
offset + |
+String + |
+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. +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. +
|
+
action + |
+String + |
+Yes + |
+Specifies the operation, which can be filter or count. +
|
+
tags_any + |
+Array of objects + |
+No + |
+Includes any of the specified tags. +
|
+
not_tags_any + |
+Array of objects + |
+No + |
+Excludes any of the specified tags. +
|
+
matches + |
+Array of objects + |
+No + |
+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. + |
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key + |
+String + |
+Yes + |
+Specifies the tag key. +
|
+
values + |
+Array of strings + |
+No + |
+Specifies the tag values. +
|
+
Parameter + |
+Type + |
+Mandatory + |
+Description + |
+
|---|---|---|---|
key + |
+String + |
+Yes + |
+Specifies the key parameter to be matched. +
NOTE:
+The parameter value can only be resource_name, which is the DeH name. + |
+
value + |
+String + |
+Yes + |
+Specifies the tag value. +
|
+
POST https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-host-tags/resource_instances/action
+{
+ "offset": "0",
+ "limit": "100",
+ "action": "filter",
+ "matches": [
+ {
+ "key": "resource_name",
+ "value": "resource1"
+ }
+ ],
+ "tags": [
+ {
+ "key": "key1",
+ "values": ["value1"]
+ }
+ ]
+}
+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. + |
+
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. + |
+
resource_name + |
+String + |
+Specifies the resource name. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
key + |
+String + |
+Specifies the tag key. +
|
+
value + |
+String + |
+Specifies the tag value. +
|
+
Response body when action is set to filter
+{
+ "resources": [
+ {
+ "resource_detail": null,
+ "resource_id": "cdfs_cefs_wesas_12_dsad",
+ "resource_name": "resource1",
+ "tags": [
+ {
+ "key": "key1",
+ "value": "value1"
+ }
+ ]
+ }
+ ],
+ "total_count": 1
+}
+Response body when action is set to count
+{
+ "total_count": 100
+}
+See Status Codes.
+Released On + |
+Description + |
+
|---|---|
2021-10-20 + |
+This issue is the eighth official release. +It incorporates the following change: +Optimized descriptions in DeH Tag Management. + |
+
2019-01-04 + |
+This issue is the seventh official release. +It incorporates the following change: +Added API Version Query. + |
+
2018-10-24 + |
+This issue is the sixth official release. +It incorporates the following change: +Accepted in OTC 3.2. + |
+
2018-10-16 + |
+This issue is the fifth official release. +It incorporates the following changes: +Deleted the sys_tags parameter from Adding Tags to a DeH in Batches, Deleting Tags from a DeH in Batches, Querying Tags of a DeH, and Querying DeHs by Tag. + |
+
2018-10-11 + |
+This issue is the fourth official release. +It incorporates the following change: +Added DeH Tag Management. + |
+
2018-05-30 + |
+This issue is the third official release. +It incorporates the following change: +Adjusted the structure. + |
+
2017-10-30 + |
+This issue is the second official release. +It incorporates the following change: +Optimized descriptions in Object Models. + |
+
2017-05-30 + |
+This issue is the first official release. + |
+