添加或者覆盖一个或者多个标签到云服务器ECS的各项资源上。您可以添加标签到实例、磁盘、快照、镜像、安全组等,便于管理资源。
接口说明
调用该接口时,您需要注意:
- 单项云服务器ECS资源最多可以添加20个标签。
- 标签键(
Tag.N.Key
)与标签值(Tag.N.Value
)必须键值匹配。 - 如果标签键(
Tag.N.Key
)在指定的资源上已经存在,则使用新的标签值(Tag.N.Value
)自动覆盖原标签值。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | AddTags | 系统规定参数。取值:AddTags |
RegionId | String | 是 | cn-hangzhou | 资源所在的地域。您可以调用DescribeRegions查看最新的阿里云地域列表。 |
ResourceType | String | 是 | instance | 资源类型。取值范围:
以上取值均为小写。 |
ResourceId | String | 是 | i-bp1gtjxuuvwj17zr**** | 要绑定标签的资源ID。例如,当资源类型(ResourceType)为实例(instance)时,资源ID可以理解为实例ID。 |
Tag.N.value | String | 否 | test | 资源的标签值。
说明 为提高兼容性,建议您尽量使用Tag.N.Value参数。
|
Tag.N.key | String | 否 | test | 资源的标签键。
说明 为提高兼容性,建议您尽量使用Tag.N.Key参数。
|
Tag.N.Key | String | 否 | TestKey | 资源的标签键。N的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持128个字符,不能以aliyun和acs:开头,不能包含http://或者https:// 。 |
Tag.N.Value | String | 否 | TestValue | 资源的标签值。N的取值范围:1~20。一旦传入该值,可以为空字符串。最多支持128个字符,不能以aliyun和acs:开头,不能包含http://或者https:// 。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E | 请求ID。 |
示例
请求示例
https://ecs.aliyuncs.com/?Action=AddTags &RegionId=cn-hangzhou &ResourceType=instance &ResourceId=i-bp1gtjxuuvwj17zr**** &Tag.1.Key=TestKey &Tag.1.Value=TestValue &<公共请求参数>
正常返回示例
XML
格式
<AddTagsResponse> <RequestId>C46FF5A8-C5F0-4024-8262-B16B639225A0</RequestId> </AddTagsResponse>
JSON
格式
{ "RequestId": "C46FF5A8-C5F0-4024-8262-B16B639225A0" }
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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. | 指定的资源类型不存在。 |
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. | 资源标签已达上限。 |
403 | InvalidResourceId.NotSupported | The specified ResourceId does not support tagging. | 指定的资源ID不支持标记。 |
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 | QuotaExceed.Tags | %s | 标签数超过可以配置的最大数量。 |
访问错误中心查看更多错误码。