TagResources--私网连接-火山引擎

文档中心

立即注册

导航

TagResources

最近更新时间：2024.09.09 10:34:39首次发布时间：2023.09.13 10:26:36

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

调用说明

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

调试

API Explorer

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

去调试

请求参数

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

名称	类型	是否必选	示例值	描述
Action	String	是	TagResources	要执行的操作，取值为TagResources。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
ResourceType	String	是	endpointservice	资源的类型，取值如下： endpointservice：终端节点服务 endpoint：接口终端节点 gatewayendpoint：网关终端节点
ResourceIds.N	String	是	ResourceIds.1=epsvc-2fe630gurkl37k5gfuy33**&ResourceIds.2=epsvc-2fe630gurkl58k5gfuy26**	资源的ID。说明您可以调用DescribeVpcEndpointServices接口获取“endpointservice”类型的资源ID。您可以调用DescribeVpcEndpoints接口获取“endpoint”类型的资源ID。您可以调用DescribeVpcGatewayEndpoints接口获取“gatewayendpoint”类型的资源ID。 N：表示资源ID的序号，取值范围 1～50。多个资源 ID之间使用&分隔。
Tags.N.Key	String	否	Tags.1.Key=k1&Tags.2.Key=k2	用户标签的标签键。长度限制为1～128个字符。大小写敏感，不能以`volc:`或`sys:`的任意大小写组合开头。不能以空格开头或结尾。允许包含字母、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。说明同一资源的标签键不允许重复。
Tags.N.Value	String	否	Tags.1.Value=v1&Tags.2.Value=value2	用户标签的标签值。长度限制为0～255个字符。大小写敏感，不能以空格开头或结尾。允许包含字母、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。说明如果传入该参数，则必须先传入`Tags.N.Key`。

返回数据

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

请求示例

GET /?Action=TagResources&Version=2020-04-01&ResourceType=endpointservice&ResourceIds.1=epsvc-2fe630gurkl37k5gfuy33****&ResourceIds.2=epsvc-2fe630gurkl58k5gfuy26****&Tags.1.Key=k1&Tags.2.Key=k2&Tags.1.Value=v1&Tags.2.Value=v2 HTTP/1.1
Host: open.volcengineapi.com
Service: privatelink
Region: cn-guangzhou

返回示例

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

错误码

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

HttpCode	错误码	错误信息	描述
400	MissingParameter	The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the 'XXX'.	该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如XXX。说明其中，XXX表示缺少的参数名称。
400	InvalidIncorrectOrder.Malformed	The specified index order is malformed.	指定的索引顺序参数格式不合法。
400	InvalidResourceType.Malformed	The specified ResourceType is malformed.	指定的 ResourceType 参数格式不合法。
400	InvalidTagKey.Malformed	The specified TagKey is malformed.	指定的 TagKey 参数格式不合法。
400	InvalidTagValue.Malformed	The specified TagValue is malformed.	指定的 TagValue 参数格式不合法。
400	LimitExceeded.Resource	You've reached the limit on the number of resources that you can operate at a time.	已达到单次可操作资源数量的上限。
400	LimitExceeded.TagOperation	You've reached the limit on the number of tags that you can operate at a time.	已达到单次可操作的标签条目数量上限。
400	QuotaExceeded.ResourceCustomTags	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.	已达到单个资源可创建系统标签的数量的配额上限。
404	InvalidResource.NotFound	The specified resource does not exist.	指定的资源不存在。