查询集群标签列表 - ListClustersLabels
功能介绍
查询指定K8s集群的所有标签信息。
URI
GET /v1/clusters/labels
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
k8s_cluster_id |
是 |
String |
参数解释 K8s集群ID，用于唯一标识一个K8s集群。 约束限制 不涉及。 取值范围 必须符合UUID格式，包含32个十六进制字符，被连字符分为5组，格式为8-4-4-4-12。 默认取值 不涉及。 |
|
limit |
否 |
Integer |
参数解释 返回结果数量限制，用于控制每次查询返回的标签数量。 约束限制 不涉及。 取值范围 最小值为1，最大值为2000。 默认取值 2000。 |
|
offset |
否 |
Integer |
参数解释 偏移量，用于分页查询，从第offset+1条记录开始返回结果。 约束限制 不涉及。 取值范围 最小值为0，最大值为2000。 默认取值 0。 |
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
参数解释 满足查询条件的总标签数量。 取值范围 最小值为0，最大值为2147483647。 |
|
labels |
Array of Label objects |
参数解释 集群标签列表，包含符合条件的所有标签信息。 取值范围 最小元素个数为0，最大元素个数为2147483647。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key |
String |
参数解释 标签的键。 取值范围 由字母、数字、中划线(-)组成，长度范围1-63字节，且不能以中划线(-)结尾。 |
|
value |
String |
参数解释 标签的值。 取值范围 长度范围最多支持63个字符。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 错误码，用于标识具体的错误类型。 取值范围 不涉及。 |
|
error_msg |
String |
参数解释 错误描述，用于说明具体的错误信息。 取值范围 不涉及。 |
请求示例
无
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
参数解释 成功返回集群标签列表。 取值范围 不涉及。 |
|
400 |
参数解释 错误响应体。 取值范围 不涉及。 |
错误码
请参见错误码章节。
