查詢標籤 - Data Transmission Service

調試

您可以在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參數至少傳入一個，且傳入時不允許傳入Null 字元串。
Tag.N.Value	String	否	testvalue1	標籤的值。說明 N表示傳入第幾個標籤的值。例如：Tag.0.Value表示傳入第一個標籤的值；Tag.1.Value表示傳入第二個標籤的值。可以同時查詢1~20個標籤值。允許傳入Null 字元串。

返回資料

名稱	類型	樣本值	描述
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.	由於服務端響應逾時或者不可用導致請求失敗，請重試，重試後仍失敗請聯絡支援人員。

訪問錯誤中心查看更多錯誤碼。