查询数据库实例列表-凯发k8国际娱乐官网入口
功能介绍
根据指定条件查询实例列表。
- 调用接口前,您需要了解api 。
- 调用接口前,您需要提前获取到,即下文中的endpoint值。
调试
您可以在中调试该接口。
uri
- uri格式
get https://{endpoint}/v3/{project_id}/instances?id={id}&name={name}&type={type}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit}
- uri样例
- 查询所有实例列表
https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances
- 根据指定条件查询实例列表
https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in14&name=hy&type=enterprise&datastore_type=gaussdb&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10
- 查询所有实例列表
- 参数说明
表1 参数说明 名称
参数类型
是否必选
说明
project_id
string
是
租户在某一region下的project id。
获取方法请参见。
id
string
否
实例id。
“*”为系统保留字符,如果id是以“*”起始,表示按照*后面的值模糊匹配,否则,按照id精确匹配查询。不能只传入“*”。
name
string
否
实例名称。
“*”为系统保留字符,如果name是以“*”起始,表示按照*后面的值模糊匹配,否则,按照name精确匹配查询。不能只传入“*”。
type
string
否
按照实例类型查询。目前支持取值如下:
- enterprise(区分大小写),对应分布式实例(独立部署)。
- centralization_standard(区分大小写),对应主备版实例。
datastore_type
string
否
数据库类型,不区分大小写。
gaussdb
vpc_id
string
否
虚拟私有云id,获取方法如下:。
- 方法1:登录虚拟私有云服务的控制台界面,在虚拟私有云的详情页面查找vpc id。
- 方法2:通过虚拟私有云服务的api接口查询,具体操作可参考。
subnet_id
string
否
子网的网络id信息。
- 方法1:登录虚拟私有云服务的控制台界面,单击vpc下的子网,进入子网详情页面,查找网络id。
- 方法2:通过虚拟私有云服务的api接口查询,具体操作可参考。
offset
integer
否
索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。
limit
integer
否
查询记录数。默认为100,不能为负数,最小值为1,最大值为100。
tags
string
否
根据实例标签键值对进行查询。
- {key}表示标签键,最大长度127个unicode字符。key不能为空或者空字符串,不能为空格,使用之前先trim前后半角空格。不能包含 /?#&=,%特殊字符。
- {value}表示标签值,可以为空。最大长度255个unicode字符,使用之前先trim 前后半角空格。不能包含 /?#&=,%特殊字符。如果value为空,则表示any_value(查询任意value)。
如果同时使用多个标签键值对进行查询,中间使用逗号分隔开,最多包含20组。
请求消息
无。
响应消息
- 正常响应要素说明
表2 参数说明 名称
参数类型
说明
instances
array of objects
实例信息。
详情请参见表3。
total_count
integer
总记录数。
表3 instances字段数据结构说明 名称
参数类型
说明
id
string
实例id。
name
string
创建的实例名称。
status
string
实例状态。
取值:
值为“build”,表示实例正在创建。
值为“active”,表示实例正常。
值为“failed”,表示实例异常。
值为“frozen”,表示实例冻结。
值为“modifying”,表示实例正在扩容磁盘或者变更规格。
值为“expanding”,表示实例正在添加只读节点或扩容cn或dn。
值为“rebooting”,表示实例正在重启。
值为“reducing”, 表示实例正在删除只读节点。
值为“upgrading”,表示实例正在升级。
值为“restoring”,表示实例正在恢复。
值为“switchover”,表示实例正在主备切换。
值为“migrating”,表示实例正在迁移。
值为“backing up”,表示实例正在进行备份。
值为“upgrade to be observed”,表示实例正在进行升级待观察。
值为“reducing replication”,表示实例正在降副本。
值为“storage full”,表示实例磁盘空间满。
private_ips
list
实例内网ip地址列表。分布式cn所在的弹性云服务器创建成功后该值存在,主备版dn所在的弹性云服务器创建成功后该值存在,其他情况下为空字符串。
public_ips
list
实例外网ip地址列表。绑定弹性公网ip后,该值不为空。
port
integer
数据库端口号。gaussdb数据库端口设置范围为1024~39998(其中2378,2379,2380,4999,5000,5999,6000,6001,8097,8098,20049,20050,21731,21732被系统占用不可设置)。
type
string
实例类型,取值为 "enterprise",对应于分布式实例(企业版)。取值为"centralization_standard",对应于主备版实例。区分大小写。
ha
object
实例的高可用参数。
详情请参见表4。
replica_num
integer
实例副本数。
region
string
实例所在区域。
datastore
object
数据库信息。
详情请参见表5。
created
string
创建时间,格式为“yyyy-mm-dd hh:mm:ss timezone”。
其中timezone是指时区。
说明:创建时该值为实例下发创建的时间,创建完成后,该值为创建完成时间。
updated
string
更新时间,格式与“created”字段对应格式完全相同。
说明:创建时返回值为空,数据库实例创建成功后该值不为空。
db_user_name
string
默认用户名。
vpc_id
string
虚拟私有云id。
subnet_id
string
子网的网络id信息。
security_group_id
string
安全组id。
flavor_ref
string
规格码。参考中gaussdb的“规格编码”列内容获取。
flavor_info
object
规格信息。
详情请参见表6
volume
object
volume信息。
详情请参见表7。
switch_strategy
string
数据库切换策略。
取值为“reliability”或“availability”,分别对应于可靠性优先和可用性优先。
若创建时没有选择切换策略,则不予显示。
backup_strategy
object
备份策略。
详情请参见表8。
maintenance_window
string
可维护时间窗,为utc时间。
nodes
array of objects
实例节点信息。
详情请参见表9。
disk_encryption_id
string
磁盘加密密钥id。只有创建磁盘加密实例才会显示该参数。
enterprise_project_id
string
企业项目标签id。非企业项目帐号的实例,企业项目默认0。
instance_mode
string
enterprise代表数据库版本为企业版,standard为标准版,basic为基础版 。
time_zone
string
时区。
charge_info
object
计费类型信息,支持按需和包周期。
详情请参见表10。
tags
array of objects
标签列表,没有标签不返回该参数。
详情请参见表11。
表4 ha字段数据结构说明 名称
参数类型
说明
consistency
string
事务一致性类型。取值为“strong”、“eventual”,分别表示强一致性、最终一致性。
replication_mode
string
备机同步参数。
取值:非空。
gaussdb为 “sync”
说明:“sync”为同步模式。
表5 datastore字段数据结构说明 名称
参数类型
说明
type
string
数据库引擎。
version
string
数据库版本。
表6 flavor_info字段数据结构说明 名称
参数类型
说明
vcpu
integer
cpu核数。
mem
integer
内存大小,单位gb。
表7 volume字段数据结构说明 名称
参数类型
说明
type
string
磁盘类型。
size
integer
磁盘大小。
表8 backup_strategy字段数据结构说明 名称
参数类型
说明
start_time
string
备份时间段。自动备份将在该时间段内触发。
当前时间指utc时间。
keep_days
integer
已生成的备份文件可以保存的天数。
取值范围:1~732。
表9 nodes字段数据结构说明 名称
参数类型
说明
id
string
节点id。
name
string
节点名称。
role
string
节点类型,取值为“master”、“slave”,分别对应于主节点、备节点。
status
string
节点状态。
availability_zone
string
可用区。
private_ip
string
节点内网ip。分布式实例类型下该参数仅针对cn节点有效,主备版实例类型下该参数对所有节点有效,且在弹性云服务器创建成功后参数值存在。
public_ip
string
绑定的公网ip。分布式实例类型下该参数仅针对cn节点有效,主备版实例类型下该参数对所有节点有效,且在弹性云服务器创建成功并绑定弹性公网ip后参数值存在。
表10 chargeinfo字段数据结构说明 名称
是否必选
参数类型
说明
charge_mode
是
string
计费模式。
postpaid:后付费,即按需付费。
prepaid:预付费,即包年/包月。
表11 tags字段数据结构说明 名称
参数类型
说明
key
string
标签键。
value
string
标签值。
- 正常响应样例
实例列表:
{ "instances": [ { "id": "b331ed66cc3249f78bc20737308c01f4in14", "status": "active", "name": "gauss-9e88", "port": 8000, "type": "enterprise", "ha": { "consistency": "strong", "replication_mode": "sync" }, "region": "eu-de", "region": "aaa", "datastore": { "type": "gaussdb", "version": "1.3" }, "created": "2021-01-15 01:46:40 utc", "updated": "2021-01-15 02:05:03 utc", "volume": { "type": "ultrahigh", "size": 120 }, "nodes": [ { "id": "02ebf757aaf94074855f49cc6e0e4712no14", "name": "gauss-9e88_gaussdbv5cn_2", "role": "master", "status": "active", "availability_zone": "az2xahz", "private_ip": "192.168.16.253" }, { "id": "0a87b8ecbfeb46aba1409cfc0f0d5c34no14", "name": "gauss-9e88_gaussdbv5cn_0", "role": "master", "status": "active", "availability_zone": "az2xahz", "private_ip": "192.168.28.81" }, { "id": "2d9fec1ab3834936b074d63acf48b1f2no14", "name": "gauss-9e88_gaussdbv5dn3_2", "role": "master", "status": "active", "availability_zone": "az2xahz" }, { "id": "48bb08a2d635435891ac0caa1c0bf2e3no14", "name": "gauss-9e88_gaussdbv5dn1_0", "role": "master", "status": "active", "availability_zone": "az2xahz" }, { "id": "5df830f652204827ada32f8bc28b107eno14", "name": "gauss-9e88_gaussdbv5dn1_1", "role": "slave", "status": "active", "availability_zone": "az2xahz" }, { "id": "8a97a246cee841b38c5b47290d4c9c38no14", "name": "gauss-9e88_gaussdbv5cn_1", "role": "master", "status": "active", "availability_zone": "az2xahz", "private_ip": "192.168.27.52" }, { "id": "8c1a3f8eecca4d9e9974a868bb6dd942no14", "name": "gauss-9e88_gaussdbv5dn2_0", "role": "master", "status": "active", "availability_zone": "az2xahz" }, { "id": "9bd0c80b8a684cc9bd7d99dd5adffb07no14", "name": "gauss-9e88_gaussdbv5dn3_1", "role": "slave", "status": "active", "availability_zone": "az2xahz" }, { "id": "9e2a3cd541e249d4af5aa57c5d3a7f39no14", "name": "gauss-9e88_gaussdbv5dn1_2", "role": "slave", "status": "active", "availability_zone": "az2xahz" }, { "id": "b046d28989ec4ae5a1a9ab20fe65f248no14", "name": "gauss-9e88_gaussdbv5dn2_2", "role": "slave", "status": "active", "availability_zone": "az2xahz" }, { "id": "b614cc12fd3742dbb230245f88a7bf00no14", "name": "gauss-9e88_gaussdbv5dn3_0", "role": "slave", "status": "active", "availability_zone": "az2xahz" }, { "id": "caba8e88c3c84ae58202f1f589490611no14", "name": "gauss-9e88_gaussdbv5dn2_1", "role": "slave", "status": "active", "availability_zone": "az2xahz" } ], "private_ips": [ "192.168.16.253 / 192.168.28.81 / 192.168.27.52" ], "replica_num": 3, "db_user_name": "root", "vpc_id": "5f84a5c4-2f93-41de-8359-d7acedb585cc", "subnet_id": "300036af-a92f-4e9e-8e9f-7d20e7878b05", "security_group_id": "2dcfd40a-8f32-46b8-8a47-6cfab5eba163", "flavor_ref": "gaussdb.opengauss.ee.dn.m6.large.8.in", "flavor_info": { "vcpu": 2, "mem": 16 }, "switch_strategy": "reliability", "charge_info": { "charge_mode": "prepaid" }, "backup_strategy": { "start_time": "19:00-20:00", "keep_days": 7 }, "maintenance_window": "18:00-22:00", "disk_encryption_id": "24ae42b5-4009-4ea2-b66a-0b211e424dab", "enterprise_project_id": "6e76681b-a2f5-4c5f-97c5-ba4fd3c0dfb2", "time_zone": "utc 08:00", "instance_mode":"enterprise" }, { "id": "226b4afcfcc84c86bf1b9cb345d3b00fin14", "status": "active", "name": "uts-gauss-ad53-2c3d", "port": 8000, "type": "enterprise", "ha": { "consistency": "strong", "replication_mode": "sync" }, "region": "cn-xianhz-1", "datastore": { "type": "gaussdb", "version": "1.3" }, "created": "2021-01-08 09:18:27 utc", "updated": "2021-01-14 13:25:03 utc", "volume": { "type": "ultrahigh", "size": 120 }, "nodes": [ { "id": "07538a1def584cee99e2a5685eeab36ano14", "name": "uts-gauss-ad53-2c3d_gaussdbv5dn3_1", "role": "slave", "status": "active", "availability_zone": "az2xahz" }, { "id": "21f41baba1e2454f82331b7cb5aeabe5no14", "name": "uts-gauss-ad53-2c3d_gaussdbv5dn1_2", "role": "master", "status": "active", "availability_zone": "az2xahz" }, { "id": "2909771a3b3e4e3998f9388e77d22391no14", "name": "uts-gauss-ad53-2c3d_gaussdbv5dn1_0", "role": "slave", "status": "active", "availability_zone": "az2xahz" }, { "id": "2bd9a90a5da242a6b0743a7f597f6106no14", "name": "uts-gauss-ad53-2c3d_gaussdbv5dn2_2", "role": "master", "status": "active", "availability_zone": "az2xahz" }, { "id": "77092f1dadb74d3ea13d28269cdd3590no14", "name": "uts-gauss-ad53-2c3d_gaussdbv5dn3_2", "role": "master", "status": "active", "availability_zone": "az2xahz" }, { "id": "a46bfaa6d5a24355a60fce7432b964cano14", "name": "uts-gauss-ad53-2c3d_gaussdbv5dn3_0", "role": "slave", "status": "active", "availability_zone": "az2xahz" }, { "id": "aa5277736f3844e2a7adeb9de529e2b1no14", "name": "uts-gauss-ad53-2c3d_gaussdbv5dn2_1", "role": "slave", "status": "active", "availability_zone": "az2xahz" }, { "id": "b1d798e4ea7344dfa95032984bc6cfd7no14", "name": "uts-gauss-ad53-2c3d_gaussdbv5cn_1", "role": "master", "status": "active", "availability_zone": "az2xahz", "private_ip": "192.168.29.231" }, { "id": "b9a46540186f4c0781eabaa2a79594cbno14", "name": "uts-gauss-ad53-2c3d_gaussdbv5dn1_1", "role": "slave", "status": "active", "availability_zone": "az2xahz" }, { "id": "d283813030364060ab64371d50294977no14", "name": "uts-gauss-ad53-2c3d_gaussdbv5dn2_0", "role": "slave", "status": "active", "availability_zone": "az2xahz" }, { "id": "eb7bce29b2284cd290405eaddc1b1a1eno14", "name": "uts-gauss-ad53-2c3d_gaussdbv5cn_0", "role": "master", "status": "failed", "availability_zone": "az2xahz", "private_ip": "192.168.30.44", "public_ip": "10.154.217.248" } ], "private_ips": [ "192.168.29.231 / 192.168.30.44" ], "public_ips": [ "10.154.217.248" ], "replica_num": 3, "db_user_name": "root", "vpc_id": "5f84a5c4-2f93-41de-8359-d7acedb585cc", "subnet_id": "300036af-a92f-4e9e-8e9f-7d20e7878b05", "security_group_id": "2dcfd40a-8f32-46b8-8a47-6cfab5eba163", "flavor_ref": "gaussdb.opengauss.ee.dn.m6.large.8.in", "flavor_info": { "vcpu": 2, "mem": 16 }, "switch_strategy": "reliability", "charge_info": { "charge_mode": "prepaid" }, "backup_strategy": { "start_time": "18:00-19:00", "keep_days": 7 }, "maintenance_window": "18:00-22:00", "enterprise_project_id": "0", "time_zone": "utc 08:00", "instance_mode":"enterprise" }, { "id": "706c65c3dd7d497ab16f5b3a113690abin14", "status": "active", "name": "uts-gauss-7362", "port": 8000, "type": "enterprise", "ha": { "consistency": "strong", "replication_mode": "sync" }, "region": "cn-xianhz-1", "datastore": { "type": "gaussdb", "version": "1.2" }, "created": "2020-12-23 03:21:41 utc", "updated": "2021-01-15 02:32:13 utc", "volume": { "type": "ultrahigh", "size": 80 }, "nodes": [ { "id": "25b7f16ee4084b7884d52f1bdfab4e68no14", "name": "uts-gauss-7362_gaussdbv5dn1_2", "role": "master", "status": "active", "availability_zone": "az2xahz" }, { "id": "ad6f02f31744422fa8ce487e81c9e7afno14", "name": "uts-gauss-7362_gaussdbv5cn_0", "role": "master", "status": "active", "availability_zone": "az2xahz", "private_ip": "192.168.26.70" }, { "id": "b30c56582bf44a548e3bb5b5af6c4773no14", "name": "uts-gauss-7362_gaussdbv5dn1_1", "role": "slave", "status": "active", "availability_zone": "az2xahz" }, { "id": "f79ea0600cba42b2888bd9bd67e52a79no14", "name": "uts-gauss-7362_gaussdbv5dn1_0", "role": "slave", "status": "active", "availability_zone": "az2xahz" } ], "private_ips": [ "192.168.26.70" ], "db_user_name": "root", "vpc_id": "5f84a5c4-2f93-41de-8359-d7acedb585cc", "subnet_id": "300036af-a92f-4e9e-8e9f-7d20e7878b05", "security_group_id": "2dcfd40a-8f32-46b8-8a47-6cfab5eba163", "flavor_ref": "gaussdb.opengauss.ee.dn.m6.large.8.in", "flavor_info": { "vcpu": 2, "mem": 16 }, "switch_strategy": "reliability", "charge_info": { "charge_mode": "postpaid" }, "backup_strategy": { "start_time": "16:00-17:00", "keep_days": 7 }, "maintenance_window": "18:00-22:00", "enterprise_project_id": "0", "time_zone": "utc 08:00", "instance_mode":"enterprise" }, { "id": "4ad42d079a3948d88c28d6236211b21ein14", "status": "active", "name": "uts-gauss-4336", "port": 8000, "type": "enterprise", "ha": { "consistency": "strong", "replication_mode": "sync" }, "region": "cn-xianhz-1", "datastore": { "type": "gaussdb", "version": "1.2" }, "created": "2020-12-03 14:28:53 utc", "updated": "2021-01-14 13:20:10 utc", "volume": { "type": "ultrahigh", "size": 40 }, "nodes": [ { "id": "254dbda6f03643519ad64b39481bd11cno14", "name": "uts-gauss-4336_gaussdbv5dn1_2", "role": "master", "status": "active", "availability_zone": "az1xahz" }, { "id": "6ad76d4db26443c2a93b280739a31558no14", "name": "uts-gauss-4336_gaussdbv5dn1_1", "role": "slave", "status": "active", "availability_zone": "az1xahz" }, { "id": "9fdebf821bdf444a8689b19c0ff588ceno14", "name": "uts-gauss-4336_gaussdbv5cn_0", "role": "master", "status": "failed", "availability_zone": "az1xahz", "private_ip": "192.168.30.93" }, { "id": "dd64bdbc02a542d88823b1582f772d25no14", "name": "uts-gauss-4336_gaussdbv5cn_1", "role": "master", "status": "active", "availability_zone": "az1xahz", "private_ip": "192.168.29.232" }, { "id": "de3c41461045466faf6c2b96eb709540no14", "name": "uts-gauss-4336_gaussdbv5dn1_0", "role": "slave", "status": "active", "availability_zone": "az1xahz" } ], "private_ips": [ "192.168.30.93 / 192.168.29.232" ], "db_user_name": "root", "vpc_id": "5f84a5c4-2f93-41de-8359-d7acedb585cc", "subnet_id": "300036af-a92f-4e9e-8e9f-7d20e7878b05", "security_group_id": "2dcfd40a-8f32-46b8-8a47-6cfab5eba163", "flavor_ref": "gaussdb.opengauss.ee.dn.m6.large.8.in", "flavor_info": { "vcpu": 2, "mem": 16 }, "switch_strategy": "reliability", "charge_info": { "charge_mode": "postpaid" }, "backup_strategy": { "start_time": "18:00-19:00", "keep_days": 7 }, "maintenance_window": "18:00-22:00", "enterprise_project_id": "0", "time_zone": "utc 08:00", "instance_mode":"enterprise" } ], "total_count": 4 }
- 实例详情:
{ "instances": [ { "id": "706c65c3dd7d497ab16f5b3a113690abin14", "status": "active", "name": "uts-gauss-7362", "port": 8000, "type": "enterprise", "ha": { "consistency": "strong", "replication_mode": "sync" }, "region": "aaa", "datastore": { "type": "gaussdb", "version": "1.4" }, "created": "2020-12-23 03:21:41 utc", "updated": "2021-01-15 02:32:13 utc", "volume": { "type": "ultrahigh", "size": 80 }, "nodes": [ { "id": "25b7f16ee4084b7884d52f1bdfab4e68no14", "name": "uts-gauss-7362_gaussdbv5dn1_2", "role": "master", "status": "active", "region": "bbb", }, { "id": "ad6f02f31744422fa8ce487e81c9e7afno14", "name": "uts-gauss-7362_gaussdbv5cn_0", "role": "master", "status": "active", "region": "bbb", "private_ip": "192.168.26.70" }, { "id": "b30c56582bf44a548e3bb5b5af6c4773no14", "name": "uts-gauss-7362_gaussdbv5dn1_1", "role": "slave", "status": "active", "region": "bbb", }, { "id": "f79ea0600cba42b2888bd9bd67e52a79no14", "name": "uts-gauss-7362_gaussdbv5dn1_0", "role": "slave", "status": "active", "region": "bbb", } ], "private_ips": [ "192.168.26.70" ], "db_user_name": "root", "vpc_id": "5f84a5c4-2f93-41de-8359-d7acedb585cc", "subnet_id": "300036af-a92f-4e9e-8e9f-7d20e7878b05", "security_group_id": "2dcfd40a-8f32-46b8-8a47-6cfab5eba163", "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in", "flavor_info": { "vcpu": 8, "mem": 64 }, "switch_strategy": "reliability", "charge_info": { "charge_mode": "postpaid" }, "backup_strategy": { "start_time": "16:00-17:00", "keep_days": 7 }, "maintenance_window": "18:00-22:00", "enterprise_project_id": "0", "time_zone": "utc 08:00", "instance_mode":"enterprise" } ], "total_count": 1 }
- 异常响应
请参见。
状态码
- 正常
200
- 异常
请参见。
错误码
请参见。
意见反馈
文档内容是否对您有帮助?
如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨