ListTagsForResources--日志服务-火山引擎

文档中心

立即注册

导航

日志服务

ListTagsForResources

最近更新时间：2024.11.26 18:02:12首次发布时间：2024.11.22 11:13:39

调用 ListTagsForResources 接口查询资源所绑定的全部标签。

请求说明

请求方式：POST
请求地址：https://tls-{Region}.ivolces.com/ListTagsForResources

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Body

参数	类型	是否必选	示例值	描述
MaxResults	Integer	否	`10`	分页大小。默认为 20，最大为 100。
NextToken	String	否	`caeba0bbb2be03f84b699f0a****`	分页查询凭证，用于标记分页的位置。不填则从头开始查询。传入之前调用本 API 返回的 `NextToken` 值，则从该次 API 调用标记分页的位置往后开始查询。
ResourceType	String	是	`project`	资源类型，支持设置为： project：日志项目 topic：日志主题
ResourcesIds	Array of String	否	`["c7e0e442-19bf-4fb3-b547-5992fb8b****","2d838e08-a5d2-4d12-a1c1-5dc2b9bfc63e"]`	资源列表，即日志项目或日志主题的 ID 列表。支持一次传入多个资源 ID，最多同时传入 50 个资源 ID。
TagFilters	Array of FilterTag	否	`[{"Key": "owner", "Values": ["zhangsan"]}]`	资源标签过滤器。

FilterTag

参数	类型	是否必选	示例值	描述
Key	String	否	`owner`	标签 Key 的值。设置规则请参考标签设置规则。
Values	Array of String	否	`["zhangsan"]`	标签 Value 的值。设置规则请参考标签设置规则。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
ResourceTags	Array of ResourceTag	`/`	资源所绑定的标签列表。
nextToken	String	`caeba02be03f84b699f0b****`	分页查询凭证。

ResourceTag

参数	类型	示例值	描述
TagKey	String	`owner`	标签 Key 的值。
TagValue	String	`zhangsan`	标签 Value 的值。
ResourceId	String	`0fdaa6b6-3c9f-424c-8664-fc0d222c****`	资源列表，即日志项目或日志主题的 ID 列表。
ResourceType	String	`project`	资源类型。

请求示例

POST https://tls-{Region}.ivolces.com/ListTagsForResources HTTP/1.1
Content-Type: application/json
{
    "MaxResults": 10,
    "NextToken": "caeba0bbb2be03f84b699f0a****",
    "ResourceType": "project",
    "ResourcesIds": [
        "c7e0e442-19bf-4fb3-b547-5992fb8b****",
        "2d838e08-a5d2-4d12-a1c1-5dc2b9bfc63e"
    ],
    "TagFilters": [
        {
            "Key": "owner",
            "Values": [
                "zhangsan"
            ]
        }
    ]
}

返回示例

Content-Type: application/json; charset=utf-8
{
    "ResourceTags": [
        {
            "TagKey": "owner",
            "TagValue": "zhangsan",
            "ResourceId": "0fdaa6b6-3c9f-424c-8664-fc0d222c****",
            "ResourceType": "project"
        }
    ],
    "nextToken": "caeba02be03f84b699f0b****"
}

错误码

您可访问公共错误码，获取更多错误码信息。