接口说明
本接口用于根据标签检索云主机资源。
URL
POST https://ecloud.10086.cn/api/openapi-ecs/acl/v3/server/tags/resources
请求参数
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
tagResourceReq
|
TagResourceReq
|
是
|
根据标签检索云主机资源请求体。 |
|
page
|
integer(int32)
|
否
|
列表分页页数，起始页为1。 |
|
pageSize
|
integer(int32)
|
否
|
列表分页每页大小，默认为10。 |
|
resourceTypes
|
<string> array
|
否
|
资源类型，取值范围是： |
|
tags
|
<TagReq> array
|
否
|
标签列表。 |
|
key
|
string
|
是
|
标签键。 |
|
value
|
string
|
是
|
标签值。 |
请求示例
POST https://ecloud.10086.cn/api/openapi-ecs/acl/v3/server/tags/resources{
"resourceTypes":[
"CIDC-RT-VM",
"CIDC-RT-SYSDISK"
],
"tags":[
{
"key":"test-1105",
"value":"3"
}
],
"pageSize":10,
"page":1
}返回参数
返回码：200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
PageListResp«TagResourceResp»
|
请求成功时返回的数据 |
|
content
|
<TagResourceResp> array
|
分页查询返回的具体结构体 |
|
resourceId
|
string
|
资源ID |
|
resourceType
|
string
|
资源类型 |
|
tags
|
<BindedTags> array
|
绑定的标签列表 |
|
key
|
string
|
标签键 |
|
tagId
|
string
|
标签ID |
|
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
{
"requestId":"reqId-7c752d9a-6a0f-43fd-a0d6-05cb323f2ef8",
"state":"OK",
"body":{
"total":1,
"content":[
{
"resourceId":"ebeca7cf-a757-4299-9415-***",
"resourceType":"CIDC-RT-VM",
"tags":[
{
"tagId":"191a3618-48ce-4538-8e0a-***",
"key":"test-1016",
"value":"2"
}
]
}
]
}
}