首页 VPN网关 开发参考 API参考 API目录 标签 TagResources - 为指定的资源统一创建并绑定标签

TagResources - 为指定的资源统一创建并绑定标签

更新时间: 2023-12-02 19:52:13

为指定的资源统一创建并绑定标签。

接口说明

使用说明

标签是您为实例分配的标记,每个标签都由一对键值对(Key-Value)组成。标签的使用说明如下:

  • 一个实例上的每条标签的标签键(Key)必须唯一。

  • 不支持未绑定实例的空标签存在,标签必须绑定在实例上。

  • 不同地域下的标签信息不互通。

    例如在华东1(杭州)地域创建的标签在华东2(上海)地域不可见。

  • 同账号同地域下,专有网络、路由表、交换机和弹性公网IP的标签信息互通。

    例如在同账号同地域下,专有网络绑定了某个标签,那么您可以在交换机、路由表或弹性公网IP的编辑标签页面,直接选择将该标签绑定到实例上,而无需手动输入标签的键值信息。您可以修改标签的键和值,也可以随时删除实例的标签。如果删除实例,绑定实例的所有标签也会被删除。

  • 单个实例最多可绑定20条标签。绑定标签前,阿里云会校验资源已有标签数量。超过限制值后返回报错信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:TagResourcesWrite
  • BandwidthPackage
    acs:vpc:{#regionId}:{#accountId}:combandwidthpackage/{#BandwidthPackageId}
  • Address
    acs:vpc:{#regionId}:{#accountId}:eip/{#AllocationId}
  • NatGateway
    acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}
  • RouteTable
    acs:vpc:{#regionId}:{#accountId}:routetable/{#RouteTableId}
  • VPC
    acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}
  • VpnGateway
    acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId}
  • VSwitch
    acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}
  • vpc:tag

请求参数

名称类型必填描述示例值
ResourceTypestring

资源类型,取值:

  • VPC:专有网络实例。

  • VSWITCH:交换机实例。

  • ROUTETABLE:路由表实例。

  • EIP:弹性公网IP实例。

  • VpnGateWay:VPN网关实例。

  • NATGATEWAY:NAT网关实例。

  • COMMONBANDWIDTHPACKAGE:共享带宽实例。

VPC
ResourceIdarray

资源ID,最多支持输入20个资源ID。

string

资源ID。最多支持输入20个资源ID。

说明 调用该API时,ResourceId.N参数必须输入。
vpc-bp16qjewdsunr41m1****
RegionIdstring

要创建并绑定标签的资源所在的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

cn-hangzhou
Tagobject []

标签信息。

TagResources
Keystring

资源的标签键。至少输入1个标签键,最多支持输入20个标签键。一旦传入该值,则不允许为空字符串。

一个标签键最多支持64个字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-),不能以aliyunacs:开头,不能包含http://或者https://

说明 调用该API时,Tag.N.Key参数必须输入。
FinanceDept
Valuestring

资源的标签值。至少输入1个标签值,最多支持输入20个标签值。一旦传入该值,可以为空字符串。

一个标签值最多支持128个字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-),不能以aliyunacs:开头,不能包含http://或者https://

说明 调用该API时,Tag.N.Value参数必须输入。
FinanceJoshua

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID。

C46FF5A8-C5F0-4024-8262-B16B639225A0

示例

正常返回示例

JSON格式

{
  "RequestId": "C46FF5A8-C5F0-4024-8262-B16B639225A0"
}

错误码

HTTP status code错误码错误信息描述
400InvalidTagKeyThe tag keys are not valid.无效的标签索引
400InvalidTagValueThe tag values are not valid.无效的标签值
400MissingParam%s-
400InvalidInstanceType.NotFoundThe instance type is not found实例类型没有找到
400InvalidInstanceIds.NotFoundThe instanceIds are not found实例ID没有找到
400Forbidden.TagKeysThe request do not allow to operate the tag keys没有权限操作TagKeys
400QuotaExceeded.TagNumCustom Tags quota exceededquota超限
400InvalidTagScope.NotFoundThe tag scope is not found无效的资源范围
400Forbidden.NotAllowedCategaryThe System tag is not valid系统tag无效
400Forbidden.TagKeysThe request does not allow operate this tagkeys该请求不允许操作此 tagkey
400Forbidden.TagKey.DuplicatedThe specified tag key already exists.标签资源重复
400SizeLimitExceeded.TagNumThe maximum number of tags is exceeded.标签数量超限
400SizeLimitExceeded.ResourceIdThe maximum number of resource IDs is exceeded.资源组ID数目超限
400MissingParameter.TagValueThe input parameter TagValue that is mandatory for processing this request is not supplied.缺少参数TagValue
400MissingParameter.TagKeyThe input parameter TagKey that is mandatory for processing this request is not supplied.缺少参数TagKey
400MissingParam.TagsYou must specify the Tags parameter.Tags参数缺失
403ForbiddenUser not authorized to operate on the specified resource.您没有权限操作指定资源,请申请权限后再操作。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-07-28OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
2023-04-06OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
2023-03-23OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
阿里云首页 VPN网关 相关技术圈