調用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表示傳入第二個標簽的鍵。
  • 不允許傳入空字符串。
Tag.N.Value String testvalue1

標簽的值。

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

返回數據

名稱 類型 示例值 描述
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. 由于服務端響應超時或者不可用導致請求失敗,請重試,重試后仍失敗請聯系技術支持。

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