5.5 实例管理
5.5.3 查询实例列表和详情
● 异常响应
请参见异常请求结果。
状态码
详情请参见状态码。
错误码
详情请参见错误码。
5.5.3 查询实例列表和详情
功能介绍
根据指定条件查询数据库实例列表和详情。
接口约束
该接口支持如下数据库实例：
● GaussDB(for Cassandra)
● GaussDB(for Mongo)副本集4.0
● GaussDB(for Influx)
● GaussDB(for Redis)
调试
您可以在API Explorer中调试该接口。
URI
● URI格式
GET https://{Endpoint}/v3/{project_id}/instances?
id={id}&name={name}&mode={mode}&datastore_type={datastore_type}&vpc_
id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit}
● URI样例
– 查询所有实例列表和详情
https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/
v3/0483b6b16e954cb88930a360d2c4e663/instances – 根据指定条件查询实例列表和详情
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-4a9
1-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7
● 参数说明
表5-25 参数说明
名称 是否
必选
参数类 型
描述
project_id 是 String 租户在某一region下的project ID。
id 否 String 实例ID。
如果id以“*”起始，表示按照“*”后面的值 模糊匹配，否则，按照实际填写的id精确匹配 查询。
name 否 String 实例名称。
如果name以“*”起始，表示按照“*”后面 的值模糊匹配，否则，按照实际填写的name 精确匹配查询。
说明
如果实例名称中包含中文，暂时不支持通过中文模 糊搜索。
datastore_t
ype 否 String 数据库类型。
取值为“cassandra”，表示查询GaussDB(for Cassandra)数据库实例。
取值为“mongodb”，表示查询GaussDB(for Mongo)数据库实例。
取值为“influxdb”，表示查询GaussDB(for Influx)数据库实例。
取值为“redis”，表示查询GaussDB(for Redis)数据库实例。
如果不传该参数，表示查询所有数据库实例。
名称 是否 必选
参数类 型
描述
mode 否 String 实例类型。
● 取值为“Cluster”，表示GaussDB(for Cassandra)、GaussDB(for Influx)、
GaussDB(for Redis)集群实例类型。
● 取值为“ReplicaSet”，表示GaussDB(for 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条实例信息。
请求消息
无。
响应消息
● 正常响应要素说明
表5-26 要素说明
名称 参数类型 描述
instances Array of objects 实例信息。详情请参见表5-27。
total_count Integer 总记录数。
表5-27 instances 字段数据结构说明
名称 参数类型 描述
id String 实例ID。
name String 实例名称。
status String 实例状态。
取值：
● normal，表示实例正常。
● abnormal，表示实例异常。
● creating，表示实例创建中。
● data_disk_full，表示实例磁盘 已满。
● createfail，表示实例创建失 败。
● enlargefail，表示实例扩容节 点个数失败。
port String 数据库端口。
mode String 实例类型。与请求参数相同。
region String 实例所在区域。
datastore Object 数据库信息。详情请参见表
5-28。
engine String 存储引擎。
取值为“rocksDB”。
created String 实例创建时间。
updated String 实例操作最新变更的时间。
db_user_name String 默认用户名。取值为“rwuser”。
vpc_id String 虚拟私有云ID。
subnet_id String 子网的网络ID。
security_group_id String 安全组ID。
backup_strategy Object 备份策略。详情请参见表5-29。
名称 参数类型 描述
pay_mode String 计费方式。
● 取值为“0”，表示按需计费。
● 取值为“1”，表示包年/包月 计费。
maintenance_win
dow String 系统可维护时间窗。
groups Array of objects 组信息。详情请参见表5-30。
enterprise_project
_id String 企业项目ID。
取值为“0”，表示为default企业 项目。
time_zone String 时区。
actions Array of strings 实例正在执行的动作。
dedicated_resourc
e_id String 专属资源ID，只有数据库实例属于
专属资源池才会返回该参数。
lb_ip_address String 负载均衡IP地址，只有存在负载均 衡IP地址才会返回该参数。
表5-28 datastore 字段数据结构说明
名称 参数类型 描述
type String 数据库类型。
version String 数据库版本。
表5-29 backup_strategy 字段数据结构说明
名称 参数类型 描述
start_time String 备份时间段。自动备份将在该时间段内触 发。当前时间指UTC时间。
keep_days Integer 已生成备份文件可以保存的天数。取值范 围：0~35。
表5-30 groups 字段数据结构说明
名称 参数类型 描述
id String 组ID。
名称 参数类型 描述
status String 组状态。
volume Object volume信息。详情请参见表5-31。
nodes Array of objects 节点信息。详情请参见表5-32。
表5-31 volume 字段数据结构说明
名称 参数类型 描述
size String 磁盘大小。单位：GB。
used String 磁盘使用量。单位：GB。
表5-32 nodes 字段数据结构说明
名称 参数类型 描述
id String 节点ID。
name String 节点名称。
status String 节点状态。
role String 节点角色。
该参数仅对GaussDB(for Mongo)引擎的 副本集实例有效。
private_ip String 节点内网IP。在弹性云服务器创建成功后 参数值存在，否则，值为""。
public_ip String 绑定的公网IP。该参数仅针对绑定了公网 IP的节点有效。
spec_code String 资源规格编码。
关于实例的规格信息，请参见查询数据库 规格中响应参数“flavors.spec_code”的 值。
availability_zon
e String 可用区。
support_reduce Boolean 是否支持节点缩容。
true，表示该节点支持节点缩容。
false，表示该节点不支持节点缩容。
说明
响应样例中参数“region”和“availability_zone”的值为示例值，具体取值请以实际环境 为准。
● 正常响应样例 { "instances": [ {
"id": "8436a91546294036b75931e879882200in06", "name": "nno-efa6",
"status": "normal", "port": "8635", "mode": "Cluster", "region": "aaa", "datastore": { "type": "cassandra", "version": "3.11"
},
"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": "100", "used": "0.003"
},
"nodes": [ {
"id": "233eaac9c6f245c0bb9c2d21eea12d1bno06", "name": "nosql-efa6_priam_node_2",
"status": "normal",
"private_ip": "192.168.0.174",
"spec_code": "geminidb.cassandra.xlarge.4", "availability_zone": "bbb"
}, {
"id": "d57d76d6320a4a7b86db82c317550c4ano02", "name": "nosql-efa6_priam_node_1",
"status": "normal",
"private_ip": "192.168.0.39",
"spec_code": "geminidb.cassandra.xlarge.4", "availability_zone": "bbb"
}, {
"id": "f46b0a1cf4d9400e9fd7af17f8742d37no02", "name": "nosql-efa6_prima_node_3",
"status": "normal",
"private_ip": "192.168.0.176",
"spec_code": "geminidb.cassandra.xlarge.4", "availability_zone": "bbb"
} ] } ],
"enterprise_project_id": "0", "time_zone": "",
"actions": [ "CREATE"
] }, {
"id": "1236a91546294036b75931e879882200in02", "name": "nosql-efa7",
"status": "normal", "port": "8635", "mode": "ReplicaSet", "region": "aaa", "datastore": { "type": "mongodb", "version": "4.0"
},
"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",
"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", "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",
"private_ip": "192.168.0.176",
"spec_code": "geminidb.mongodb.xlarge.4", "availability_zone": "bbb"
} ] } ],
"enterprise_project_id": "0", "time_zone": "",
"actions": [ ]
}
], "total_count": 2 }
● 异常响应
请参见异常请求结果。
状态码
详情请参见状态码。
错误码
详情请参见错误码。