TagResources--中转路由器-火山引擎

文档中心

立即注册

导航

TagResources

最近更新时间：2024.09.10 10:14:49首次发布时间：2023.11.10 10:02:49

调用TagResources接口，为资源添加用户标签。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

使用说明

为同一个资源重复添加相同标签键的标签，则后面的标签值会自动覆盖前面的。
每个资源最多可添加50个用户标签，每次调用该接口最多可添加20个用户标签。

请求参数

下表中，Tags.N.a类型参数中的“N”表示标签信息的序号，需按照数字顺序从1开始填写，取值范围为1～50。多个标签之间使用&分隔。每个标签键对应一个标签值。

名称	类型	是否必选	示例值	描述
Action	String	是	TagResources	要执行的操作，取值为TagResources。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
ResourceType	String	是	transitrouter	资源的类型，取值如下： transitrouter：中转路由器实例。 transitrouterroutetable：TR路由表。 transitrouterattachment：实例连接，包括VPC、VPN、专线网关类型网络实例连接和跨地域连接。 transitrouterbandwidthpackage：中转路由器带宽包。
ResourceIds.N	String	是	ResourceIds.1=tr-273sdsdsxxxxxp8u2j**&ResourceIds.2=tr-2fe6fszjgeznk5oxruv0u**	资源的ID。 N：表示资源 ID的序号，取值范围 1～50。多个资源 ID之间使用&分隔。说明您可以调用DescribeTransitRouters接口获取“transitrouter”类型资源的ID。您可以调用DescribeTransitRouterRouteTables接口获取“transitrouterroutetable”类型资源的D。您可以根据待添加标签资源的类型，分别调用DescribeTransitRouterVpcAttachments、DescribeTransitRouterVpnAttachments、DescribeTransitRouterDirectConnectGatewayAttachments或DescribeTransitRouterPeerAttachments接口获取“transitrouterattachment”类型资源的ID。您可以调用DescribeTransitRouterBandwidthPackages接口获取“transitrouterbandwidthpackage”类型资源的ID。
Tags.N.Key	String	是	Tags.1.Key=k1&Tags.2.Key=k2	用户标签的标签键。长度限制为1～128个字符。大小写敏感，不能以`volc:`或`sys:`的任意大小写组合开头。不能以空格开头或结尾。允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。说明同一资源的标签键不允许重复。如果传入的`Tags.N.Key`与已有标签的标签键重复，则后添加的标签会覆盖原有标签。不传入该参数或该参数不传入数值时，默认为空。
Tags.N.Value	String	否	Tags.1.Value=v1&Tags.2.Value=v2	用户标签的标签值。长度限制为1～256个字符。大小写敏感，不能以空格开头或结尾。允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。说明如果传入该参数，则必须先传入`Tags.N.Key`。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

GET /?Action=TagResources&Version=2020-04-01&ResourceType=transitrouter&ResourceIds.1=tr-273sdsdsxxxxxp8u2j****&ResourceIds.2=tr-2fe6fszjgeznk5oxruv0u****&Tags.1.Key=k1&Tags.2.Key=k2&Tags.1.Value=v1&Tags.2.Value=v2 HTTP/1.1
Host: open.volcengineapi.com
ServiceName: transitrouter
Region: cn-guangzhou

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "TagResources",
        "Version": "2020-04-01",
        "Service": "transitrouter",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "RequestId": "2021062415303301022514515207C4****"
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode	错误码	错误信息	描述
400	InvalidResourceType.Malformed	The specified parameter resource type is invalid.	资源类型不合法。
400	InvalidTag.Disorder	The specified index order of tag is malformed.	指定标签的索引顺序参数格式不合法。
400	InvalidTagKey.Malformed	The specified parameter tag key is invalid.	标签键不合法。
400	InvalidTagValue.Malformed	The specified parameter tag value is invalid.	标签值不合法。
400	LimitExceeded.Resource	You've reached the limit on the number of resources that you can operate at a time.	已达到单次可操作资源数量的上限。
400	LimitExceeded.Tags	You've reached the limit on the number of tags that you can operate at a time.	已达到单次可操作标签数量的上限。
400	QuotaExceeded.ResourceSystemTags	You've reached the limit on the number of system tags that you can create.	已达到单个资源可创建系统标签的数量的配额上限。
400	QuotaExceeded.ResourceTags	You've reached the limit on the number of resource tags that you can create.	已达到单个资源可创建用户标签的数量的配额上限。
404	InvalidResource.NotFound	The specified resource does not exist.	指定的资源不存在。