文档中心

数据库传输服务

标签管理

DescribeTagsByResource

DescribeTagsByResource

调用 DescribeTagsByResource 接口查询任务的标签。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
TaskIds	Array of String	是	[ "18064de5e9d345dc965ee45217******" ]	任务 ID 列表信息。支持一次传入多个任务 ID，最多同时传入 20 个任务 ID。
PageNumber	Integer	否	1	页码。取值范围 1~1000，默认值为 1。
PageSize	Integer	否	10	每页记录数。取值范围 1~1000，默认值为 10。
TagFilters	Array of TagFilterObject	否	[ { "Key":"key1", "Value":"value1" } ]	任务标签信息。说明在设置此参数时，将返回指定任务下指定标签的标签信息。在不设置此参数时，则默认返回指定任务下的所有标签信息。

TagFilterObject

参数	类型	是否必选	示例值	描述
Key	String	是	key1	用于查询筛选的标签键。如需使用标签对实例进行查询筛选，该参数必填。允许传入重复的标签键。单次最多支持同时传入 10 个标签进行查询筛选。
Value	String	否	value1	用于查询筛选的标签键所对应的标签值。若该参数留空，表示不对标签值作限制，会筛选所有绑定了指定标签键的实例。若传入空字符串，表示筛选对应标签键下，标签值为空的实例。

返回参数

参数	类型	示例值	描述
Total	Integer	1	标签的数量。
ResourceTags	Array of ResourceTag	[ { "Key":"key1", "TaskId":"18064de5e9d345dc965ee45217******", "Value":"value1" } ]	任务标签列表信息。

ResourceTag

参数	类型	示例值	描述
TaskId	String	18064de5e9d345dc965ee45217******	绑定了由 key、value 指定的标签的任务的任务 ID。
Key	String	key1	任务所绑定标签的标签 key。
Value	String	value1	任务所绑定标签的标签 value。

示例

请求示例

返回示例

错误码

更多详情，请参见错误码。

最近更新时间：2026.02.03 14:24:30

这个页面对您有帮助吗？

有用

有用

无用

无用