查询标签 - 数据传输服务 DTS

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	ListTagResources	系统规定参数。取值：ListTagResources。
RegionId	String	是	cn-hangzhou	地域ID，传入本参数来指定实例所在地域，详情请参见支持的地域列表。
ResourceType	String	是	ALIYUN::DTS::INSTANCE	资源类型定义，取值固定为：ALIYUN::DTS::INSTANCE。
NextToken	String	否	212db86sca4384811e0b5e8707ec2****	查询凭证。说明如果一次查询没有返回全部结果，则可在后续查询中传入上一次查询返回的NextToken参数继续查询。
ResourceId.N	String	否	dtsntk10k6r12v****	数据迁移、同步和订阅的实例ID，可以通过调用DescribeDtsJobs。说明 N表示传入第几个实例ID。例如：ResourceId.0表示传入第一个实例ID；ResourceId.1表示传入第二个实例ID。可以同时查询1~50个实例ID。该参数和Tag.N.Key参数至少传入一个。
Tag.N.Key	String	否	testkey1	标签键。说明 N表示传入第几个标签的键。例如：Tag.0.Key表示传入第一个标签的键；Tag.1.Key表示传入第二个标签的键。可以同时查询1~20个标签键。该参数和ResourceId.N参数至少传入一个，且传入时不允许传入空字符串。
Tag.N.Value	String	否	testvalue1	标签的值。说明 N表示传入第几个标签的值。例如：Tag.0.Value表示传入第一个标签的值；Tag.1.Value表示传入第二个标签的值。可以同时查询1~20个标签值。允许传入空字符串。

返回数据


名称	类型	示例值	描述
NextToken	String	212db86sca4384811e0b5e8707ec2****	查询凭证。说明如果此次查询没有返回全部结果，则可在后续查询中传入此NextToken参数继续查询。
RequestId	String	609AD332-F2B1-48B7-BF43-41FEE641****	请求ID。
ErrCode	String	InternalError	调用出错时返回的错误码。
Success	Boolean	true	请求是否成功。
ErrMessage	String	The request processing has failed due to some unknown error.	调用错误时返回对应的错误信息。
TagResources	Array of TagResource		返回标签集合。
TagResource
TagValue	String	testvalue1	标签键对应的标签值。
ResourceType	String	ALIYUN::DTS::INSTANCE	资源类型定义，取值固定为ALIYUN::DTS::INSTANCE。
ResourceId	String	dtsntk10k6r12v****	实例ID。
TagKey	String	testkey1	标签键。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=ListTagResources
&RegionId=cn-hangzhou	
&ResourceType=ALIYUN::DTS::INSTANCE
&ResourceId.1=dtsntk10k6r12v****
&Tag.1.Key=testkey1
&Tag.1.Value=testvalue1
&<公共请求参数>

正常返回示例

XML格式

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

<ListTagResourcesResponse>
    <RequestId>609AD332-F2B1-48B7-BF43-41FEE641****</RequestId>
    <TagResources>
        <ResourceId>dtsntk10k6r12v****</ResourceId>
        <TagKey>testkey1</TagKey>
        <ResourceType>ALIYUN::DTS::INSTANCE</ResourceType>
        <TagValue>testvalue1</TagValue>
    </TagResources>
    <Success>true</Success>
</ListTagResourcesResponse>

JSON格式

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

{
  "RequestId" : "609AD332-F2B1-48B7-BF43-41FEE641****",
  "TagResources" : [ {
    "ResourceId" : "dtsntk10k6r12v****",
    "TagKey" : "testkey1",
    "ResourceType" : "ALIYUN::DTS::INSTANCE",
    "TagValue" : "testvalue1"
  } ],
  "Success" : true
}

错误码


HttpCode	错误码	错误信息	描述
419	QuotaExceed.TagsPerResource	The maximum number of tags for each resource is exceeded.	已超过标签数量上限，请先删除不需要的标签。
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.	由于服务端响应超时或者不可用导致请求失败，请重试，重试后仍失败请联系技术支持。

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