查询密码服务实例列表 - ShowCcspInstanceInfo
功能介绍
查询密码服务实例列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
cpcs:cluster:listInstances
List
cluster *
-
-
-
URI
GET /v1/{project_id}/dew/cpcs/instances
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
page_size |
否 |
Integer |
指定查询返回记录条数，默认值10 |
|
name |
否 |
String |
实例名称 |
|
page_num |
否 |
Integer |
索引位置，从page_num指定的下一条数据开始查询默认值为0 |
|
sort_key |
否 |
String |
排序属性，目前支持以下属性：
|
|
sort_dir |
否 |
String |
排序方向，支持以下值：
|
|
cluster_id |
否 |
String |
密码服务集群ID |
|
status |
否 |
Integer |
实例的服务状态:
|
|
is_normal |
否 |
Boolean |
实例健康状态：
|
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户token，参见:IAM token获取方法 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
满足条件的实例总数 |
|
result |
Array of CcspInstanceInfo objects |
实例列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
instance_id |
String |
实例ID |
|
resource_id |
String |
cbc资源id |
|
instance_name |
String |
实例名称 |
|
service_type |
String |
实例所属的服务 |
|
cluster_id |
String |
实例所属的集群的ID |
|
is_normal |
Boolean |
实例的健康状态 |
|
status |
String |
实例的服务状态 |
|
image_name |
String |
实例的镜像名称 |
|
specification |
String |
实例的虚机规格 |
|
az |
String |
az |
|
expired_time |
Long |
超期时间 |
|
create_time |
Long |
实例的创建时间，UNIX时间戳，单位毫秒 |
请求示例
查询密码服务实例列表请求头中的X-Auth-Token字段需要填写token，且该token需要具有本API的访问权限
GET https://cpcs.com/v1/{project_id}/dew/cpcs/instances?page_size=2&page_num=0
响应示例
状态码：200
请求已成功
{
"total_num" : 1,
"result" : [ {
"instance_id" : "5e1da516-579a-4ac2-9775-ea6f803a2680",
"resource_id" : "373e8aa5-cade-457a-bd97-de13bc7eb058",
"instance_name" : "fvgbhnm-0",
"service_type" : "COLLA_SIGN",
"cluster_id" : "f05e0ae4b4bb442c82d4b8a0f16c4f84",
"is_normal" : true,
"status" : "ENABLE",
"image_name" : "xasj-vMAuth1.0_X86_HCE_build20250717_MAuth3.1.1.1",
"specification" : "s6.large.2",
"az" : "test-az",
"expired_time" : 1755532799000,
"create_time" : 1752826659000
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
