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

注意事项

单次调用该接口最多支持查询10个标签。

同一标签键最多支持同时查询3个标签值。

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：DescribeTags

要执行的操作，取值：DescribeTags。

Version string 必选示例值：2020-04-01

API的版本，取值：2020-04-01。

ResourceType string 必选示例值：volume

资源类型，取值：

volume：云盘。

snapshot：快照。

snapshotpolicy：自动快照策略。

snapshotgroup：快照一致性组。

SysTagVisible boolean 可选示例值：true

是否展示系统标签。取值范围如下：

true：展示系统标签。

false：不展示系统标签。默认值为false。

TagFilters.N.Key string[] 可选示例值：TagFilters.1.Key=tag

根据标签查询资源时指定的标签键。说明如下：

TagFilters.N.Key：N表示标签键的序号。取值范围：1～10。

多个标签键之间用&分隔，不允许重复。

不传入该参数则表示查询所有标签。

传入空字符串时，则返回错误码InvalidTagFilterKey.Malformed。

TagFilters.N.Values.N string[] 可选示例值：TagFilters.1.Values.1=tag&TagFilters.1.Values.2=test

根据标签查询资源时指定的标签值。说明如下：

TagFilters.N.Values.N：第一个N表示标签键的序号。取值范围：1～10。

TagFilters.N.Values.N：第二个N表示标签值的序号。取值范围：1～3。

多个标签值之间用&分隔。

如果传入该参数，则必须先传入TagFilters.N.Key。

不传入该参数则表示查询同一标签键下的所有标签值。

传入空字符串时，表示查询标签值为空的标签。

ResourceIds.N string[] 必选示例值：ResourceIds.1=vol-76pwr6rilv8lzwxv****&ResourceIds.2=vol-76pwr6rilv8lzwxv****

需要查询标签的资源ID。说明如下：

ResourceIds.N：N表示资源的序号。取值范围：1～50。

多个资源之间用&分隔。

PageNumber integer 可选示例值：1

页数索引。

PageSize integer 可选示例值：100

分页的页容量。

返回参数

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

PageNumber integer 示例值：1

页数索引。

PageSize integer 示例值：100

分页的页容量。

TotalCount integer 示例值：3

符合条件的标签总数。

TagResources object[] 示例值：-

标签信息。

ResourceId string 示例值：snap-3wr1z86cky4p5d6d****

资源ID。

TagKey string 示例值：user

标签键。

ResourceType string 示例值：snapshot

资源类型，取值：

volume：云盘。

snapshot：快照。

snapshotpolicy：自动快照策略。

snapshotgroup：快照一致性组。

TagValue string 示例值：data

标签值。

请求示例

返回示例

错误码

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

状态码	错误码	错误信息	说明
400	ErrTagNotFound	tag not found in request	请求中未找到标签。
400	ErrTagServiceUnavailable	tag service unavailable	标签服务不可用。
400	ErrResourceTypeNotFound	resource type not found	未找到资源类型。
400	ErrMaximumTagFilterKeys	too many tag filter keys	标签过滤键超出限制。
400	ErrTagFilterKeyConflict	tag filter key conflict	标签过滤器键冲突。
400	ErrInvalidTagFilterKey	tag filter key invalid	标签过滤键无效。
400	ErrMaximumTagFilterValues	too many tag filter value	标签过滤值超出限制。
400	ErrInvalidTagFilterValue	tag filter value invalid	标签过滤器值无效。
400	ErrInvalidAccountId	account id invalid	账号ID无效。

云服务器