功能介绍
通过该接口查询 专属主机 列表。
调试
您可以在API Explorer中调试该接口。
URI
GET /v1.0/{project_id}/dedicated-hosts
请求消息
可以在URI中增加如下参数，来过滤查询结果：host_type、host_type_name、flavor、dedicated_host_id、state、tenant、availability_zone、name、limit、marker、tags、instance_uuid、released_at、或者changes-since。
例如：/v1.0/{project_id}/dedicated-hosts?host_type={host_type}&state={state}
|
参数 |
位置 |
参数类型 |
是否必选 |
描述 |
|---|---|---|---|---|
|
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。 |
|
released_at |
query |
String |
否 |
专属主机的释放时间。 |
|
changes-since |
query |
String |
否 |
当专属主机更新了状态时，按日期和时间戳过滤响应。为了便于记录更改，还可能返回最近删除的专属主机。 日期和时间戳的格式为ISO 8601： CCYY-MM-DDThh:mm:ss±hh:mm 如果包含“hh:mm”值，则将时区作为UTC的偏移量返回。例如，“2015-08-27T09:49:58-05:00”。如果您省略时区，则假定为UTC时区。 |
响应消息
|
参数 |
位置 |
参数类型 |
描述 |
|---|---|---|---|
|
dedicated_hosts |
body |
Array of objects |
满足查询条件的专属主机。 具体请参见表1。 |
|
total |
body |
Integer |
满足查询条件的专属主机数量。 |
请求示例
GET https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-hosts?state=available
响应示例
{
"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
}
返回值
请参见状态码。
