添加或者覆盖一个或者多个标签到云服务器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 |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| 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. | 指定的 Tag.N.Key 和 Tag.N.Value 不匹配。 |
| 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 | 标签数超过可以配置的最大数量。%s为变量,将根据调用API的实际情况动态返回错误信息。 |
| 403 | TagKey.Duplication | The TagKey has duplication with others, case-insensitive. | 指定的 Tag.N.Key 参数中存在重复的取值。该参数的取值不区分大小写,请检查是否传入了重复的参数值。 |
| 404 | InvalidRegionId.NotFound | The specified RegionId does not exist. | 指定的地域 ID 不存在。 |
| 404 | InvalidResourceId.NotFound | The specified ResourceId is not found in our records. | 指定的资源不存在,请您检查该资源是否正确。 |
| 404 | InvalidResourceType.NotFound | The ResourceType provided does not exist in our records. | 指定的资源类型不存在。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。