# 查询密码服务实例列表 - ShowCcspInstanceInfo #### 功能介绍 查询密码服务实例列表 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dew/dew_02_0002.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dew/dew_02_0308.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | cpcs:cluster:listInstances | List | cluster \* | - | - | - | #### URI GET /v1/{project_id}/dew/cpcs/instances 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID。可参考[获取项目ID](https://support.huaweicloud.com/api-dew/dew_02_0009.html)获取。 **约束限制：** 不涉及 **取值范围：** 字符长度为32 **默认取值：** 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数解释：** 指定查询返回记录条数，默认值10 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | name | 否 | String | **参数解释：** 实例名称 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | offset | 否 | Integer | **参数解释：** 查询偏移值 **约束限制：** 大于等于0 **取值范围：** 不涉及 **默认取值：** 0 | | sort_key | 否 | String | **参数解释：** 排序属性 **约束限制：** 不涉及 **取值范围：** - **create_time** : 应用的创建时间 **默认取值：** create_time | | sort_dir | 否 | String | **参数解释：** 排序方向 **约束限制：** 不涉及 **取值范围：** - **DESC** : 降序 - **ASC** : 升序 **默认取值：** DESC | | cluster_id | 否 | String | **参数解释：** 密码服务集群ID **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | status | 否 | String | **参数解释：** 实例的服务状态: **约束限制：** 不涉及 **取值范围：** - **enable** : 启用； - **disable** : 停用 **默认取值：** 不涉及 | | is_normal | 否 | Boolean | **参数解释：** 实例健康状态： - **true** : 正常； - **false** : 异常 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。使用AK、SK等认证方式，此处非必选 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_num | Integer | **参数解释：** 满足条件的实例总数 **取值范围：** 不涉及 | | result | Array of [CcspInstanceInfo] objects | **参数解释：** 实例列表 **取值范围：** 不涉及 | 表5CcspInstanceInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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?limit=2&offset=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 | 请求已成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dew/ErrorCode.html)。