获取集群配置 - ListCceClusterConfig
功能介绍
获取集群配置
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
POST /v5/{project_id}/container/kubernetes/clusters/configs/batch-query
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0，表示默认企业项目（default）。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
|
region |
否 |
String |
参数解释: 区域ID，用于查询目的区域内的资产。获取方式请参见获取区域ID。 约束限制: 不涉及 取值范围: 字符长度1-128位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
cluster_info_list |
是 |
Array of cluster_info_list objects |
集群id列表 |
|
cluster_id_list |
否 |
Array of strings |
集群id列表 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
配置总数 |
|
data_list |
Array of ClusterConfigResponseInfo objects |
配置信息列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
cluster_id |
String |
集群id |
|
protect_node_num |
Integer |
集群开启防护节点数量 |
|
protect_interrupt_node_num |
Integer |
集群防护中断节点数量 |
|
protect_degradation_node_num |
Integer |
集群防护降级节点数量 |
|
unprotect_node_num |
Integer |
集群防护中断节点数量 |
|
node_total_num |
Integer |
集群节点总数 |
|
cluster_name |
String |
集群名称 |
|
charging_mode |
String |
参数解释: 付费模式 取值范围: 包含以下两种：
|
|
prefer_packet_cycle |
Integer |
优先使用包周期配额；默认0 |
|
protect_type |
String |
参数解释: cce集群防护类型 取值范围:
|
|
protect_status |
String |
参数解释: 防护状态 取值范围:
|
|
cluster_type |
String |
参数解释: 集群类型 取值范围:
|
|
fail_reason |
String |
fail reason |
请求示例
查询集群名称为cluster_name_test，集群id为6a321faa6e6c4a18b5bf19dd9543test集群配置
POST https://{endpoint}/v5{project_id}/container/kubernetes/clusters/configs/batch-query?enterprise_project_id=0
{
"cluster_info_list" : [ {
"cluster_id" : "de17d1db-7f4f-11f0-bf8e-0255ac1001b8",
"cluster_name" : "test-networkpolicy"
}, {
"cluster_id" : "de17d1db-7f4f-11f0-bf8e-0255ac1001b9",
"cluster_name" : "test-networkpolicy1"
} ]
}
响应示例
状态码：200
请求已成功
{
"total_num" : 1,
"data_list" : [ {
"cluster_id" : "6a321faa6e6c4a18b5bf19dd9543test",
"protect_status" : "unprotect"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
