ListTagsForResources-获取标签列表--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

ListTagsForResources-获取标签列表

最近更新时间：2024.12.10 10:36:52首次发布时间：2024.11.20 11:13:12

获取资源的标签列表。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com?Action=ListTagsForResources?Version=2022-06-01

请求参数

除了以下参数，您还需要对请求进行鉴权。

Query

名称	类型	是否必选	示例值	描述
Action	String	是	`ListTagsForResources`	API 的名称。该参数的取值是 `ListTagsForResources`。
Version	String	是	`2022-06-01`	API 的版本。该参数的取值是 `2022-06-01`。
ResourceType	String	是	`zone`	资源类型。 zone：域名。 endpoint：终端节点。 rule：转发规则。
TagType	String	否	`custom`	标签类型。 custom：用户标签。 system：系统标签。如果您不传入该参数，私网解析 PrivateZone 会查询全部类型的标签。
NextToken	String	否	`custom`	分页查询凭证，用于标记分页的位置。您在初次调用该 API 时无需设置该参数。非初次调用该 API 时，该参数的取值为上一次 API 调用时该 API 返回的 `NextToken` 参数值。
ResourceIds	Array of strings	否	`["101", "102", "103"]`	资源 ID。数组的最大长度为 50。
TagFilters.N	String	否	`TagFilters.1={"Key":"k1","Values":["v1", "v2"]}&TagFilters.2={"Key":"k2","Values":["v1", "v2"]}`	资源的标签。您需要指定： N：表示 `TagFilters` 的序号，取值范围：1～10。`N` 应按照从小到大的顺序，且必须为连续的数字。标签键：例如 `"Key":"k1"`。如果您指定多个标签键，私网解析 PrivateZone 会查询同时包含所有指定标签键的资源。标签值：例如 `Values":["v1", "v2"]`。标签值数组的长度取值范围为 1～3。您可不传入 `Values`，表示查询时 `Values` 不作为查询条件。如果您把仅包含空字符串的数组传入 `Values`，私网解析 PrivateZone 会查询 `Values` 为空的标签。如果一个 `Values` 包含多个值，这些值之间的关系为逻辑或（OR）。
MaxResults	Integer	否	`10`	返回值中标签的数量，默认为 10，最大为 100。

返回参数

ResponseMetadata 对象

参数	类型	描述
RequestId	String	标识本次请求的 ID。
Action	String	Action 查询参数的值。
Version	String	API 版本。
Service	String	服务类型。
Region	String	服务所在地域。

Result 对象

参数	类型	描述
NextToken	String	分页的位置。
ResourceTags	Array of objects	标签列表。

示例

请求示例

GET https://open.volcengineapi.com/?Action=ListTagsForResources&Version=2022-06-01&ResourceType=zone

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20241015113935D1D870440AFA73971732",
        "Action": "ListTagsForResources",
        "Version": "2022-06-01",
        "Service": "private_zone",
        "Region": "cn"
    },
    "Result": {
        "NextToken": "55",
        "ResourceTags": [
            {
                "ResourceType": "zone",
                "ResourceId": "198356",
                "TagKey": "450",
                "TagValue": "450"
            },
            {
                "ResourceType": "zone",
                "ResourceId": "198356",
                "TagKey": "277",
                "TagValue": "277"
            },
            {
                "ResourceType": "zone",
                "ResourceId": "198356",
                "TagKey": "303",
                "TagValue": "303"
            },
            {
                "ResourceType": "zone",
                "ResourceId": "198356",
                "TagKey": "326",
                "TagValue": "326"
            },
            {
                "ResourceType": "zone",
                "ResourceId": "198356",
                "TagKey": "448",
                "TagValue": "448"
            },
            {
                "ResourceType": "zone",
                "ResourceId": "198356",
                "TagKey": "471",
                "TagValue": "471"
            },
            {
                "ResourceType": "zone",
                "ResourceId": "198356",
                "TagKey": "495",
                "TagValue": "495"
            },
            {
                "ResourceType": "zone",
                "ResourceId": "198356",
                "TagKey": "6",
                "TagValue": "6"
            },
            {
                "ResourceType": "zone",
                "ResourceId": "198356",
                "TagKey": "8",
                "TagValue": "8"
            },
            {
                "ResourceType": "zone",
                "ResourceId": "198356",
                "TagKey": "455",
                "TagValue": "455"
            }
        ]
    }
}

错误码

您可访问公共错误码，获取详细信息。