全部產品
Search
文件中心

Data Transmission Service:建立標籤

更新時間:Feb 08, 2025

調用TagResources介面為一個或多個遷移、同步和訂閱執行個體綁定標籤。

在執行個體數量較多的情況下,您可以建立多個標籤,為執行個體綁定不同的標籤對其進行分類,之後通過標籤進行執行個體篩選。

  • 標籤由一對鍵(key)值(value)組成,鍵在同帳號同地區下唯一,值無此限制。
  • 若設定的標籤不存在,則自動建立該標籤並綁定到目標執行個體。
  • 若執行個體已經綁定了有相同鍵的標籤,則進行覆蓋綁定。
  • 每個執行個體最多可以綁定20個標籤。
  • 每次調用最多設定50個執行個體進行批量標籤綁定。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱 類型 是否必選 樣本值 描述
Action String TagResources

系統規定參數。取值:TagResources

RegionId String cn-hangzhou

地區ID,傳入本參數來指定執行個體所在地區,詳情請參見支援的地區列表

ResourceType String ALIYUN::DTS::INSTANCE

資源類型定義,固定取值為:ALIYUN::DTS::INSTANCE

ResourceId.N String dtsntk10k6r12v****

資料移轉、同步和訂閱的執行個體ID,可以通過調用DescribeDtsJobs介面查詢。

說明 N表示傳入第幾個執行個體ID。例如ResourceId.0表示傳入第一個執行個體ID;ResourceId.1表示傳入第二個執行個體ID。
Tag.N.Key String testkey1

標籤的鍵。

說明
  • N表示傳入第幾個標籤的鍵。例如Tag.0.Key表示傳入第一個標籤的鍵;Tag.1.Key表示傳入第二個標籤的鍵。
  • 不允許傳入Null 字元串。
Tag.N.Value String testvalue1

標籤的值。

說明
  • N表示傳入第幾個標籤的值。例如Tag.0.Value表示傳入第一個標籤的值;Tag.1.Value表示傳入第二個標籤的值。
  • 允許傳入Null 字元串。

返回資料

名稱 類型 樣本值 描述
RequestId String 755D7B84-6813-42B0-BC9D-2699CFEA****

請求ID。

ErrCode String InternalError

調用出錯時返回的錯誤碼。

Success Boolean true

請求是否成功。

ErrMessage String The request processing has failed due to some unknown error.

調用錯誤時返回對應的錯誤資訊。

樣本

請求樣本

http(s)://dts.aliyuncs.com/?Action=TagResources
&RegionId=cn-hangzhou	
&ResourceId.1=dtsntk10k6r12v****
&ResourceType=ALIYUN::DTS::INSTANCE
&Tag.1.Key=testkey1
&Tag.1.Value=testvalue1
&<公用請求參數>

正常返回樣本

XML格式

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

<TagResourcesResponse>
    <RequestId>755D7B84-6813-42B0-BC9D-2699CFEA****</RequestId>
    <Success>true</Success>
</TagResourcesResponse>

JSON格式

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

{
  "RequestId" : "755D7B84-6813-42B0-BC9D-2699CFEA****",
  "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. 由於服務端響應逾時或者不可用導致請求失敗,請重試,重試後仍失敗請聯絡支援人員。

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