查询实例列表
功能介绍
根据指定条件查询实例列表。
URI
- URI格式
GET /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}
- 参数说明
表1 参数说明 名称
是否必选
参数类型
描述
project_id
是
String
租户在某一region下的project ID。
id
否
String
实例ID。
name
否
String
实例名称。
如果name以“*”起始，表示按照“*”后面的值模糊匹配，否则，按照实际填写的name精确匹配查询。
说明：“*”为系统保留字符，不能只传入该字符。
mode
否
String
实例类型。
- 取值为“Sharding”，表示集群实例。
- 取值为“ReplicaSet”，表示副本集实例。
datastore_type
否
String
数据库版本类型。取值为“DDS-Community”。
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条实例信息。
请求消息
- 请求头
根据指定条件查询实例列表：
GET https://DDS的Endpoint/v3/0483b6b16e954cb88930a360d2c4e663/instances?offset=0&limit=10&id=ed7cc6166ec24360a5ed5c5c9c2ed726in02&name=hy&mode=ReplicaSet&datastore_type=DDS-Community&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7
响应消息
- 要素说明
表2 要素说明 名称
参数类型
描述
instances
Array of objects
实例信息。详情请参见表3。
total_count
Integer
总记录数。
表3 instances字段数据结构说明 名称
参数类型
描述
id
String
实例ID。
name
String
实例名称。
status
String
实例状态。
取值：
- normal，表示实例正常。
- abnormal，表示实例异常。
- creating，表示实例创建中。
- data_disk_full，表示实例磁盘已满。
- createfail，表示实例创建失败。
- enlargefail，表示实例扩容节点个数失败。
port
Integer
数据库端口号。文档数据库实例支持的端口号范围为2100～9500。
mode
String
实例类型。与请求参数相同。
region
String
实例所在区域。
datastore
Object
数据库信息。详情请参见表4。
engine
String
存储引擎。取值为“wiredTiger”。
created
String
实例创建时间。
updated
String
实例操作最新变更的时间。
db_user_name
String
默认用户名。取值为“rwuser”。
ssl
Integer
是否开启SSL安全连接。
- 取值为“1”，表示开启。
- 取值为“0”，表示不开启。
vpc_id
String
虚拟私有云ID。
subnet_id
String
子网的网络ID。
security_group_id
String
安全组ID。
backup_strategy
Object
备份策略。详情请参见表5。
pay_mode
String
取值为“0”。
maintenance_window
String
系统可维护时间窗。
groups
Array of objects
组信息。详情请参见表6。
time_zone
String
时区。
actions
Array of strings
实例正在执行的动作。
表5 backup_strategy字段数据结构说明 名称
参数类型
描述
start_time
String
备份时间段。自动备份将在该时间段内触发。当前时间指UTC时间。
keep_days
Integer
已生成备份文件可以保存的天数。取值范围：0~732。
表6 groups字段数据结构说明 名称
参数类型
描述
type
String
节点类型。
取值：
- shard
- config
- mongos
- replica
id
String
组ID。节点类型为shard和config时，该参数有效。
name
String
组名称。节点类型为shard和config时，该参数有效。
status
String
组状态。节点类型为shard和config时，该参数有效。
volume
Object
volume信息。详情请参见表7。节点类型为shard、config、replica时，该参数有效。
nodes
Array of objects
节点信息。详情请参见表8。
表8 nodes字段数据结构说明 名称
参数类型
描述
id
String
节点ID。
name
String
节点名称。
status
String
节点状态。
role
String
节点角色。
取值：- master，mongos节点返回该值。
- Primary，shard组主节点、config组主节点、副本集主节点返回该值。
- Secondary，shard组备节点、config组备节点、副本集备节点返回该值。
- Hidden，shard组隐藏节点、config组隐藏节点、副本集隐藏节点返回该值。
- unknown，节点异常时返回该值。
private_ip
String
节点内网IP。该参数仅针对集群实例的mongos节点以及副本集实例有效，且在弹性云服务器创建成功后参数值存在，否则，值为""。
public_ip
String
绑定的外网IP。该参数仅针对集群实例的mongos节点、副本集实例的主节点和备节点有效。
spec_code
String
资源规格编码。关于实例的规格信息，请参见查询所有实例规格信息中响应参数“flavors.spec_code”的值。
availability_zone
String
可用区。
响应样例中参数“region”和“availability_zone”的值为示例值。
- 响应样例
查询所有实例列表：
{ "instances": [ { "id": "8436a91546294036b75931e879882200in02", "name": "dds-efa6", "status": "normal", "port": "8635", "mode": "ReplicaSet", "region": "aaa", "datastore": { "type": "DDS-Community", "version": "3.4" }, "engine": "wiredTiger", "created": "2019-01-17T07:05:52", "updated": "2019-01-17T07:05:47", "db_user_name": "rwuser", "ssl": "1", "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": [ { "type": "replica", "volume": { "size": "10", "used": "0.33" }, "nodes": [ { "id": "233eaac9c6f245c0bb9c2d21eea12d1bno02", "name": "dds-efa6_replica_node_2", "status": "normal", "role": "Primary", "private_ip": "192.168.0.174", "public_ip": "", "spec_code": "dds.s2.medium.4.shard", "availability_zone": "bbb" }, { "id": "d57d76d6320a4a7b86db82c317550c4ano02", "name": "dds-efa6_replica_node_1", "status": "normal", "role": "Hidden", "private_ip": "192.168.0.39", "public_ip": "", "spec_code": "dds.s2.medium.4.shard", "availability_zone": "bbb" }, { "id": "f46b0a1cf4d9400e9fd7af17f8742d37no02", "name": "dds-efa6_replica_node_3", "status": "normal", "role": "Secondary", "private_ip": "192.168.0.176", "public_ip": "", "spec_code": "dds.s2.medium.4.shard", "availability_zone": "bbb" } ] } ], "time_zone": "", "actions": [ "CREATE" ] }, { "id": "9136fd2a9fcd405ea4674276ce36dae8in02", "name": "dds-32f4", "status": "normal", "port": "8635", "mode": "Sharding", "region": "aaa", "datastore": { "type": "DDS-Community", "version": "3.4" }, "engine": "wiredTiger", "created": "2019-01-17T07:04:37", "updated": "2019-01-17T07:04:31", "db_user_name": "rwuser", "ssl": "1", "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": "19:00-20:00", "keep_days": 7 }, "pay_mode": "0", "maintenance_window": "02:00-06:00", "groups": [ { "type": "mongos", "nodes": [ { "id": "a742c13a284949adad177672e8a0f01cno02", "name": "dds-32f4_mongos_node_1", "status": "normal", "role": "master", "private_ip": "192.168.0.56", "public_ip": "", "spec_code": "dds.c3.medium.4.mongos", "availability_zone": "bbb" }, { "id": "d4f66666b1d64ab28719da0526341c7eno02", "name": "dds-32f4_mongos_node_2", "status": "normal", "role": "master", "private_ip": "192.168.0.185", "public_ip": "", "spec_code": "dds.c3.medium.4.mongos", "availability_zone": "bbb" } ] }, { "type": "shard", "id": "d1b92d2cbd544e85ac7ce6a7f33ba205gr02", "name": "shard_2", "status": "normal", "volume": { "size": "10", "used": "0.33" }, "nodes": [ { "id": "0e9abaebe5974b63a5b221de6ee34cfeno02", "name": "dds-32f4_shard_2_node_3", "status": "normal", "role": "Primary", "spec_code": "dds.c3.medium.4.shard", "availability_zone": "bbb" }, { "id": "1d7f4c5476c04cc187f920925c2b601fno02", "name": "dds-32f4_shard_2_node_2", "status": "normal", "role": "Hidden", "spec_code": "dds.c3.medium.4.shard", "availability_zone": "bbb" }, { "id": "3dd2cce03da54fc08f10651cbfea778dno02", "name": "dds-32f4_shard_2_node_1", "status": "normal", "role": "Secondary", "spec_code": "dds.c3.medium.4.shard", "availability_zone": "bbb" } ] }, { "type": "shard", "id": "06439baa35c146d3a8965af59d370908gr02", "name": "shard_1", "status": "normal", "volume": { "size": "10", "used": "0.33" }, "nodes": [ { "id": "0f6744d7e29f42ff80fc1a36cc145042no02", "name": "dds-32f4_shard_1_node_1", "status": "normal", "role": "Primary", "spec_code": "dds.c3.medium.4.shard", "availability_zone": "bbb" }, { "id": "3abcb399113b4512bd5a906da54e8753no02", "name": "dds-32f4_shard_1_node_3", "status": "normal", "role": "Hidden", "spec_code": "dds.c3.medium.4.shard", "availability_zone": "bbb" }, { "id": "c149f70563494501b5706cad225a8ebdno02", "name": "dds-32f4_shard_1_node_2", "status": "normal", "role": "Secondary", "spec_code": "dds.c3.medium.4.shard", "availability_zone": "bbb" } ] }, { "type": "config", "id": "84e7c96b82aa4fedb3b00f98edd71ba4gr02", "name": "config", "status": "normal", "volume": { "size": "20", "used": "0.33" }, "nodes": [ { "id": "7422f7331b714ac39aa647a1ec968d33no02", "name": "dds-32f4_config_node_2", "status": "normal", "role": "Primary", "spec_code": "dds.c3.large.2.config", "availability_zone": "bbb" }, { "id": "9e3b343151044eda91ddb8a42ae5cbefno02", "name": "dds-32f4_config_node_3", "status": "normal", "role": "Hidden", "spec_code": "dds.c3.large.2.config", "availability_zone": "bbb" }, { "id": "c0053ca460ac4889841ffb14a886ec54no02", "name": "dds-32f4_config_node_1", "status": "normal", "role": "Secondary", "spec_code": "dds.c3.large.2.config", "availability_zone": "bbb" } ] } ], "time_zone": "", "actions": [ "CREATE" ] } ], "total_count": }
状态码
详情请参见状态码。
错误码
详情请参见错误码。
