調用DescribeTagKeys尋找DTS執行個體的標籤鍵-Data Transmission Service-阿里雲

調試

您可以在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.	由於服務端響應逾時或者不可用導致請求失敗，請重試，重試後仍失敗請聯絡支援人員。

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