DescribeTags - 查询标签资源--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

DescribeTags - 查询标签资源

最近更新时间：2024.05.21 10:23:57首次发布时间：2022.09.02 08:59:16

调用 DescribeTags 接口查询已绑定标签的资源。

注意事项

单次调用该接口最多支持查询10个标签。
同一标签键最多支持同时查询3个标签值。

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeTags	要执行的操作，取值：DescribeTags。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
ResourceType	String	是	instance	资源类型，取值： instance：实例 image：镜像 reservedinstance：预留实例券 scheduledinstance：弹性预约实例说明弹性预约实例正在邀测中，如需试用，请联系客户经理申请。
ResourceIds.N	Array of String	是	ResourceIds.1=i-l8u0p77yseabkpak**&ResourceIds.2=i-l8u0p7xyseabkbak**	资源ID。参数 - N：表示资源的序号，取值范围：1～50。多个资源之间用&分隔。
NextToken	String	否	bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******	分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的NextToken参数值。
MaxResults	Integer	否	10	分页查询时设置的每页行数。最大值：100 默认值：10
TagFilters.N.Values.N	Array of String	否	TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2	根据标签查询资源时指定的标签值。第一个N：表示标签键的序号，取值范围：1～10。第二个N：表示标签值的序号，取值范围：1～3。多个标签值之间用&分隔。说明如果传入该参数，则必须先传入`TagFilters.N.Key`。不传则表示查询同一标签键下的所有标签值。传入空字符串时，表示查询标签值为空的标签。
TagFilters.N.Key	Array of String	否	TagFilters.1.Key=k1	根据标签查询资源时指定的标签键。参数 - N：表示标签键的序号，取值范围：1～10。多个标签键之间用&分隔，不允许重复。说明不传则表示查询所有标签。传入空字符串时，则返回错误码InvalidTagFilterKey.Malformed。

返回参数

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

参数	类型	示例值	描述
NextToken	String	bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******	本次调用返回的查询凭证值，返回为空表示该页为末页。
TagResources	Array of TagResourcesForDescribeTags	--	由资源及其标签组成的集合。

请求示例

GET /?Action=DescribeTags&Version=2020-04-01&ResourceType=instance&ResourceIds.1=i-l8u0p77yseabkpak****&ResourceIds.2=i-l8u0p7xyseabkbak****&TagFilters.1.Key=k1&TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "DescribeTags",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "NextToken": "bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******"
        "TagResources": [
            {
                "ResourceType": "instance",
                "ResourceId": "i-l8u0p77yseabkpak****",
                "TagKey": "k1",
                "TagValue": "v1"
            },
            {
                "ResourceType": "instance",
                "ResourceId": "i-l8u0p7xyseabkbak****",
                "TagKey": "k1",
                "TagValue": "v2"
            }
        ]
    }
}

错误码

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

状态码	错误码	错误信息	说明
400	InvalidArgument	The specified argument is invalid.	指定的参数不合法。
400	LimitExceeded.MaximumResourceIds	You've reached the limit on the number of ResourceIds that you can set.	指定的资源ID数量超过限制。
400	LimitExceeded.MaximumTagFilterKeys	You've reached the limit on the number of TagFilterKeys that you can set.	指定的查询标签键超出取值范围。
400	LimitExceeded.MaximumTagFilterValues	You've reached the limit on the number of TagFilterValues that you can set.	指定的查询标签值超出取值范围。
400	InvalidTagFilterKey.Malformed	The specified TagFilterKey is malformed.	指定的查询标签的键格式错误。
400	InvalidTagFilterValue.Malformed	The specified TagFilterValue is malformed.	指定的查询标签的值格式错误。
404	InvalidResourceType.NotFound	The specified ResourceType does not exist.	指定的资源类型不存在。
409	InvalidTagFilterKey.Conflict	The specified TagFilterKey already exists.	指定的过滤标签键已存在。