新增或覆蓋一個或多個標籤到雲端伺服器ECS的各項資源上。您可以新增標籤到執行個體、磁碟、快照、映像、安全性群組等,便於管理資源。
目前該API介面已標記為棄用,推薦使用替代API:Ecs(2014-05-26) - TagResources。
介面說明
呼叫該介面時,您需要注意:
單項雲端伺服器 ECS 資源最多可以新增 20 個標籤。
標籤鍵(
Tag.N.Key)與標籤值(Tag.N.Value)必須鍵值匹配。如果標籤鍵(
Tag.N.Key)在指定的資源上已經存在,則使用新的標籤值(Tag.N.Value)自動覆蓋原標籤值。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ecs:AddTags |
create |
*All Resource
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
是 |
資源所在的地域。您可以呼叫 DescribeRegions 查看最新的阿里雲地域列表。 |
cn-hangzhou |
| ResourceType |
string |
是 |
資源類型定義。取值範圍:
以上取值均為小寫。 |
instance |
| ResourceId |
string |
是 |
要繫結標籤的資源 ID。例如,當資源類型(ResourceType)為執行個體(instance)時,資源 ID 可以理解為執行個體 ID。 |
i-bp1gtjxuuvwj17zr**** |
| Tag |
array<object> |
是 |
標籤列表。 |
|
|
object |
否 |
|||
| key |
string |
否 |
資源的標籤鍵。 說明
為提高相容性,建議您盡量使用 Tag.N.Key 參數。 |
test |
| Key |
string |
否 |
資源的標籤鍵。N 的取值範圍:1~20。一旦傳入該值,則不允許為空字串。最多支援 128 個字元,不能以 aliyun 和 acs:開頭,不能包含 http://或者 https:// 。 |
TestKey |
| Value |
string |
否 |
資源的標籤值。N 的取值範圍:1~20。一旦傳入該值,可以為空字串。最多支援 128 個字元,不能以 aliyun 和 acs:開頭,不能包含 http://或者 https:// 。 |
TestValue |
| value |
string |
否 |
資源的標籤值。 說明
為提高相容性,建議您盡量使用 Tag.N.Value 參數。 |
test |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
樣本
正常返回樣本
JSON格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidTagKey.Malformed | The specified Tag.n.Key is not valid. | |
| 400 | InvalidTagValue.Malformed | The specified Tag.n.Value is not valid. | |
| 400 | OperationDenied.QuotaExceed | The quota of tags on resource is beyond permitted range. | |
| 400 | InvalidTag.Mismatch | The specified Tag.n.Key and Tag.n.Value are not match. | |
| 400 | InvalidTagCount | The specified tags are beyond the permitted range. | |
| 400 | Duplicate.TagKey | The Tag.N.Key contain duplicate key. | |
| 403 | InvalidResourceId.NotSupported | The specified ResourceId does not support tagging. | |
| 403 | QuotaExceed.Tags | %s | |
| 403 | TagKey.Duplication | The TagKey has duplication with others, case-insensitive. | |
| 404 | InvalidRegionId.NotFound | The specified RegionId does not exist. | |
| 404 | InvalidResourceId.NotFound | The specified ResourceId is not found in our records. | |
| 404 | InvalidResourceType.NotFound | The ResourceType provided does not exist in our records. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。