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

文档中心

立即注册

导航

ListTagsForResources - 获取标签列表

最近更新时间：2025.05.22 20:14:00首次发布时间：2024.11.20 11:13:12

获取资源的标签列表。

使用说明

请求频率：每秒最多调用 5 次。

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListTagsForResources	要执行的操作，取值：ListTagsForResources。
Version	String	是	2022-06-01	API的版本，取值：2022-06-01。
ResourceType	String	是	zone	资源类型。 zone：域名。 endpoint：终端节点。 rule：转发规则。
TagType	String	否	custom	标签类型。 custom：用户标签。 system：系统标签。如果您不传入该参数，私网解析 PrivateZone 会查询全部类型的标签。
ResourceIds	Array of String	否	["101", "102", "103"]	资源 ID。数组的最大长度为 50。
TagFilters	Array of Object	否	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）。
NextToken	String	否	55	分页查询凭证，用于标记分页的位置。您在初次调用该 API 时无需设置该参数。非初次调用该 API 时，该参数的取值为上一次 API 调用时该 API 返回的 NextToken 参数值。
MaxResults	Integer	否	10	返回值中标签的数量，默认为 10，最大为 100。

返回参数

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

参数	类型	示例值	描述
NextToken	String	55	分页的位置。
ResourceTags	Array of Object	无	标签列表。

请求示例

GET https://private-zone.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"
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	ErrParamInvalid	validation fail: params:[%s] , value:[%v]	参数校验失败
400	ErrLimitExceeded	you've reached the limit on the number of %s that you can operate at one time	已达到单次可操作数量的上限
500	ErrInternalServer	server internal error	服务内部错误