接口说明
本接口提供按标签查询专属宿主机列表的功能,可以提供多个标签键值对作为入参进行查询,返回结果将取多个标签键值对查询结果得并集。
URL
POST https://ecloud.10086.cn/api/openapi-ddh/customer/v3/dedicatedHost/cloudApi/v2/host/queryByTags
请求参数
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
dedicatedHostTagReq
|
DedicatedHostTagReq
|
是
|
按标签查询专属宿主机资源信息请求体 |
|
page
|
integer(int32)
|
否
|
列表分页页数 |
|
pageSize
|
integer(int32)
|
否
|
列表分页每页大小 |
|
tags
|
<TagReq> array
|
是
|
标签 |
|
key
|
string
|
是
|
标签键,标签键仅支持数字、中英文、中划线、下划线,长度在1-127位之间,且不可重复不能以'ecloud'开头 |
|
value
|
string
|
是
|
标签值,标签值仅支持数字、中英文、中划线、下划线,长度在1-255位之间,不能以'ecloud'开头 |
请求示例
POST https://ecloud.10086.cn/api/openapi-ddh/customer/v3/dedicatedHost/cloudApi/v2/host/queryByTags
{
"page":1,
"pageSize":10,
"tags":[
{
"key":"key",
"value":"value"
}
]
}
返回参数
返回码:200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
PageListResp«DedicatedHostResourceResp»
|
查询用户标签列表返回体 |
|
content
|
<DedicatedHostResourceResp> array
|
分页查询返回的具体结构体 |
|
createTime
|
string
|
专属宿主机创建时间 |
|
dedicatedHostId
|
string
|
专属宿主机ID |
|
tagNum
|
integer(int32)
|
专属宿主机绑定标签数量 |
|
tags
|
<TagResp> array
|
标签信息结构体 |
|
id
|
string
|
标签ID |
|
key
|
string
|
标签键 |
|
value
|
string
|
标签值 |
|
total
|
integer
|
满足查询条件的总个数 |
|
errorCode
|
string
|
统一错误码 |
|
errorMessage
|
string
|
页面国际化错误提示 |
|
errorParams
|
<string> array
|
统一错误码的自定义参数 |
|
requestId
|
string
|
每个请求的序列号 |
|
state
|
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)
|
返回状态码;返回正常:OK,返回错误:ERROR,返回异常:EXCEPTION,需要告警实现的:ALARM,禁止访问:FORBIDDEN |
返回示例
返回码:200
OK
{
"body":{
"content":[
{
"createTime":"yyyy-MM-dd hh:mm:ss",
"dedicatedHostId":"id1",
"tagNum":1,
"tags":[
{
"id":"tagId1",
"key":"key1",
"value":"value1"
}
]
}
],
"total":1
},
"requestId":"reqId1",
"state":"OK"
}