调用TagResources接口为指定的资源统一创建并绑定标签。
使用说明
标签是您为实例分配的标记,每个标签都由一对键值对(Key-Value)组成。标签的使用说明如下:
- 一个实例上的每条标签的标签键(Key)必须唯一。
- 不支持未绑定实例的空标签存在,标签必须绑定在实例上。
-
不同地域下的标签信息不互通。
例如在华东1(杭州)地域创建的标签在华东2(上海)地域不可见。
-
同账号同地域下,专有网络、路由表、交换机和弹性公网IP的标签信息互通。
例如在同账号同地域下,专有网络绑定了某个标签,那么您可以在交换机、路由表或弹性公网IP的编辑标签页面,直接选择将该标签绑定到实例上,而无需手动输入标签的键值信息。您可以修改标签的键和值,也可以随时删除实例的标签。如果删除实例,绑定实例的所有标签也会被删除。
- 单个实例最多可绑定20条标签。绑定标签前,阿里云会校验资源已有标签数量。超过限制值后返回报错信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| ResourceType | String | 是 | VPC | 资源类型,取值:
说明 输入的资源类型取值不区分大小写。 |
| ResourceId.N | String | 否 | vpc-bp16qjewdsunr41m1**** | 资源ID。最多支持输入50个资源ID。 说明 调用该API时,ResourceId.N参数必须输入。 |
| RegionId | String | 是 | cn-hangzhou | 要创建并绑定标签的资源所在的地域ID。 您可以通过调用DescribeRegions接口获取地域ID。 |
| Tag.N.Key | String | 否 | FinanceDept | 资源的标签键。至少输入1个标签键,最多支持输入20个标签键。 一个标签键最多支持128个字符,不能以 说明 调用该API时,必须输入Tag.N.Key参数,且不能是空字符串。 |
| Tag.N.Value | String | 否 | FinanceJoshua | 资源的标签值。至少输入1个标签值,最多支持输入20个标签值。 一个标签值最多支持128个字符,不能以 说明 调用该API时,必须输入Tag.N.Value参数,且可以是空字符串。 |
| Action | String | 是 | TagResources | 系统规定参数。取值:TagResources。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | C46FF5A8-C5F0-4024-8262-B16B639225A0 | 请求ID。 |
示例
请求示例
http(s)://[Endpoint]/?ResourceType=VPC
&ResourceId=["vpc-bp16qjewdsunr41m1****"]
&RegionId=cn-hangzhou
&Tag=[{"Key":"FinanceDept","Value":"FinanceJoshua"}]
&Action=TagResources
&公共请求参数
正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<TagResourcesResponse>
<RequestId>C46FF5A8-C5F0-4024-8262-B16B639225A0</RequestId>
</TagResourcesResponse>
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "C46FF5A8-C5F0-4024-8262-B16B639225A0"
}
错误码
| HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidTagKey | The tag keys are not valid. | 无效的标签索引 |
| 400 | InvalidTagValue | The tag values are not valid. | 无效的标签值 |
| 400 | InvalidInstanceType.NotFound | The instance type is not found | 实例类型没有找到 |
| 400 | InvalidInstanceIds.NotFound | The instanceIds are not found | 实例ID没有找到 |
| 400 | Forbidden.TagKeys | The request do not allow to operate the tag keys | 没有权限操作TagKeys |
| 400 | QuotaExceeded.TagNum | Custom Tags quota exceeded | quota超限 |
| 400 | InvalidTagScope.NotFound | The tag scope is not found | 无效的资源范围 |
| 400 | Forbidden.NotAllowedCategary | The System tag is not valid | 系统tag无效 |
| 400 | Forbidden.TagKeys | The request does not allow operate this tagkeys | 该请求不允许操作此 tagkey |
| 400 | Forbidden.TagKey.Duplicated | The specified tag key already exists. | 标签资源重复 |
| 400 | SizeLimitExceeded.TagNum | The maximum number of tags is exceeded. | 标签数量超限 |
| 400 | SizeLimitExceeded.ResourceId | The maximum number of resource IDs is exceeded. | 资源组ID数目超限 |
| 400 | MissingParameter.TagValue | The input parameter TagValue that is mandatory for processing this request is not supplied. | 缺少参数TagValue |
| 400 | MissingParameter.TagKey | The input parameter TagKey that is mandatory for processing this request is not supplied. | 缺少参数TagKey |
| 400 | MissingParam.Tags | You must specify the Tags parameter. | Tags参数缺失 |
| 403 | Forbidden | User not authorized to operate on the specified resource. | 您没有权限操作指定资源,请申请权限后再操作。 |
访问错误中心查看更多错误码。