添加或者覆蓋一個或者多個標籤到Elastic Compute Service 的各項資源上。您可以添加標籤到實例、磁碟、快照、鏡像、安全性群組等,便於管理資源。

描述

調用該介面時,您需要注意:
  • 單項Elastic Compute Service 資源最多可以添加 10 個標籤。
  • 標籤鍵(Tag.n.Key)與標籤值(Tag.n.Value) 必須鍵值匹配。

  • 如果標籤鍵(Tag.n.Key)在指定的資源上已經存在,則使用新的標籤值(Tag.n.Value)自動覆蓋原標籤值。

請求參數

名稱 類型 是否必需 描述
Action String 系統規定參數。取值:AddTags
RegionId String 資源所在的地域。您可以調用 DescribeRegions 查看最新的阿里雲地域列表。
ResourceType String 資源類型。取值範圍:
  • disk
  • instance
  • image
  • securitygroup
  • snapshot
以上取值均為小寫。
ResourceId String 要綁定標籤的資源 ID。例如,當資源類型(ResourceType)為實例(instance)時,資源 ID 可以理解為實例 ID。
Tag.n.Key String 標籤鍵,n 的取值範圍為 [1, 5]。最多支援 64 個字元。不支援 aliyun、acs:、http:// 和 https:// 開頭。不允許為Null 字元串。
Tag.n.Value String 標籤值,n 的取值範圍為 [1, 5]。最多支援 128 個字元。不支援 aliyun、http:// 和 https:// 開頭。允許為Null 字元串。

返回參數

全是公共返回參數。參閱 公共參數

樣本

請求樣本
https://ecs.aliyuncs.com/?Action=AddTags
&ResourceId=s-946ntx4wr
&ResourceType=snapshot
&RegionId=cn-shenzhen
&Tag.1.Key=test
&Tag.1.Value=api
&<公共請求參數>
返回樣本

XML 格式

<AddTagsResponse>
    <RequestId>C46FF5A8-C5F0-4024-8262-B16B639225A0</RequestId>
</AddTagsResponse>
JSON 格式
{
  "RequestId": "C46FF5A8-C5F0-4024-8262-B16B639225A0"
}

錯誤碼

以下為本介面特有的錯誤碼。更多錯誤碼,請訪問 API 錯誤中心

錯誤碼 錯誤資訊 HTTP 狀態碼 說明
InvalidTag.Mismatch The specified Tag.n.Key and Tag.n.Value are not match. 400 標籤鍵(Tag.n.Key)與標籤值(Tag.n.Value) 必須鍵值匹配。
InvalidTagCount The specified tags are beyond the permitted range. 400 指定的標籤數不能超過五個。
InvalidTagKey.Malformed The specified Tag.n.Key is not valid. 400 指定的 Tag.n.Key 不合法。
InvalidTagValue.Malformed The specified Tag.n.Value is not valid. 400 指定的 Tag.n.Value不合法。
OperationDenied.QuotaExceed The quota of tags on resource is beyond permitted range. 400 單項Elastic Compute Service 資源最多可以綁定 10 個標籤。
InvalidResourceId.NotSupported The specified ResourceId does not support tagging. 403 指定的資源不支援標籤功能。
InvalidRegionId.NotFound The RegionId provided does not exist in our records. 404 指定的 RegionId 不存在。
InvalidResourceId.NotFound The specified ResourceId is not found in our records. 404 指定的 ResourceId 不存在。
InvalidResourceType.NotFound The ResourceType provided does not exist in our records. 404 指定的 ResourceType不存在。