调用ListTagResources接口列出所查询资源的标签列表。您可以一次查询多个同类型的资源,也可以按标签键值过滤资源。
接口说明
- 请求语法中Host由Project名称和日志服务Endpoint构成,您需要在Host中指定Project。
-
已创建并获取AccessKey。更多信息,请参见访问密钥。
阿里云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作,请参见创建RAM用户及授权。
- 已明确您查询日志所属的Project名称、所属地域等。如何查询,请参见管理Project。
- 鉴权规则,请参见鉴权概览。目前支持的资源包括project、logstore、dashboard、MachineGroup和LogtailConfig。
鉴权资源
下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息,用于为RAM用户或RAM角色授予调用此API的权限。
动作(Action) |
授权策略中的资源描述方式(Resource) |
log:ListTagResources |
不同类型资源对应不同格式。 - - - - - |
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
GET /tags HTTP/1.1
请求参数
名称 |
类型 |
位置 |
是否必选 |
示例值 |
描述 |
resourceType | String | Query | 是 | project | 资源的类型。
|
resourceId | Array of String | Query | 否 | ali-test-project | 资源ID。以日志库为例,projectName代表项目名称,#为拼接字符,logstore为日志库名称。
|
tags | Array | Query | 否 | 精确查询时,用于过滤的标签键值对。resourceId与tags应至少配置一个。 最多设置20个tag。 |
|
key | String | Query | 是 | key1 | 查询时用于过滤标签的键,例如key为 |
value | String | Query | 否 | value1 | 查询时用于过滤标签的值,当值为null时表示只根据key过滤。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
Server | String | nginx | 服务器名称。 |
Content-Type | String | application/json | 返回的响应体的内容格式。 |
Content-Length | String | 0 | 响应内容长度。 |
Connection | String | close | 是否长连接。取值包括:
|
Date | String | Sun, 27 May 2018 08:25:04 GMT | 返回响应的时间。 |
x-log-requestid | String | 5B0A6B60BB6EE39764D458B5 | 服务端产生的标识,该请求的唯一ID。 |
nextToken | String | caeba0bbb2be03f84eb48b699f0a4883 | 下一个查询开始Token。 |
tagResources | Array | 返回的标签列表。 |
|
resourceId | String | ali-test-project | 资源ID。 |
resourceType | String | project | 资源类型。 |
tagKey | String | key1 | 标签的键。 |
tagValue | String | value1 | 标签的值。 |
示例
请求示例
GET /tags?resourceType=project&resourceId=["ali-test-project"]&tags=[{"key":"key1","value":"value1"}] HTTP/1.1
Host:ali-test-project.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json
正常返回示例
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"nextToken" : "caeba0bbb2be03f84eb48b699f0a4883",
"tagResources" : [ {
"resourceId" : "ali-test-project",
"resourceType" : "project",
"tagKey" : "key1",
"tagValue" : "value1"
} ]
}
错误码
访问错误中心查看更多错误码。