查询实例列表和详情-凯发k8国际娱乐官网入口
功能介绍
根据指定条件查询数据库实例列表和详情。
接口约束
该接口支持如下数据库实例:
- geminidb cassandra
- geminidb mongo
- geminidb influx
- geminidb redis
调试
您可以在中调试该接口,支持自动认证鉴权。api explorer可以自动生成sdk代码示例,并提供sdk代码示例调试功能。
uri
get https://{endpoint}/v3/{project_id}/instances
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
string |
租户在某一region下的project id。获取方法请参见。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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,获取方法如下:
|
subnet_id |
否 |
string |
子网的网络id,获取方法如下:
|
offset |
否 |
integer |
索引位置偏移量,表示从指定project id下最新的实例创建时间开始,按时间的先后顺序偏移offset条数据后查询对应的实例信息。 取值大于或等于0。不传该参数时,查询偏移量默认为0,表示从最新的实例创建时间对应的实例开始查询。 |
limit |
否 |
integer |
查询实例个数上限值。 取值范围:1~100。不传该参数时,默认查询前100条实例信息。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
x-auth-token |
是 |
string |
用户token。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
instances |
array of listinstancesresult objects |
实例信息。 |
total_count |
integer |
总记录数。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
string |
实例id。 |
name |
string |
实例名称。 |
status |
string |
实例状态。 取值:
|
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 |
备份策略。 |
|
pay_mode |
string |
计费方式。
|
maintenance_window |
string |
系统可维护时间窗。 |
groups |
array of listinstancesgroupresult objects |
组信息。 |
enterprise_project_id |
string |
企业项目id。 取值为“0”,表示为default企业项目。 |
time_zone |
string |
时区。 |
actions |
array of strings |
实例正在执行的动作。示例:
|
dedicated_resource_id |
string |
专属资源id,只有数据库实例属于专属资源池才会返回该参数。 |
lb_ip_address |
string |
负载均衡ip,只有存在负载均衡ip,才会返回该参数。 |
lb_port |
string |
负载均衡端口,只有存在负载均衡ip,才会返回该参数。 |
参数 |
参数类型 |
描述 |
---|---|---|
type |
string |
数据库接口。 |
version |
string |
数据库版本号。 |
patch_available |
boolean |
当前实例是否有可升级的补丁,返回true时可以通过“数据库补丁升级”进行升级。 |
whole_version |
string |
数据库的完整版本号(目前只有geminidb cassandra支持)。 |
参数 |
参数类型 |
描述 |
---|---|---|
start_time |
string |
备份时间段。自动备份将在该时间段内触发。当前时间指utc时间。 |
keep_days |
integer |
已生成备份文件可以保存的天数。取值范围:0~35。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
string |
组id。 |
status |
string |
组状态。 取值:
|
volume |
volume object |
volume信息 |
nodes |
array of listinstancesnoderesult objects |
节点信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
size |
string |
磁盘大小。单位:gb。 |
used |
string |
磁盘使用量。单位:gb。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
string |
节点id。 |
name |
string |
节点名称。 |
status |
string |
节点状态。 取值:
|
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 |
是否支持节点缩容。
|
请求示例
- 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", "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", "time_zone" : "", "actions" : [ ] } ], "total_count" : 2 }
状态码
请参见。
错误码
请参见。
意见反馈
文档内容是否对您有帮助?
如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨