
# 查询实例列表和详情 - QueryingInstancesandDetails
#### 功能介绍
根据指定条件查询数据库实例列表和详情。
#### 接口约束
该接口支持如下数据库实例：
- GeminiDB Cassandra
- GeminiDB Influx
- GeminiDB Redis
- GeminiDB HBase
- GeminiDB兼容DynamoDB
 
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforNoSQL&api=ListInstances)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                           | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名                | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | gaussdbfornosql:instance:list | Read | -           | -   | nosql:backup:list | -      |
     
  
 
#### URI
GET /v3/{project_id}/instances
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|:---|:---|:---|:---|
| project_id | 是    | String | **参数解释：** 租户在某一region下的project ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nosql/nosql_projectid.html)。 **约束限制：** 不涉及。 **取值范围：** 长度为32个字符，仅由英文字母和数字组成。 **默认取值：** 不涉及。 |
   
表2Query参数 
| 参数             | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|:---|
| id             | 否    | String  | **参数解释：** 实例ID。 **约束限制：** 如果id以"\*"起始，表示按照"\*"后面的值模糊匹配，否则，按照实际填写的id精确匹配查询。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| name           | 否    | String  | **参数解释：** 实例名称。 **约束限制：** 如果name以"\*"起始，表示按照"\*"后面的值模糊匹配，否则，按照实际填写的name精确匹配查询。 说明： 如果实例名称中包含中文，暂时不支持通过中文模糊搜索。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| datastore_type | 否    | String  | **参数解释：** 数据库类型。 **约束限制：** 不涉及。 **取值范围：** - 取值为"cassandra"，表示查询GeminiDB Cassandra数据库实例。  - 取值为"mongodb"，表示查询GeminiDB Mongo数据库实例。  - 取值为"influxdb"，表示查询GeminiDB Influx数据库实例。  - 取值为"redis"，表示查询GeminiDB Redis数据库实例。  - 取值为"dynamodb"，表示查询GeminiDB兼容DynamoDB数据库实例。  - 取值为"hbase"，表示查询GeminiDB HBase数据库实例。   **默认取值：** 如果不传该参数，表示查询所有数据库实例。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| mode           | 否    | String  | **参数解释：** 实例类型。 **约束限制：** 如果不传datastore_type参数，自动忽略该参数设置。 **取值范围：** - GeminiDB Cassandra支持经典部署模式集群类型，取值为"Cluster"。   - GeminiDB Cassandra支持云原生部署模式集群类型，取值为"CloudNativeCluster"。   - GeminiDB Influx支持经典部署模式集群类型，取值为"Cluster"。   - GeminiDB Influx支持云原生部署模式集群增强版类型，取值为"CloudNativeCluster"。   - GeminiDB Influx支持经典部署模式集群增强版类型，取值为"EnhancedCluster"。  - GeminiDB Influx支持单节点类型，取值为"InfluxdbSingle"。  - GeminiDB Redis支持经典部署模式Proxy集群类型，取值为"Cluster"。  - GeminiDB Redis支持云原生部署模式集群类型，取值为"CloudNativeCluster"。   - GeminiDB Redis支持经典部署模式Cluster集群类型，取值为"RedisCluster"。Cluster集群实例类型介绍请参见[创建实例](https://support.huaweicloud.com/redisug-nosql/nosql_02_0071.html)。  - GeminiDB Redis支持经典部署模式主备类型，取值为"Replication"。  - GeminiDB兼容DynamoDB支持经典部署模式集群类型，取值为"Cluster"。  - GeminiDB兼容DynamoDB支持云原生部署模式集群类型，取值为"CloudNativeCluster"。  - GeminiDB HBase支持经典部署模式集群类型，取值为"Cluster"。  - GeminiDB HBase支持云原生部署模式集群类型，取值为"CloudNativeCluster"。  - GeminiDB Mongo支持副本集实例类型，取值为"ReplicaSet"。   **默认取值：** 不涉及。 |
| vpc_id         | 否    | String  | **参数解释：** 虚拟私有云ID，获取方法如下： - 方法1：登录[虚拟私有云服务控制台](https://console.huaweicloud.com/vpc/#/vpc/vpcs/list)，在虚拟私有云的详情页面查找VPC ID。  - 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考[查询VPC列表](https://support.huaweicloud.com/api-vpc/vpc_api01_0003.html)。   **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| subnet_id      | 否    | String  | **参数解释：** 子网的网络ID，获取方法如下： - 方法1：登录[虚拟私有云服务控制台](https://console.huaweicloud.com/vpc/#/vpc/vpcs/list)，单击VPC下的子网，进入子网详情页面，查找网络ID。  - 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考[查询子网列表](https://support.huaweicloud.com/api-vpc/vpc_subnet01_0003.html)。   **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| offset         | 否    | Integer | **参数解释：** 索引位置偏移量，表示从指定project ID下最新的实例创建时间开始，按时间的先后顺序偏移offset条数据后查询对应的实例信息。 **约束限制：** 不涉及。 **取值范围：** 取值大于或等于0。 **默认取值：** 不传该参数时，查询偏移量默认为0，表示从最新的实例创建时间对应的实例开始查询。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| limit          | 否    | Integer | **参数解释：** 查询实例个数上限值。 **约束限制：** 不涉及。 **取值范围：** 1\~100。 **默认取值：** 不传该参数时，默认查询前100条实例信息。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
   
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
#### 响应参数
**状态码： 200**
表4响应Body参数 
| 参数          | 参数类型                                                                                 | 描述                                                                                                                            |
|:---|:---|:---|
| instances   | Array of [ListInstancesResult] objects | **参数解释：** 实例信息。                                                                               |
| total_count | Integer                                                                              | **参数解释：** 总记录数。 **取值范围：** 不涉及。 |
   
 表5ListInstancesResult 
| 参数                    | 参数类型                                                                                                   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|:---|:---|:---|
| id                    | String                                                                                                 | **参数解释：** 实例ID。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| name                  | String                                                                                                 | **参数解释：** 实例名称。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| status                | String                                                                                                 | **参数解释：** 实例状态。 **取值范围：** - normal：表示实例正常。  - abnormal：表示实例异常。  - creating：表示实例创建中。  - frozen：表示实例被冻结。  - data_disk_full：表示实例磁盘已满。  - createfail：表示实例创建失败。  - enlargefail：表示实例扩容节点个数失败。   |
| port                  | String                                                                                                 | **参数解释：** 数据库端口。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| mode                  | String                                                                                                 | **参数解释：** 实例类型。 **取值范围：** 与请求参数相同。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| product_type          | String                                                                                                 | **参数解释：** 产品类型。GeminiDB Redis云原生部署模式集群涉及此字段。 **取值范围：** - Capacity：容量型。  - Performance：性能型。                                                                                                                                                                                                                                                                                                                                                                                                                       |
| region                | String                                                                                                 | **参数解释：** 实例所在区域。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| datastore             | [ListInstancesDatastoreResult] object           | **参数解释：** 数据库信息。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| engine                | String                                                                                                 | **参数解释：** 存储引擎。 **取值范围** **：** "rocksDB"。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| created               | String                                                                                                 | **参数解释：** 实例创建时间。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| updated               | String                                                                                                 | **参数解释：** 实例操作最新变更的时间。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| db_user_name          | String                                                                                                 | **参数解释：** 默认用户名。 **取值范围：** "rwuser"。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| vpc_id                | String                                                                                                 | **参数解释：** 虚拟私有云ID。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| subnet_id             | String                                                                                                 | **参数解释：** 子网ID。 **取值范围：** GeminiDB Cassandra 实例使用多个子网的场景，请参见[表 ListInstancesNodeResult字段数据结构说明]中的"subnet_id"。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| security_group_id     | String                                                                                                 | **参数解释：** 安全组ID。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| backup_strategy       | [ListInstancesBackupStrategyResult] object | **参数解释：** 备份策略。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| pay_mode              | String                                                                                                 | **参数解释：** 计费方式。 **取值范围：** - 取值为"0"，表示按需计费。  - 取值为"1"，表示包年/包月计费。                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| maintenance_window    | String                                                                                                 | **参数解释：** 系统可维护时间窗。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| backup_space_usage    | [表6] object                                                      | **参数解释：** 备份空间使用情况。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| groups                | Array of [ListInstancesGroupResult] objects         | **参数解释：** 组信息。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| enterprise_project_id | String                                                                                                 | **参数解释：** 企业项目ID。 **取值范围：** "0"，表示为default企业项目。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| time_zone             | String                                                                                                 | **参数解释：** 时区。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| actions               | Array of strings                                                                                       | **参数解释：** 实例正在执行的动作。 - CREATE：实例创建中。  - REBOOT：实例重启中。  - RESTORE：实例恢复中。                                                                                                                                                                                                                                                                                                                                                                                                     |
| dedicated_resource_id | String                                                                                                 | **参数解释：** 专属资源ID，只有数据库实例属于专属资源池才会返回该参数。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| disk_encryption_id    | String                                                                                                 | **参数解释：** 磁盘加密时的密钥ID。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| lb_ip_address         | String                                                                                                 | **参数解释：** 负载均衡IP。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| lb_port               | String                                                                                                 | **参数解释：** 负载均衡端口。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| availability_zone     | String                                                                                                 | **参数解释：** 实例可用区。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| dr_instance_id        | String                                                                                                 | **参数解释：** 容灾实例ID。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| dual_active_info      | [DualActiveInfo] object                                           | **参数解释：** 双活信息。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| ccm_cert_info         | [CertInfoOption] object                                           | **参数解释：** CCM证书信息。 开启ssl后，如果不传此参数，表示使用默认证书。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| ssl                   | String                                                                                                 | **参数解释：** SSL安全连接启用情况。 **取值范围：** - 0：表示未启用。  - 1：表示已启用。                                                                                                                                                                                                                                                                                                                                                                                           |
   
 表6ListInstancesBackupSpaceUsageResult 
| 参数           | 参数类型 | 描述                                                                                                                                                                                                   |
|:---|:---|:---|
| backup_usage | Long | **参数解释：** 备份空间使用量。单位：KB。 **取值范围：** 不涉及。 |
   
 表7ListInstancesDatastoreResult 
| 参数              | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|:---|:---|:---|
| type            | String  | **参数解释：** 数据库接口。 **取值范围：** - cassandra：表示查询GeminiDB Cassandra数据库实例。  - mongodb：表示查询GeminiDB Mongo数据库实例。  - influxdb：表示查询GeminiDB Influx数据库实例。  - redis：表示查询GeminiDB Redis数据库实例。   |
| version         | String  | **参数解释：** 数据库版本号。 **取值范围：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| patch_available | Boolean | **参数解释：** 当前实例是否有可升级的补丁。 **取值范围：** - true：可以通过升级补丁接口进行数据库升级。  - false：不可以通过升级补丁接口进行数据库升级。                                                                                                                                                                                                                                |
| whole_version   | String  | **参数解释：** 数据库的完整版本号(目前只有GeminiDB Cassandra和GeminiDB Redis支持)。 **取值范围** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                            |
   
 表8ListInstancesBackupStrategyResult 
| 参数         | 参数类型    | 描述                                                                                                                                                          |
|:---|:---|:---|
| start_time | String  | **参数解释：** 备份时间段。自动备份将在该时间段内触发。当前时间指UTC时间。 **取值范围** **：** 不涉及。 |
| keep_days  | Integer | **参数解释：** 已生成备份文件可以保存的天数。 **取值范围：** 0\~35。                  |
   
 表9ListInstancesGroupResult 
| 参数     | 参数类型                                                                                         | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|:---|:---|:---|
| id     | String                                                                                       | **参数解释：** 组ID。 **取值范围** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| status | String                                                                                       | **参数解释：** 组状态。 **取值范围：** - normal：表示组正常。  - abnormal：表示组异常。  - creating：表示组创建中。  - createfail：表示组创建失败。  - deleted：表示组被删除。  - resizefailed：表示组规格变更失败。  - enlargefail：表示组扩容失败。   |
| volume | [Volume] object                                             | **参数解释：** volume信息                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| nodes  | Array of [ListInstancesNodeResult] objects | **参数解释：** 节点信息。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
   
 表10Volume 
| 参数        | 参数类型   | 描述                                                                                                                                                                                                   |
|:---|:---|:---|
| size      | String | **参数解释：** 磁盘大小。单位：GB。 **取值范围** **：** 不涉及。                                                             |
| used      | String | **参数解释：** 磁盘使用量。单位：GB。 **取值范围** **：** 不涉及。                                                          |
| gift_size | String | **参数解释：** 赠送的磁盘大小。单位：GB。 **取值范围：** 不涉及。 |
   
 表11ListInstancesNodeResult 
| 参数                | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|:---|:---|:---|
| id                | String  | **参数解释：** 节点ID。 **取值范围** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| name              | String  | **参数解释：** 节点名称。 **取值范围** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| status            | String  | **参数解释：** 节点状态。 **取值范围** **：** - normal：表示节点正常。  - abnormal：表示节点异常。  - creating：表示节点创建中。  - createfail：表示节点创建失败。  - deleted：表示节点被删除。  - resizefailed：表示节点规格变更失败。  - enlargefail：表示节点扩容失败。   |
| role              | String  | **参数解释：** 节点角色。该参数仅对GeminiDB Mongo接口的副本集实例有效。 **取值范围** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| subnet_id         | String  | **参数解释：** 节点所在的子网的ID。 **取值范围** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| private_ip        | String  | **参数解释：** 节点内网IP。 在弹性云服务器创建成功后参数值存在，否则，值为""。 **取值范围** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| public_ip         | String  | **参数解释：** 绑定的公网IP。 该参数仅针对绑定了公网IP的节点有效。 **取值范围** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| spec_code         | String  | **参数解释：** 资源规格编码。关于实例的规格信息，请参见[查询数据库规格 - QueryingInstanceSpecifications](https://support.huaweicloud.com/api-nosql/nosql_instance_specification.html)中响应参数"flavors.spec_code"的值。 **取值范围** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| availability_zone | String  | **参数解释：** 可用区。 **取值范围** **：** 不涉及。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| support_reduce    | Boolean | **参数解释：** 是否支持节点缩容。 **取值范围** **：** - true，表示该节点支持节点缩容。  - false，表示该节点不支持节点缩容。                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
   
 表12DualActiveInfo 
| 参数                             | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                           |
|:---|:---|:---|
| role                           | String  | **参数解释：** 双活角色。 **取值范围** **：** 不涉及。                                                                                                                                                                                                           |
| status                         | String  | **参数解释：** 双活状态。 **取值范围** **：** - normal：表示双活状态正常。  - abnormal：表示双活状态异常。   |
| destination_instance_id        | String  | **参数解释：** 双活对端实例ID。 **取值范围** **：** 不涉及。                                                                                                                                                                                                      |
| destination_region             | String  | **参数解释：** 双活对端区域。 **取值范围** **：** 不涉及。                                                                                                                                                                                                          |
| destination_instance_name      | String  | **参数解释：** 双活对端实例名称。 **取值范围：** 不涉及。                                                                                                                                                                                                             |
| destination_instance_node_num  | Integer | **参数解释：** 双活对端实例节点数量。 **取值范围：** 不涉及。                                                                                                                                                                                                              |
| destination_instance_spec_code | String  | **参数解释：** 双活对端实例规格。 **取值范围：** 不涉及。                                                                                                                                                                                                                |
   
 表13CertInfoOption 
| 参数        | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                     |
|:---|:---|:---|
| cert_id   | String | **参数解释：** 证书ID：通过CCM证书列表接口获取。 **取值范围：** 不涉及。                                                                                                                                                                                             |
| cert_type | String | **参数解释：** 证书类型。 **取值范围：** - PCA：CCM PCA证书。  - SSL：CCM SSL证书。   |
   
#### 请求示例
- 查询所有实例列表和详情
  ```
  GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances
  ```
  
- 根据指定条件查询实例列表和详情
  ```
  GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances?offset=0&limit=10&id=ed7cc6166ec24360a5ed5c5c9c2ed726in06&name=hy&mode=Cluster&datastore_type=cassandra&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7
  ```
  
 
#### 响应示例
**状态码： 200**
Success
- **无容灾及双活实例场景时**
  ```
  {
    "instances" : [ {
      "id" : "8436a91546294036b75931e879882200in06",
      "name" : "nosql-efa6",
      "status" : "normal",
      "port" : "8635",
      "mode" : "Cluster",
      "region" : "aaa",
      "datastore" : {
        "type" : "cassandra",
        "version" : "3.11",
        "whole_version" : "3.11.3.11204", 
        "patch_available" : false
      },
      "engine" : "rocksDB",
      "created" : "2019-01-17T07:05:52",
      "updated" : "2019-01-17T07:05:47",
      "db_user_name" : "rwuser",
      "ssl" : "1", 
      "vpc_id" : "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
      "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
      "security_group_id" : "7aa51dbf-5b63-40db-9724-dad3c4828b58",
      "backup_strategy" : {
        "start_time" : "16:00-17:00",
        "keep_days" : 7
      },
      "pay_mode" : "0",
      "maintenance_window" : "02:00-06:00",
      "groups" : [ {
        "id" : "0b0ff12541794e1084f6827e424be2d6gr06",
        "status" : "creating",
        "volume" : {
          "size" : "10",
          "used" : "0.33"
        },
        "nodes" : [ {
          "id" : "233eaac9c6f245c0bb9c2d21eea12d1bno06",
          "name" : "nosql-efa6_priam_node_1",
          "status" : "normal",
          "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
          "private_ip" : "192.168.0.174",
          "spec_code" : "geminidb.redis.xlarge.4",
          "availability_zone" : "bbb"
        }, {
          "id" : "d57d76d6320a4a7b86db82c317550c4ano06",
          "name" : "nosql-efa6_priam_node_2",
          "status" : "normal",
          "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
          "private_ip" : "192.168.0.175",
          "spec_code" : "geminidb.redis.xlarge.4",
          "availability_zone" : "bbb"
        }, {
          "id" : "f46b0a1cf4d9400e9fd7af17f8742d37no06",
          "name" : "nosql-efa6_priam_node_3",
          "status" : "normal",
          "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
          "private_ip" : "192.168.0.176",
          "spec_code" : "geminidb.redis.xlarge.4",
          "availability_zone" : "bbb"
        } ]
      } ],
        "enterprise_project_id" : "0",
        "availability_zone": "cn-north-4a,cn-north-4b,cn-north-4c",
        "time_zone" : "",
        "actions" : [ "CREATE" ],
        "lb_ip_address" : "192.168.11.145",
        "lb_port" : "8635"
    }, {
      "id" : "1236a91546294036b75931e879882200in02",
      "name" : "nosql-efa7",
      "status" : "normal",
      "port" : "8635",
      "mode" : "ReplicaSet",
      "region" : "aaa",
      "datastore" : {
        "type" : "mongodb",
        "version" : "4.0",
        "patch_available" : false
      },
      "engine" : "rocksDB",
      "created" : "2019-01-17T07:05:52",
      "updated" : "2019-01-17T07:05:47",
      "db_user_name" : "rwuser",
      "ssl" : "1", 
      "vpc_id" : "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
      "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
      "security_group_id" : "7aa51dbf-5b63-40db-9724-dad3c4828b58",
      "backup_strategy" : {
        "start_time" : "16:00-17:00",
        "keep_days" : 7
      },
      "pay_mode" : "0",
      "maintenance_window" : "02:00-06:00",
      "groups" : [ {
        "id" : "0b0ff12541794e1084f6827e424be2d1gr02",
        "status" : "normal",
        "volume" : {
          "size" : "100",
          "used" : "0.003"
        },
        "nodes" : [ {
          "id" : "233eaac9c6f245c0bb9c2d21eea12d1bno02",
          "name" : "nosql-efa7_replica_node_2",
          "status" : "normal",
          "role" : "Primary",
          "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
          "private_ip" : "192.168.0.174",
          "public_ip" : "10.154.217.134",
          "spec_code" : "geminidb.mongodb.xlarge.4",
          "availability_zone" : "bbb"
        }, {
          "id" : "d57d76d6320a4a7b86db82c317550c4ano02",
          "name" : "nosql-efa7_replica_node_1",
          "status" : "normal",
          "role" : "Secondary",
          "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
          "private_ip" : "192.168.0.39",
          "spec_code" : "geminidb.mongodb.xlarge.4",
          "availability_zone" : "bbb"
        }, {
          "id" : "f46b0a1cf4d9400e9fd7af17f8742d37no02",
          "name" : "nosql-efa7_replica_node_3",
          "status" : "normal",
          "role" : "Secondary",
          "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
          "private_ip" : "192.168.0.176",
          "spec_code" : "geminidb.mongodb.xlarge.4",
          "availability_zone" : "bbb"
        } ]
      } ],
        "enterprise_project_id" : "0", 
        "availability_zone": "cn-north-4a,cn-north-4b,cn-north-4c",
        "time_zone" : "",
        "actions" : [ ]
    } ],
    "total_count" : 2
  }
  ```
  

- **有容灾及双活实例场景时**
  ```
  {
      "instances": [
          {
              "id": "e3cb7981fab74fa3aa930333e8c12a7cin06",
              "name": "geminidb-78a2-gsm-master",
              "status": "normal",
              "port": "8635",
              "mode": "CloudNativeCluster",
              "region": "cn-southwest-244",
              "datastore": {
                  "type": "cassandra",
                  "version": "3.11",
                  "patch_available": false,
                  "whole_version": null
              },
              "engine": "rocksDB",
              "created": "2026-03-06T09:30:52",
              "updated": "2026-03-10T13:20:28",
              "db_user_name": "rwuser",
              "ssl" : "1", 
              "vpc_id": "f457aa28-72de-42b8-8517-d9c6e14b9d09",
              "subnet_id": "c0650bbe-4c89-4f2a-8cd2-3e2171b96d99",
              "security_group_id": "17157fcb-8357-4ea5-9619-c07cb1610334",
              "backup_strategy": {
                  "start_time": "19:00-20:00",
                  "keep_days": 7
              },
              "pay_mode": "0",
              "maintenance_window": "02:00-06:00",
              "backup_space_usage": {
                  "backup_usage": 65965656
              },
              "groups": [
                  {
                      "id": "0b0d3c0cbfd941a182ca3676cc4b7f37gr06",
                      "status": "normal",
                      "volume": {
                          "size": "10",
                          "used": "0.004",
                          "gift_size": "0"
                      },
                      "nodes": [
                          {
                              "id": "ad92f186b46543bd961c4ae14180d3d7no06",
                              "name": "geminidb-78a2-gsm-master_g9tv_priam_node_3",
                              "status": "normal",
                              "subnet_id": "c0650bbe-4c89-4f2a-8cd2-3e2171b96d99",
                              "private_ip": "192.168.192.66",
                              "spec_code": "geminidb.cassandra-geminifs.large.4",
                              "availability_zone": "cn-southwest-244d",
                              "support_reduce": false
                          },
                          {
                              "id": "cca92a2ea84a49b6a30d5b9b8f64e053no06",
                              "name": "geminidb-78a2-gsm-master_g9tv_priam_node_2",
                              "status": "normal",
                              "subnet_id": "c0650bbe-4c89-4f2a-8cd2-3e2171b96d99",
                              "private_ip": "192.168.135.148",
                              "spec_code": "geminidb.cassandra-geminifs.large.4",
                              "availability_zone": "cn-southwest-244c",
                              "support_reduce": false
                          },
                          {
                              "id": "fa083404f965476b97ce73c76930db5fno06",
                              "name": "geminidb-78a2-gsm-master_g9tv_priam_node_1",
                              "status": "normal",
                              "subnet_id": "c0650bbe-4c89-4f2a-8cd2-3e2171b96d99",
                              "private_ip": "192.168.240.254",
                              "spec_code": "geminidb.cassandra-geminifs.large.4",
                              "availability_zone": "cn-southwest-244b",
                              "support_reduce": false
                          }
                      ]
                  }
              ],
              "enterprise_project_id": "0",
              "time_zone": "",
              "actions": [],
              "availability_zone": "cn-southwest-244b,cn-southwest-244c,cn-southwest-244d",
              "ccm_cert_info": {},
              "dr_instance_id": "7a0c5367976f4188aa17d70528a7b386in06",
              "dual_active_info": {
                  "status": "normal",
                  "destination_region": "cn-southwest-244",
                  "destination_instance_id": "be3eaef8555442a399046fd8ac02c392in06",
                  "destination_instance_name": "geminidb-8779-gsm-biactive",
                  "destination_instance_node_num": 2,
                  "destination_instance_spec_code": "geminidb.cassandra-geminifs.large.4"
              }
          }
      ],
      "total_count": 1
  }
  ```
  
 
#### 状态码
请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。
