describeDedicatedHosts
描述
查询一台或多台专有宿主机的详细信息。
接口说明
- 使用
filters
过滤器进行条件筛选,每个 filter
之间的关系为逻辑与(AND)的关系。
- 单次查询最大可查询100条专有宿主机实例数据。
- 尽量一次调用接口查询多条数据,不建议使用该批量查询接口一次查询一条数据,如果使用不当导致查询过于密集,可能导致网关触发限流。
- 由于该接口为
GET
方式请求,最终参数会转换为 URL
上的参数,但是 HTTP
协议下的 GET
请求参数长度是有大小限制的,使用者需要注意参数超长的问题。
请求方式
GET
请求地址
https://dh.jdcloud-api.com/v1/regions/{regionId}/dedicatedHosts
名称 |
类型 |
是否必需 |
示例值 |
描述 |
regionId |
String |
是 |
cn-north-1 |
地域ID |
请求参数
名称 |
类型 |
是否必需 |
示例值 |
描述 |
pageNumber |
Integer |
否 |
1 |
页码;默认为1 |
pageSize |
Integer |
否 |
|
分页大小;默认为20;取值范围[10, 100] |
tags |
TagFilter[ ] |
否 |
|
Tag筛选条件 |
resourceGroupIds |
String[ ] |
否 |
|
资源组ID |
filters |
Filter[ ] |
否 |
|
filters 中支持使用以下关键字进行过滤 dedicatedHostId : 专有宿主机ID,精确匹配,支持多个 az : 可用区,精确匹配,支持多个
status : 专有宿主机状态,精确匹配,支持多个,参考专有宿主机状态 name : 专有宿主机名称,模糊匹配,支持单个 dedicatedPoolId : 专有宿主机池ID,精确匹配,支持多个 dedicatedHostType : 专有宿主机机型,精确匹配,支持多个
|
Filter
名称 |
类型 |
是否必需 |
示例值 |
描述 |
name |
String |
是 |
name |
过滤条件的名称 |
operator |
String |
否 |
eq |
过滤条件的操作符,默认eq |
values |
String[ ] |
是 |
name-test |
过滤条件的值 |
TagFilter
名称 |
类型 |
是否必需 |
示例值 |
描述 |
key |
String |
是 |
|
Tag键 |
values |
String[ ] |
否 |
|
Tag值 |
返回参数
名称 |
类型 |
描述 |
result |
Result |
|
requestId |
String |
|
Result
DedicatedHost
名称 |
类型 |
描述 |
dedicatedHostId |
String |
专有宿主机ID |
name |
String |
专有宿主机名称 |
az |
String |
专有宿主机所在可用区 |
dedicatedHostType |
String |
专有宿主机机型 |
description |
String |
专有宿主机描述 |
status |
String |
专有宿主机状态,参考专有宿主机状态
|
dedicatedPoolId |
String |
专有宿主机所在的专有宿主机池ID |
logicRack |
Integer |
专有宿主机所在的逻辑机架 |
supportedInstanceType |
String[ ] |
专有宿主机支持的云主机规格 |
capacity |
ResourceCapacity |
专有宿主机资源使用信息 |
instanceIds |
String[ ] |
专有宿主机上的云主机ID |
charge |
Charge |
计费信息 |
createTime |
String |
创建时间 |
tags |
Tag[ ] |
Tag信息 |
resourceGroupId |
String |
资源组ID |
Tag
名称 |
类型 |
示例值 |
描述 |
key |
String |
环境 |
Tag键 |
value |
String |
测试 |
Tag值 |
Charge
名称 |
类型 |
描述 |
chargeMode |
String |
支付模式,返回值为: prepaid_by_duration : 预付费 postpaid_by_usage :按用量后付费 postpaid_by_duration : 按配置后付费 |
chargeStatus |
String |
费用支付状态,返回值为:
normal : 正常 overdue :已到期 arrear :欠费 |
chargeStartTime |
String |
计费开始时间,遵循ISO8601标准,使用UTC时间,格式为:YYYY-MM-DDTHH:mm:ssZ |
chargeExpiredTime |
String |
过期时间,预付费资源的到期时间,遵循ISO8601标准,使用UTC时间,格式为:YYYY-MM-DDTHH:mm:ssZ,后付费资源此字段内容为空 |
chargeRetireTime |
String |
预期释放时间,资源的预期释放时间,预付费/后付费资源均有此值,遵循ISO8601标准,使用UTC时间,格式为:YYYY-MM-DDTHH:mm:ssZ |
ResourceCapacity
名称 |
类型 |
描述 |
totalVCPUs |
Integer |
专有宿主机总VCPU数 |
totalMemoryMB |
Integer |
专有宿主机总内存大小,单位MB |
totalDiskGB |
Integer |
专有宿主机总本地磁盘大小,单位GB |
totalGPUs |
Integer |
专有宿主机总GPU个数 |
usedVCPUs |
Integer |
专有宿主机已分配的VCPU数 |
usedMemoryMB |
Integer |
专有宿主机已分配的内存大小,单位MB |
usedDiskGB |
Integer |
专有宿主机已分配的本地磁盘大小,单位GB |
usedGPUs |
Integer |
专有宿主机已分配的GPU个数 |
localDiskType |
String |
专有宿主机本地盘类型 |
instanceCount |
Integer |
专有宿主机上的云主机个数 |
请求示例
GET
/v1/regions/cn-north-1/dedicatedHosts
返回示例
{
"requestId": "9d832c955a6ed94884bba7bec1505d3c",
"result": {
"dedicatedHosts": [
{
"dedicatedHostId": "host-nrj0****o0",
"name": "name-test",
"az": "cn-north-1c",
"dedicatedHostType": "g2.c76",
"status": "available",
"dedicatedPoolId": "pool-urn7rqof1q",
"logicRack": "1",
"supportedInstanceType": [
"g.n2.medium",
"g.n2.large",
"g.n2.xlarge",
"g.n2.2xlarge",
"g.n2.4xlarge",
"g.n2.8xlarge",
"g.n2.16xlarge",
"g.n2.18xlarge",
"c.c2.large",
"c.c2.xlarge",
"c.c2.2xlarge",
"c.c2.3xlarge",
"c.c2.4xlarge",
"c.n2.large",
"c.n2.xlarge",
"c.n2.2xlarge",
"c.n2.4xlarge",
"c.n2.8xlarge",
"c.n2.16xlarge",
"c.n2.18xlarge",
"m.n2.large",
"m.n2.xlarge",
"m.n2.2xlarge",
"m.n2.4xlarge",
"m.n2.8xlarge"
],
"capacity": {
"totalVCPUs": 76,
"totalMemoryMB": 311296,
"totalDiskGB": 1743,
"totalGPUs": 0,
"usedVCPUs": 2,
"usedMemoryMB": 8192,
"usedDiskGB": 0,
"usedGPUs": 0,
"localDiskType": "",
"instanceCount": 2
},
"instanceIds": [
"i-wluy****9d",
"i-ioyy****nx"
],
"charge": {
"chargeMode": "postpaid_by_duration",
"chargeStatus": "normal",
"chargeStartTime": "2021-09-07T09:22:27Z"
},
"tags": [
{
"key": "123",
"value": "456"
},
{
"key": "abc",
"value": "def"
}
],
"resourceGroupId": "rg-default",
"createTime": "2021-09-07 17:22:27"
}
],
"totalCount": 1
}
}
返回码
返回码 |
描述 |
200 |
OK |
400 |
Invalid parameter |
401 |
Authentication failed |
404 |
Not found |
500 |
Internal server error |
503 |
Service unavailable |