查询密码服务集群列表 - ShowCcspClusterList
功能介绍
查询密码服务集群列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
cpcs:cluster:listClusters
List
cluster *
-
-
-
URI
GET /v1/{project_id}/dew/cpcs/cluster
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
page_size |
否 |
Integer |
指定查询返回记录条数，默认值10 |
|
page_num |
否 |
Integer |
索引位置，从page_num指定的下一条数据开始查询默认值为0 |
|
name |
否 |
String |
集群名称 |
|
service_type |
否 |
String |
集群所属的服务类型：
|
|
sort_key |
否 |
String |
排序属性，目前支持以下属性：
|
|
sort_dir |
否 |
String |
排序方向，支持以下值：
|
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户token，参见:IAM token获取方法 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
满足条件的集群总数 |
|
result |
Array of CcspClusterInfo objects |
集群列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
task_id |
String |
任务ID |
|
project_id |
String |
项目ID |
|
domain_id |
String |
账号ID |
|
task_details |
Array of objects |
任务详情 |
|
ccsp_id |
String |
ccsp集群id |
|
distributed_type |
String |
分布类型 |
|
cluster_id |
String |
集群ID |
|
cluster_name |
String |
集群名称 |
|
service_type |
String |
集群所属的服务 |
|
type |
String |
集群的类型：
|
|
instance_num |
Integer |
集群中包含的服务实例数量 |
|
status |
String |
集群状态 |
|
progress_info |
String |
进度信息 |
|
vsm_num |
Integer |
集群使用VSM集群的vsm实例数量 |
|
create_time |
Long |
集群的创建时间，UNIX时间戳，单位毫秒 |
|
shared_ccsp |
Boolean |
是否共享ccsp |
|
enterprise_project_id |
String |
企业项目ID |
|
az |
String |
az |
请求示例
查询密码服务集群列表请求头中的X-Auth-Token字段需要填写token，且该token需要具有本API的访问权限
GET https://cpcs.com/v1/{project_id}/dew/cpcs/cluster?page_size=2&page_num=0
响应示例
状态码：200
请求已成功
{
"total_num" : 2,
"result" : [ {
"task_id" : "e864d1df-ed0f-4b99-b01a-045802ce40a0",
"project_id" : "d4e559b49b3b403da5279723299ed4a6",
"domain_id" : "3bab8e245e854f68af5967c00dd43127",
"task_details" : null,
"ccsp_id" : "496745abc7dd44cda0d6af64555c750c",
"distributed_type" : "NORMAL",
"cluster_id" : "f05e0ae4b4bb442c82d4b8a0f16c4f84",
"cluster_name" : "fvgbhnm",
"service_type" : "COLLA_SIGN",
"type" : "EXCLUSIVE",
"instance_num" : 1,
"status" : "RUNNING",
"progress_info" : null,
"vsm_num" : 1,
"create_time" : 1752826659000,
"shared_ccsp" : true,
"enterprise_project_id" : null,
"az" : null
}, {
"task_id" : "88018a11-7db3-45dc-acc2-301db3347e3e",
"project_id" : "d4e559b49b3b403da5279723299ed4a6",
"domain_id" : "3bab8e245e854f68af5967c00dd43127",
"task_details" : null,
"ccsp_id" : "496745abc7dd44cda0d6af64555c750c",
"distributed_type" : "NORMAL",
"cluster_id" : "b60526b15c254f64ad165cc438abe75e",
"cluster_name" : "new协签",
"service_type" : "COLLA_SIGN",
"type" : "EXCLUSIVE",
"instance_num" : 1,
"status" : "RUNNING",
"progress_info" : null,
"vsm_num" : 1,
"create_time" : 1752832663000,
"shared_ccsp" : true,
"enterprise_project_id" : null,
"az" : null
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
