查询集群防护信息 - ListClusterProtectionInfo
功能介绍
查询集群防护信息
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/cluster-protect/clusters
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0，表示默认企业项目（default）。 |
|
offset |
是 |
Integer |
参数解释: 偏移量：指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0，最大值2000000 默认取值: 不涉及 |
|
limit |
是 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
总数 |
|
data_list |
Array of ClusterResponseInfo objects |
集群防护信息列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
cluster_name |
String |
集群名称 |
|
cluster_id |
String |
集群ID |
|
cluster_version |
String |
集群版本 |
|
protect_status |
String |
参数解释： 防护状态 取值范围:
|
|
policy_num |
Integer |
策略数量 |
|
cluster_status |
String |
参数解释： 集群运行状态 取值范围:
|
|
cluster_type |
String |
集群类型，包含以下几种：
|
请求示例
查询集群防护信息
GET https://{endpoint}/v5/{project_id}/cluster-protect/clusters?offset=0&limit=200&enterprise_project_id=all_granted_eps
响应示例
状态码：200
集群防护列表
{
"total_num" : 14,
"data_list" : [ {
"cluster_id" : "05677f29-1ab0-4ea0-91a3-a72cb8bae59c",
"cluster_name" : "dfx-master",
"cluster_type" : "self_built_idc",
"policy_num" : 0,
"protect_status" : "unprotected",
"cluster_status" : "Available"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
集群防护列表 |
错误码
请参见错误码。
