查询用户标签列表

接口说明

本接口用于查询用户标签列表。您可以根据标签键或标签值进行精确查询,返回所有满足筛选条件的标签列表。


推荐使用API Explorer调试

API Explorer支持接口在线可视化调用,同时自动生成动态代码示例,搭配OpenAPI SDK无需计算签名实现接口快速集成。

URL

POST https://ecloud.10086.cn/api/openapi-ecs/acl/v3/server/tags/list

请求参数

Body

参数名称
类型
必填
描述
tagListReq
TagListReq
是

查询标签列表请求体。

key
string
否

标签键。

page
integer(int32)
否

列表分页页数,起始页为1。

pageSize
integer(int32)
否

列表分页每页大小。
默认值:10。
最大值:100。

value
string
否

标签值。

请求示例

POST https://ecloud.10086.cn/api/openapi-ecs/acl/v3/server/tags/list
{
	"tagKey":"key1",
	"tagValue":"value1",
	"page":1,
	"pageSize":10
}

返回参数

返回码:200
OK
参数名称
类型
描述
body
分页查询统一返回结构体«TagResp»

请求成功时返回的数据

content
<TagResp> array

分页查询返回的具体结构体

createTime
string

标签创建时间

id
string

标签的ID

key
string

标签键

resourceNum
integer(int32)

绑定的资源数量

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-dc47c06e-28eb-470c-ad98-***",
	"state":"OK",
	"body":{
		"total":1,
		"content":[
			{
				"id":"81a51833-****",
				"createTime":"2024-10-16 13:45:32",
				"tagType":"user",
				"tagKey":"test-***",
				"tagValue":"1",
				"resourceNum":1
			}
		]
	}
}
本文档内容整理自移动云官方帮助中心(查看原文),仅供参考。