表5-49 参数说明
参数 是否为必选 类型 说明
project_id 是 String 项目编号。详细请参考获取项
目ID/账号ID。
cluster_id 是 String 指定待查询的集群ID。
请求消息
无。
响应消息
响应参数如表5-50所示。
表5-50 响应参数
参数 类型 说明
tags Array of tag
objects 集群标签列表。
表5-51 tags 字段要素说明
参数 类型 说明
key String 集群标签的key值。
value String 集群标签的value值。
示例
请求样例
GET v1.0/458d905f22da49c39f609e3347d65723/css-cluster/4f3deec3-efa8-4598-bf91-560aad1377a3/tags
响应样例
{ "tags": [ {
"key": "key1", "value": "value1"
}, {
"key": "key2", "value": "value3"
} ] }
状态码
状态码如表5-52所示。
表5-52 状态码
状态码 编码 说明
400 BadRequest 非法请求。
建议直接修改该请求，不要重试 该请求。
404 NotFound 所请求的资源不存在。
建议直接修改该请求，不要重试 该请求。
200 OK 请求已成功。
5.9.2 查询所有标签
功能介绍
该接口用于查询指定region下的所有标签集合。
URI
GET /v1.0/{project_id}/css-cluster/tags
表5-53 参数说明
参数 是否为必选 类型 说明
project_id 是 String 项目编号。详细请参考
获取项目ID/账号ID。
请求消息
无
响应消息
响应参数如表5-54所示。
表5-54 响应参数
参数 类型 说明
tags Array of tag
objects 集群的标签列表。详细请参考表5-55。
表5-55 tags 字段要素说明
参数 类型 说明
key String 集群标签的key值。
values Array of
strings 集群标签的value值列表。
示例
请求样例
GET v1.0/458d905f22da49c39f609e3347d65723/css-cluster/tags
响应样例
{ "tags": [ {
"key": "key1", "values": [ "value1", "value2"
] }, {
"key": "key2", "values": [ "value1", "value2"
] } ] }
状态码
状态码如表5-56所示。
表5-56 状态码
状态码 编码 说明
400 BadRequest 非法请求。
建议直接修改该请求，不要重试该 请求。
404 NotFound 所请求的资源不存在。
建议直接修改该请求，不要重试该 请求。
200 OK 请求已成功。
5.9.3 添加集群标签
功能介绍
此接口用于给指定集群添加标签。一个集群最多添加10个标签。
URI
POST /v1.0/{project_id}/css-cluster/{cluster_id}/tags
表5-57 参数说明
名称 是否必选 参数类型 说明
project_id 是 String 项目ID。
详细请参考获取项目ID/
账号ID。
cluster_id 是 String 指定需添加标签的集群 ID。
请求消息
表5-58 tag 字段数据结构说明
名称 是否必选 参数类型 说明
key 是 String 集群标签的key值。最大长度36个字符。
value 是 String 集群标签的value值。每个值最大长度43 个字符。
删除时，如果value有值，则按照key和 value删除。如果value没值，则按照key 删除。
响应消息
无。
示例
● 请求示例
{ "tag": { "key": "DEV", "value": "DEV1"
} }
● 响应示例 无。
状态码
状态码如表5-59所示。
表5-59 状态码
状态码 编码 说明
400 BadRequest 非法请求。
建议直接修改该请求，不要重试该 请求。
404 NotFound 所请求的资源不存在。
建议直接修改该请求，不要重试该 请求。
204 OK 请求已成功。
5.9.4 批量添加或删除集群标签
功能介绍
此接口为指定集群批量添加或删除标签。标签管理服务需要使用该接口批量管理集群 的标签。一个集群最多添加10个标签。
说明
● 此接口为幂等接口，创建时，请求体中不能存在重复key，否则报错。
● 添加标签时，
● key不能为空，不能为空字符串。不能包含下列字符：非打印字符ASCII(0-31)，“=”,
“*”,“<”,“>”,“\”,“,”,“|”,“/”以及大小写字母，数字，中划线“-”，下划 线“_”。
● value不能为空，可以空字符串。不能包含下列字符：非打印字符ASCII(0-31)，“=”,
“*”,“<”,“>”,“\”,“,”,“|”,“/”以及大小写字母，数字，中划线“-”，下划 线“_”。
● 不允许设置重复key。如果数据库已存在该key，则会覆盖value的值。
● 删除标签时，
● 如果删除的标签不存在，默认处理成功。删除时不对标签字符集范围做校验。
● tags结构体不能缺失，key不能为空，或者空字符串。
URI
POST /v1.0/{project_id}/css-cluster/{cluster_id}/tags/action
表5-60 参数说明
名称 是否必
选
参数类型 说明
project_id 是 String 项目ID。详细请参考获取项目ID/账
号ID。
cluster_id 是 String 指定待批量删除或添加标签的集群 ID。
请求消息
表5-61 请求参数
名称 是否必
选
参数类型 说明
tags 否 Array of tag
objects 标签列表。
action 是 String 操作标识，仅限于create（创建）和delete
（删除）。
表5-62 resource_tag 字段数据结构说明
名称 是否必选 参数类型 说明
key 是 String 集群标签的key值。最大长度36个字符。
value action为 create时必 选。action 为delete时 非必选。
String 集群标签的value值。每个值最大长度43个 字符。
删除时，如果value有值，则按照key和 value删除。如果value没值，则按照key删 除。
响应消息
无。
示例
● 请求样例
POST /v1.0/458d905f22da49c39f609e3347d65723/css-cluster/4f3deec3-efa8-4598-bf91-560aad1377a3/tags/
action
批量添加标签。
{ "action": "create", "tags": [
{
"key": "key1", "value": "value1"
} ] }
批量删除标签。
{ "action": "delete", "tags": [
{
"key": "key1"
} ] }
● 响应样例 无。
状态码
状态码如表5-63所示。
表5-63 状态码
状态码 编码 说明
400 BadRequest 非法请求。
建议直接修改该请求，不要重试该 请求。
404 NotFound 所请求的资源不存在。
建议直接修改该请求，不要重试该 请求。
204 OK 请求已成功。
5.9.5 删除集群指定标签
功能介绍
此接口用于删除集群的指定标签。
URI
DELETE /v1.0/{project_id}/css-cluster/{cluster_id}/tags/{key}
表5-64 参数说明
名称 是否必选 参数类型 说明
project_id 是 String 项目ID。
详细请参考获取项目ID/账号
ID。
cluster_id 是 String 指定待删除标签的集群ID。
key 是 String 标签key。
Key不能为空或者空字符串。
请求消息
无。
响应消息
无。
示例
● 请求样例
DELETE /v1.0/458d905f22da49c39f609e3347d65723/css-cluster/4f3deec3-efa8-4598-bf91-560aad1377a3/tags/key1
● 响应样例 无。
状态码
状态码如表5-65所示。
表5-65 状态码
状态码 编码 说明
400 BadRequest 非法请求。
建议直接修改该请求，不要重试该 请求。
404 NotFound 所请求的资源不存在。
建议直接修改该请求，不要重试该 请求。
204 OK 请求已成功。