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

调试

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

请求参数

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

系统规定参数。取值:DescribeTagKeys。

说明 可以根据category来查询系统标签或者用户标签,但是只能查询可见标签。
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

标签类型,取值:

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

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

返回数据

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

标签类型。

PageNumber Integer 1

标签的起始页。

PageSize Integer 20

每页返回标签的数量。

RequestId String AD110813-9AD6-5F07-BFC8-4C841309****

请求ID。

TagKeys List ["a","x"]

标签键。

TotalCount Integer 13

标签键总数。

示例

请求示例

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

正常返回示例

XML格式

<DescribeTagKeysResponse>
      <pageNumber>1</pageNumber>
      <tagKeys>a</tagKeys>
      <tagKeys>x</tagKeys>
      <totalRecordCount>13</totalRecordCount>
      <pageRecordCount>10</pageRecordCount>
      <requestId>AD110813-9AD6-5F07-BFC8-4C841309****</requestId>
      <success>true</success>
      <httpStatusCode>200</httpStatusCode>
</DescribeTagKeysResponse>

JSON格式

{
    "pageNumber": 1,
    "tagKeys": [
        "a",
        "x"
    ],
    "totalRecordCount": 13,
    "pageRecordCount": 10,
    "requestId": "AD110813-9AD6-5F07-BFC8-4C841309****",
    "success": true,
    "httpStatusCode": 200
}

错误码

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。

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