文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 实例管理/ 查询实例列表和详情
更新时间：2025-09-09 GMT+08:00
查看PDF
分享

查询实例列表和详情

功能介绍

根据指定条件查询数据库实例列表和详情。

接口约束

该接口支持如下数据库实例：

  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx
  • GeminiDB Redis

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v3/{project_id}/instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一region下的project ID。获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

id

否

String

参数解释：

实例ID。

约束限制：

如果id以“*”起始，表示按照“*”后面的值模糊匹配，否则，按照实际填写的id精确匹配查询。

取值范围：

不涉及。

默认取值：

不涉及。

name

否

String

参数解释：

实例名称。

约束限制：

如果name以“*”起始，表示按照“*”后面的值模糊匹配，否则，按照实际填写的name精确匹配查询。

说明：

如果实例名称中包含中文，暂时不支持通过中文模糊搜索。

取值范围：

不涉及。

默认取值：

不涉及。

datastore_type

否

String

参数解释：

数据库类型。

约束限制：

不涉及。

取值范围：

取值为“cassandra”，表示查询GeminiDB Cassandra数据库实例。

取值为“mongodb”，表示GeminiDB Mongo查询数据库实例。

取值为“influxdb”，表示查询GeminiDB Influx数据库实例。

取值为“redis”，表示查询GeminiDB Redis数据库实例。

默认取值：

如果不传该参数，表示查询所有数据库实例。

mode

否

String

参数解释：

实例类型。

约束限制：

不涉及。

取值范围：

  • 取值为“Cluster”，表示GeminiDB Cassandra、GeminiDB Influx、GeminiDB Redis 经典部署模式Proxy集群实例类型。

  • 取值为“CloudNativeCluster”，表示GeminiDB Cassandra、GeminiDB Influx、GeminiDB Redis云原生部署模式集群实例类型。

  • 取值为“RedisCluster”，表示GeminiDB Redis 经典部署模式Cluster集群实例类型。

  • 取值为“Replication”，表示GeminiDB Redis经典部署模式主备实例类型。

  • 取值为“InfluxdbSingle”，表示GeminiDB Influx经典部署模式单节点实例类型。
  • 取值为“EnhancedCluster”，表示GeminiDB Influx经典部署模式集群增强版实例类型。
  • 取值为“ReplicaSet”，表示GeminiDB Mongo副本集实例类型。
  • 如果不传datastore_type参数，自动忽略该参数设置。

默认取值：

不涉及。

vpc_id

否

String

参数解释：

虚拟私有云ID，获取方法如下：

  • 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。
  • 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询VPC列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

subnet_id

否

String

参数解释：

子网的网络ID，获取方法如下：

  • 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。
  • 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

offset

否

Integer

参数解释：

索引位置偏移量，表示从指定project ID下最新的实例创建时间开始，按时间的先后顺序偏移offset条数据后查询对应的实例信息。

约束限制：

不涉及。

取值范围：

取值大于或等于0。

默认取值：

不传该参数时，查询偏移量默认为0，表示从最新的实例创建时间对应的实例开始查询。

limit

否

Integer

参数解释：

查询实例个数上限值。

约束限制：

不涉及。

取值范围：

1~100。

默认取值：

不传该参数时，默认查询前100条实例信息。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

通过调用IAM服务获取用户Token接口获取。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

instances

Array of ListInstancesResult objects

参数解释：

实例信息。

total_count

Integer

参数解释：

总记录数。

取值范围：

不涉及。
表5 ListInstancesResult

参数

参数类型

描述

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云原生部署模式集群涉及此字段。

取值范围：

  • Standard：标准型。
  • 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

参数解释：

系统可维护时间窗。

取值范围：

不涉及。

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，只有数据库实例属于专属资源池才会返回该参数。

取值范围：

不涉及。

lb_ip_address

String

参数解释：

负载均衡IP。

约束限制：

只有存在负载均衡IP，才会返回该参数。

取值范围：

不涉及。

lb_port

String

参数解释：

负载均衡端口。

约束限制：

只有存在负载均衡ip，才会返回该参数。

取值范围：

不涉及。

availability_zone

String

参数解释：

实例可用区。

取值范围：

不涉及。

dual_active_info

DualActiveInfo object

参数解释：

双活信息。
表6 ListInstancesDatastoreResult

参数

参数类型

描述

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支持)。

取值范围：

不涉及。
表7 ListInstancesBackupStrategyResult

参数

参数类型

描述

start_time

String

参数解释：

备份时间段。自动备份将在该时间段内触发。当前时间指UTC时间。

取值范围：

不涉及。

keep_days

Integer

参数解释：

已生成备份文件可以保存的天数。

取值范围：

0~35。
表8 ListInstancesGroupResult

参数

参数类型

描述

id

String

参数解释：

组ID。

取值范围：

不涉及。

status

String

参数解释：

组状态。

取值范围：

  • normal：表示组正常。
  • abnormal：表示组异常。
  • creating：表示组创建中。
  • createfail：表示组创建失败。
  • deleted：表示组被删除。
  • resizefailed：表示组规格变更失败。
  • enlargefail：表示组扩容失败。

volume

Volume object

参数解释：

volume信息

nodes

Array of ListInstancesNodeResult objects

参数解释：

节点信息。
表9 Volume

参数

参数类型

描述

size

String

参数解释：

磁盘大小。单位：GB。

取值范围：

不涉及。

used

String

参数解释：

磁盘使用量。单位：GB。

取值范围：

不涉及。
表10 ListInstancesNodeResult

参数

参数类型

描述

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

参数解释：

资源规格编码。关于实例的规格信息，请参见查询数据库规格中响应参数“flavors.spec_code”的值。

取值范围：

不涉及。

availability_zone

String

参数解释：

可用区。

取值范围：

不涉及。

support_reduce

Boolean

参数解释：

是否支持节点缩容。

取值范围：

  • true，表示该节点支持节点缩容。
  • false，表示该节点不支持节点缩容。
表11 DualActiveInfo

参数

参数类型

描述

role

String

参数解释：

双活角色。

取值范围：

不涉及。

status

String

参数解释：

双活状态。

取值范围：

  • normal：表示双活状态正常。
  • abnormal：表示双活状态异常。

destination_instance_id

String

参数解释：

双活对端实例id。

取值范围：

不涉及。

destination_region

String

参数解释：

双活对端region。

取值范围：

不涉及。

请求示例

  • URI样例

    查询所有实例列表和详情

    GET https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances
  • URI样例

    根据指定条件查询实例列表和详情

    GET https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/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",
    "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" : "ReplicaSet",
      "version" : "4.0",
      "patch_available" : false
    },
    "engine" : "rocksDB",
    "created" : "2019-01-17T07:05:52",
    "updated" : "2019-01-17T07:05:47",
    "db_user_name" : "rwuser",
    "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
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理

相关文档