接口说明
查询用户标签列表。您可以根据标签键或标签值进行精确查询,返回所有满足筛选条件的标签列表。
说明:
-
仅指定标签键时,则返回关联该标签键的所有资源。
-
仅指定标签值时,则返回关联该标签值的所有资源。
-
同时指定标签键和标签值时,则返回满足标签键值对的所有资源。
URL
POST https://ecloud.10086.cn/api/openapi-instance/v4/tags/user
请求参数
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
tagListReq
|
TagListReq
|
是
|
tagListReq |
|
key
|
string
|
否
|
标签键。 |
|
value
|
string
|
否
|
标签值。 |
|
page
|
integer(int32)
|
否
|
列表分页页数,起始页为1。 |
|
pageSize
|
integer(int32)
|
否
|
列表分页每页大小,默认值为10,最大值为100。 |
请求示例
POST https://ecloud.10086.cn/api/openapi-instance/v4/tags/user
{
"key":"key1",
"value":"value1",
"page":1,
"pageSize":10
}
返回参数
返回码:200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
PageListResp«TagResp»
|
请求成功时返回的数据。 |
|
content
|
<TagResp> array
|
分页查询返回的具体结构体。 |
|
id
|
string
|
标签的ID。 |
|
createTime
|
string
|
标签创建时间。 |
|
key
|
string
|
标签键。 |
|
value
|
string
|
标签值。 |
|
resourceNum
|
integer(int32)
|
绑定的资源数量。 |
|
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-b2283fa5a5f3bca36e5bf26ea7b7d78a",
"state":"OK",
"body":{
"total":1,
"content":[
{
"id":"7f5eee2b-da32-4b1b-9ed2-588fb3wtdfe3",
"createTime":"2025-12-29 10:44:53",
"key":"key123",
"value":"value123",
"resourceNum":0
}
]
}
}