DescribeTagsByResource--数据库传输服务-火山引擎

文档中心

立即注册

导航

数据库传输服务

DescribeTagsByResource

最近更新时间：2024.09.09 14:38:57首次发布时间：2023.04.20 20:12:27

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

请求类型

同步请求。

请求参数

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

返回参数

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

示例

请求示例

POST /?Action=DescribeTagsByResource&Version=2022-10-01 HTTP/1.1
Content-Type: application/json
Host: dts.volcengineapi.com
X-Date: 20221001T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20221001/cn-beijing/dts/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****
{
    "TaskIds": ["18064de5e9d345dc965ee45217******"],
    "TagFilters": [
    {
      "Key": "key1",
      "Value": "value1"
    }
  ],
    "PageNumber":1,
    "PageSize":10
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023041416325819C8523905F879303A46",
        "Action": "DescribeTagsByResource",
        "Version": "2022-10-01",
        "Service": "dts",
        "Region": "cn-shanghai"
    },
    "Result": {
        "ResourceTags": [
            {
                "Key": "key1",
                "TaskId": "18064de5e9d345dc965ee45217******",
                "Value": "value1"
            }
        ],
        "Total": 1
    }
}

错误码

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