更新时间:2024-12-12 GMT+08:00
分享

批量添加集群标签

功能介绍

为指定集群批量添加标签。

一个集群上最多有20个标签。

此接口为幂等接口:

  • 创建时,同一个集群不允许重复key,如果数据库存在就覆盖。

接口约束

调用方法

请参见如何调用API

URI

POST /v1.1/{project_id}/clusters/{cluster_id}/tags/action

表1 路径参数

参数

是否必选

参数类型

描述

cluster_id

String

参数解释:

集群ID。如果指定集群ID,则获取该集群做过补丁更新的最新版本元数据。获取方法,请参见获取集群ID

约束限制:

不涉及

取值范围:

只能由英文字母、数字以及“_”和“-”组成,且长度为[1-64]个字符。

默认取值:

不涉及

project_id

String

参数解释:

项目编号。获取方法,请参见获取项目ID

约束限制:

不涉及

取值范围:

只能由英文字母和数字组成,且长度为[1-64]个字符。

默认取值:

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

action

String

参数解释:

操作标识:仅限于create(创建)。

约束限制:

不涉及

取值范围:

  • create:创建标签。

默认取值:

不涉及

tags

Array of Tag objects

参数解释:

标签列表。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 Tag

参数

是否必选

参数类型

描述

key

String

参数解释:

标签的键。

约束限制:

不涉及

取值范围:

  • 最大长度128个字符,不能为空字符串。

  • 同一资源的key值不能重复。

  • 标签的key值可以包含任意语种字母、数字、空格和_.:=+-@,但首尾不能含有空格,不能以_sys_开头。

默认取值:

不涉及

value

String

参数解释:

标签的值。

约束限制:

不涉及

取值范围:

  • 最大长度255个字符,可以为空字符串。

  • 标签的value值可以包含任意语种字母、数字、空格和_.:=+-@,但首尾不能含有空格,不能以_sys_开头。

默认取值:

不涉及

响应参数

请求示例

批量添加集群标签

POST /v1.1/{project_id}/clusters/{cluster_id}/tags/action

{
  "action" : "create",
  "tags" : [ {
    "key" : "DEV1",
    "value" : "DEV1"
  }, {
    "key" : "DEV2",
    "value" : "DEV2"
  } ]
}

响应示例

状态码

状态码

描述

204

操作成功。

错误码

请参见错误码

相关文档