调用TagResources接口为指定的VPC对等连接统一创建并绑定标签。
使用说明
标签是您为实例分配的标记,每个标签都由一对键值对(Key-Value)组成。标签的使用说明如下:
- 一个实例上的每条标签的标签键(Key)必须唯一。
- 不支持未绑定实例的空标签存在,标签必须绑定在实例上。
-
不同地域下的标签信息不互通。
例如在华东1(杭州)地域创建的标签在华东2(上海)地域不可见。
-
同账号同地域下,不同VPC对等连接的实例标签信息互通。
例如在同账号同地域下,VPC对等连接实例绑定了某个标签,那么您可以在其他VPC对等连接实例的编辑标签页面,直接选择将该标签绑定到实例上,而无需手动输入标签的键值信息。您可以修改标签的键和值,也可以随时删除实例的标签。如果删除实例,绑定实例的所有标签也会被删除。
- 单个实例最多可绑定20条标签。绑定标签前,阿里云会校验资源已有标签数量。超过限制值后返回报错信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | TagResources | 系统规定参数。取值:TagResources。 |
ResourceId.N | String | 否 | pcc-bp16qjewdsunr41m1**** | 资源ID,最多支持输入20个资源ID。 |
Tag.N.Key | String | 否 | FinanceDept | 资源的标签键。至少输入1个标签键,最多支持输入20个标签键。一旦传入该值,则不允许为空字符串。 一个标签键最多支持64个字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-),不能以 |
Tag.N.Value | String | 否 | FinanceJoshua | 资源的标签值。至少输入1个标签值,最多支持输入20个标签值。一旦传入该值,可以为空字符串。 一个标签值最多支持128个字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-),不能以 |
ResourceType | String | 是 | PeerConnection | 资源类型。取值:PeerConnection,表示VPC对等连接。 |
ClientToken | String | 否 | 123e4567-e89b-12d3-a456-426655440000 | 客户端Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。 说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。 |
RegionId | String | 是 | cn-hangzhou | 要创建并绑定标签的资源所在的地域ID。 您可以通过调用DescribeRegions接口获取地域ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | C46FF5A8-C5F0-4024-8262-B16B639225A0 | 请求ID。 |
Success | Boolean | true | 是否创建并绑定成功。取值:
|
示例
请求示例
http(s)://[Endpoint]/?Action=TagResources
&ResourceId=["pcc-bp16qjewdsunr41m1****"]
&Tag=[{"Key":"FinanceDept","Value":"FinanceJoshua"}]
&ResourceType=PeerConnection
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&RegionId=cn-hangzhou
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<TagResourcesResponse>
<RequestId>C46FF5A8-C5F0-4024-8262-B16B639225A0</RequestId>
<Success>true</Success>
</TagResourcesResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "C46FF5A8-C5F0-4024-8262-B16B639225A0",
"Success" : true
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | NumberExceed.Tags | The maximum number of tags is exceeded. | 标签数量超限 |
400 | NumberExceed.ResourceIds | The maximum number of resource IDs is exceeded. | 资源组ID数目超限 |
400 | Forbidden.TagKeys | The tag key cannot be operated by the request. | 该请求不允许操作此 tagkey |
400 | Forbidden.TagKey.Duplicated | The specified tag key already exists. | 标签资源重复 |
400 | InvalidInstanceIds.NotFound | The instance IDs are not found. | 实例ID没有找到 |
400 | InvalidInstanceType.NotFound | The instance type is not found. | 实例类型没有找到 |
访问错误中心查看更多错误码。