文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 实例管理/ 查询实例列表和详情

更新时间：2024-05-10 GMT+08:00

查看PDF

查询实例列表和详情

功能介绍

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

接口约束

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

GeminiDB Cassandra
GeminiDB Mongo
GeminiDB Influx
GeminiDB Redis

调试

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

URI

GET https://{Endpoint}/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集群实例类型。取值为“InfluxdbSingle”，表示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。

响应参数

状态码： 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	实例类型。与请求参数相同。
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	可用区。

表6 ListInstancesDatastoreResult
参数	参数类型	描述
type	String	数据库接口。
version	String	数据库版本号。
patch_available	Boolean	当前实例是否有可升级的补丁，返回true时可以通过“数据库补丁升级”进行升级。
whole_version	String	数据库的完整版本号(目前只有GeminiDB Cassandra支持)。

表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，表示该节点不支持节点缩容。

请求示例

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
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理

上一篇：删除实例

下一篇：扩容实例存储容量

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

查询实例列表和详情

功能介绍

接口约束

调试

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线