TagResources--容器服务-火山引擎

文档中心

立即注册

导航

容器服务

TagResources

最近更新时间：2024.09.23 14:30:51首次发布时间：2022.12.07 17:14:42

为指定的资源绑定标签。

使用说明

当为资源绑定标签时，如果 Key 不存在，则为其新建一个标签；如果已存在相同 Key 的标签，则更新对应标签的 Value。
标签分为用户自定义标签与系统标签。目前只允许为资源绑定自定义标签。
每个资源可绑定的自定义标签上限为 50 个。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=TagResources&Version=2022-05-12

调试

API Explorer

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

去调试

请求参数

调用该 API 时的请求参数如下，除此之外还需传入公共请求参数。公共请求参数说明，请参见公共参数。

参数	类型	是否必选	示例值	描述
Action	String	是	TagResources	接口名称。当前 API 的名称为 `TagResources`。
Version	String	是	2022-05-12	接口版本。当前 API 的版本为 `2022-05-12`。
ResourceType	String	是	Cluster	绑定标签的资源类型。当前仅支持为集群和节点池绑定资源标签： Cluster：集群 NodePool：节点池
ResourceIds	Array of String	是	["cc5silumrsfeq****"]	资源 ID 列表，即集群 ID 列表或节点池 ID 列表。可以调用 ListClusters 接口获取集群 ID，调用 ListNodePools 接口获取节点池 ID。注意传入多个资源 ID 时，ID 不可重复。最多传入 50 个资源 ID。
Tags	Array of Tag	是	-	资源绑定标签信息。 Tags 中各个 Key 不可重复。资源已有相同 Tags.Key 的情况下，重复绑定 Tags.Key 不会报错，会更新为最新的 Tags.Value。单个资源最多支持绑定50个 Tags。 Tags 中的 Key、Value 不允许在最前或最后输入空格。

参数	类型	是否必选	示例值	描述
Key	String	是	key	标签键。不能以任何大小写形式的`volc:`开头。只能包含语言字符、数字、空格和特殊符号`_.:/=+-@`。长度限制为 1～128 个字符。
Value	String	否	value	标签值，可以为空。只能包含语言字符、数字、空格和特殊符号`_.:/=+-@`。长度不超过 256 个字符。

请求示例

POST https://open.volcengineapi.com/?Action=TagResources&Version=2022-05-12 HTTP/1.1
Content-Type:application/json
{
    "ResourceType": "Cluster",
    "ResourceIds": [
        "cc5silumrsfeq****"
    ],
    "Tags": [
        {
            "Key": "key",
            "Value": "value"
        }
    ]
}

返回参数

本接口无专有返回参数，公共返回参数请参见返回结果。

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "0216353****",
        "Action": "TagResources",
        "Version": "2022-05-12",
        "Service": "vke",
        "Region": "cn-beijing"
    },
    "Result": {}
}

错误码

本接口错误码如下表所示，公共错误码请参见公共错误码。

HTTP 状态码	错误码	错误信息	说明
400	QuotaExceeded.{{ResourceType}}	The quota of {{ResourceType}} has reached the limit.	创建标签资源达到系统限额。