Querying DeH Types

Function

This API is used to query the list of DeH types.

Authorization

Your account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned. For the specific permissions required, see Permissions and Supported Actions.

URI

GET /v1.0/{project_id}/dedicated-host-types

Table 1 describes the parameters.

**Table 1** Parameter description
Parameter	Type	Mandatory	Description
project_id	String	Yes	The project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request

**Table 2** Request parameters
Parameter	Location	Type	Mandatory	Description
flavor	query	String	No	The ID of the DeH flavor.
availability_zone	query	String	No	The AZ to which the DeH belongs.
host_type	query	String	No	The DeH type. For details, see Categories and Types > Overview.
limit	query	String	No	The number of records displayed per page.
marker	query	String	No	The ID of the last record on the previous page. If the marker value is invalid, status code 400 is returned.

Response

**Table 3** Response parameter
Parameter	Location	Type	Description
dedicated_host_types	body	Array of objects	The objects of the DeH type. For details, see Table 4.

**Table 4** **dedicated_host_types** field description
Parameter	Type	Description
host_type	String	The DeH type. The value can contain a maximum of 255 characters and cannot start or end with spaces.
vcpus	Integer	The number of vCPUs of the DeH type.
cores	Integer	The number of physical cores of the DeH type.
sockets	Integer	The number of physical sockets of the DeH type.
memory	Integer	The physical memory of the DeH type.
category	String	The category that the DeH type belongs to.
supported_flavors	Array	The list of flavors supported by the DeH type.
availability_zone_offerings	Array	The list of AZs where the DeH type is supported. For details, see Table 5.
page_info	Object	Pagination information of the list. For details, see Table 7.

**Table 5** **availability_zone_offerings** field description
Parameter	Type	Description
availability_zone_offering	Object	The objects of the AZs where the DeH type is supported. For details, see Table 6.

**Table 6** **availability_zone_offering** field description
Parameter	Type	Description
availability_zone	String	The AZs where the DeH type is supported.
status	String	The status of the AZs where the DeH type is supported. available: indicates that the DeH type is available in the AZ. sellout: indicates that the DeH type has been sold out in the AZ. abandon: indicates that the DeH type is unavailable in the AZ.

**Table 7** **page_info** field description
Parameter	Type	Description
next_marker	String	The query starts from the next item after this DeH type specified by next_marker.

Example Request

Querying the DeH type whose flavor is ac9.48xlarge.2.

GET https://{Endpoint}/v1/9c53a566cb3443ab910cf0daebca90c4/dedicated-host-types?limit=1

Example Response

{
    "dedicated_host_types": [
        {
            "host_type": "t7",
            "vcpus": 1080,
            "cores": 52,
            "sockets": 4,
            "memory": 1431552,
            "category": "dedicated_general_purpose",
            "supported_flavors": [
                "t7.xlarge.1",
                "t7.large.2",
                "t7.large.05",
                "t7.large.4",
                "t7.large.025",
                "t7.large.1"
            ],
            "availability_zone_offerings": []
        }
    ],
    "page_info": {
        "next_marker": "t7"
    }
}