文档首页/ 专属主机 DeH/ API参考/ API/ 查询专属主机列表
更新时间：2023-12-13 GMT+08:00
查看PDF
分享

查询专属主机列表

功能介绍

通过该接口查询专属主机列表。

调试

您可以在API Explorer中调试该接口。

URI

GET /v1.0/{project_id}/dedicated-hosts

参数说明请参见表1。

表1 参数说明

参数

参数类型

是否必选

描述

project_id

String

是

项目ID。

获取方式请参见获取项目ID。

请求消息

可以在URI中增加如下参数，来过滤查询结果：host_type、host_type_name、flavor、dedicated_host_id、state、tenant、availability_zone、name、limit、marker、tags、instance_uuid、或者changes-since。

例如：/v1.0/{project_id}/dedicated-hosts?host_type={host_type}&state={state}

表2 请求参数

参数

位置

参数类型

是否必选

描述

dedicated_host_id

query

String

否

专属主机ID。

name

query

String

否

专属主机名称。

host_type

query

String

否

专属主机类型。

host_type_name

query

String

否

专属主机类型的名称。

flavor

query

String

否

规格ID。

state

query

String

否

专属主机状态。

取值范围：“available”、“fault”或“released”。

tenant

query

String

否

取值范围：租户ID或“all”。

只有具有DeH管理员权限的用户可以指定该参数。

availability_zone

query

String

否

专属主机所属AZ。

limit

query

String

否

每个页面上显示的条目数。

marker

query

String

否

该值是上一页最后一条记录的ID。如果“marker”取值无效，将会返回“400”错误码。

tags

query

String

否

专属主机标签。

instance_uuid

query

String

否

专属主机上的云服务器ID。

changes-since

query

String

否

当专属主机更新了状态时，按日期和时间戳过滤响应。为了便于记录更改，还可能返回最近删除的专属主机。

日期和时间戳的格式为ISO 8601：

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

如果包含“hh:mm”值，则将时区作为UTC的偏移量返回。例如，“2015-08-27T09:49:58-05:00”。如果您省略时区，则假定为UTC时区。

响应消息

表3 响应参数

参数

位置

参数类型

描述

dedicated_hosts

body

Array of objects

满足查询条件的专属主机。

具体请参见表1。

total

body

Integer

满足查询条件的专属主机数量。

请求示例

查询专属主机列表，专属主机状态为available。 
GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-hosts?state=available

响应示例

{
    "dedicated_hosts": [
        {
            "dedicated_host_id": "d465d0ae-f859-4a83-a508-8db654c05e7e",
            "name": "DEH001",
            "auto_placement": "off",
            "availability_zone": "cn-east-3a",
            "host_properties": {
                "vcpus": 74,
                "cores": 22,
                "sockets": 2,
                "memory": 151552,
                "host_type": "c6",
                "host_type_name": "dedicated_general_purpose",
                "available_instance_capacities": [
                    {
                        "flavor": "c6.large.2"
                    },
                    {
                        "flavor": "c6.xlarge.2"
                    },
                    {
                        "flavor": "c6.2xlarge.2"
                    },
                    {
                        "flavor": "c6.3xlarge.2"
                    },
                    {
                        "flavor": "c6.6xlarge.2"
                    },
                    {
                        "flavor": "c6.16xlarge.2"
                    }
                ]
            },
            "state": "available",
            "project_id": "9c53a566cb3443ab910cf0daebca90c4",
            "available_vcpus": 20,
            "available_memory": 40960,
            "instance_total": 5,
            "allocated_at": "2016-10-10T14:35:47Z",
            "released_at": ""
            }
            ],
    "total": 1
}

返回值

请参见状态码。

父主题： API

相关文档