You need to enable JavaScript to run this app.
导航
数据库传输服务
  • 文档首页
    • /
  • 数据库传输服务

DescribeTagsByResource

最近更新时间：2024.01.16 17:59:29

首次发布时间：2023.04.20 20:12:27

我的收藏

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

请求类型

同步请求。

请求参数

参数类型是否必选示例值描述
TaskIdsArray of String是[ "18064de5e9d345dc965ee45217******" ]任务 ID 列表信息。支持一次传入多个任务 ID，最多同时传入 20 个任务 ID。
PageNumberInteger否1页码。取值范围大于等于 1，默认值为 1。
PageSizeInteger否10每页记录数。取值范围大于等于 1，默认值为 10。

TagFilters

Array of TagFilter

否

[
    {
        "Key":"key1",
        "Value":"value1"
    }
]

任务标签信息。详细信息，请参见 TagFilter。

说明

  • 在设置此参数时，将返回指定任务下指定标签的标签信息。

  • 在不设置此参数时，则默认返回指定任务下的所有标签信息。

返回参数

参数类型示例值描述
TotalInteger1标签的数量。

ResourceTags

Array of ResourceTag

[
    {
        "Key":"key1",
        "TaskId":"18064de5e9d345dc965ee45217******",
        "Value":"value1"
    }
]

任务标签列表信息。详细信息，请参见 ResourceTag。

请求示例

POST https://dts.volcengineapi.com/?Action=DescribeTagsByResource&Version=2018-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: dts.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AKLTYmYwNjAzYjFmMjRkNDQwZWI4MzI1MzhjZGYyM2YxYmY/20210328/cn-north-1/dts/request, SignedHeaders=x-date, Signature=e1d274292f8b36eb096e1d2fec02822bd2e5cb3435699938adb7341861214e49

{
    "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
    }
}

错误码

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