TagResources--私有网络-火山引擎

文档中心

立即注册

导航

TagResources

最近更新时间：2024.11.15 09:39:38首次发布时间：2022.09.02 08:52:39

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

调用说明

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

调试

API Explorer

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

去调试

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	TagResources	要执行的操作，取值为TagResources。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
ResourceType	String	是	vpc	资源的类型，取值如下： vpc：私有网络。 subnet：子网。 eni：网卡。 securitygroup：安全组。 havip：高可用虚拟IP。 routetable：路由表。 networkacl：网络ACL。 flowlog：流日志。 trafficmirrortarget ：流量镜像的镜像目的。 trafficmirrorfilter：流量镜像的筛选条件。 trafficmirrorsession：流量镜像的镜像会话。 eip：公网IP。 bandwidthpackage：共享带宽包。 ngw：NAT网关。 vpngateway：VPN网关。 directconnectconnection：物理专线。 directconnectgateway：专线网关。 directconnectvirtualinterface：虚拟接口。
ResourceIds.N	String	是	ResourceIds.1=vpc-273w3e33y2y9s7fap8u2j**&ResourceIds.2=vpc-bp15zckdt37pq72zv**	资源的ID。参数 - N：表示资源 ID的序号，单次调用数量上限50个。多个资源 ID之间使用&分隔。
Tags.N.Key	String	是	Tags.1.Key=k1&Tags.2.Key=k2	用户标签的标签键（Key）。参数 - N：表示标签键（Key）的序号，取值范围：1～20。多个标签键（Key）之间用&分隔。不能以 `volc:`或`sys`开头，包括任意大小写形式。长度取值范围为1~128字符，允许输入各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。若标签键开头或结尾存在空格，系统会自动为其去除。说明同一资源的标签键不允许重复。
Tags.N.Value	String	否	Tags.1.Value=v1&Tags.2.Value=v2	用户标签的标签值（Value）。参数 - N：表示标签值（Value）的序号，取值范围：1～20。多个标签值（Value）之间用&分隔。长度取值范围为0～256字符，不填默认为空。允许输入各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。大小写敏感。若标签值（Value）开头或结尾存在空格，系统会自动为其去除。说明如果传入该参数，则必须先传入`Tags.N.Key`。

返回数据

参数名称	类型	示例值	描述
RequestId	String	2021062415303301022514515207C4****	请求ID。

请求示例

GET /?Action=TagResources&Version=2020-04-01&ResourceType=vpc&ResourceIds.1=vpc-273w3e33y2y9s7fap8u2j****&ResourceIds.2=vpc-bp15zckdt37pq72zv****&Tags.1.Key=k1&Tags.2.Key=k2&Tags.1.Value=v1&Tags.2.Value=v2 HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing

返回示例

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

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

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