调用DescribeTagKeys接口查找一个迁移、同步或订阅实例绑定的所有标签。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeTagKeys

系统规定参数。取值：DescribeTagKeys。
PageSize Integer 否 20

当标签值过多时，选择一次返回的个数，默认为20。
PageNumber Integer 否 1

页码，取值为大于0且不超过Integer数据类型的最大值，通常与PageSize搭配使用，默认值为1。
ResourceType String 否 ALIYUN::DTS::INSTANCE

系统服务规定参数，固定取值为：ALIYUN::DTS::INSTANCE。
ResourceId String 否 dtsl5o11f9029c****

数据迁移、同步或订阅的实例ID，可以通过调用DescribeDtsJobs接口查询。
Category String 否 Custom

标签类型，取值：

  • System：系统创建的标签。
  • Custom：用户添加的标签。
说明 当值为空时，默认返回可公示的标签。
RegionId String 否 cn-hangzhou

DTS实例所属的地域，详情请参见支持的地域列表。

返回数据

名称 类型 示例值 描述
Category String Custom

标签类型。
RequestId String AD110813-9AD6-5F07-BFC8-4C841309****

请求ID。
PageSize Integer 10

每页返回标签的数量。
PageNumber Integer 1

标签的起始页。
TotalCount Integer 10

标签键总数。
TagKeys Array of String ["a","x"]

标签键。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=DescribeTagKeys
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeTagKeysResponse>
    <TotalCount>10</TotalCount>
    <Category>Custom</Category>
    <RequestId>AD110813-9AD6-5F07-BFC8-4C841309****</RequestId>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <TagKeys>a</TagKeys>
    <TagKeys>x</TagKeys>
</DescribeTagKeysResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 10,
  "Category" : "Custom",
  "RequestId" : "AD110813-9AD6-5F07-BFC8-4C841309****",
  "PageSize" : 10,
  "PageNumber" : 1,
  "TagKeys" : [ "a", "x" ]
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidParameter.Category The specified Category is invalid. Valid values are Custom and System. 标签类型非法，合法值为Custom，System。
400 InvalidParameter.ResourceType The ResourceType parameter is invalid. 参数ResourceType无效，请输入固定值ALIYUN::DTS::INSTANCE。
400 Throttling.User Request was denied due to user flow control. 由于请求频次达到阈值，请求被拒绝，请稍后重试。
403 InvalidSecurityToken.Expired Specified SecurityToken is expired. 签名已经过期，请更新签名
500 ServiceUnavailable The request has failed due to a temporary failure of the server. 由于服务端响应超时或者不可用导致请求失败，请重试，重试后仍失败请联系技术支持。

访问错误中心查看更多错误码。