查询实例列表
更新时间：2024-12-23
说明
- 查询所属于本账号的实例列表。
请求结构
Plain Text
1GET /v{version}/instance?dbInstanceType={dbInstanceType}&engineVersion={engineVersion}&storageEngine={storageEngine}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
2HOST: mongodb.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | string | 是 | URL参数 | API版本号 |
| marker | string | 否 | Query参数 | 批量获取列表的查询的起始位置。 |
| maxKeys | int | 否 | Query参数 | 每页包含的最大数量，最大数量通常不超过1000，缺省值为10。 |
| engineVersion | string | 否 | Query参数 | 数据库版本号。取值参考 |
| storageEngine | string | 否 | Query参数 | 存储引擎。取值参考 |
| dbInstanceType | string | 否 | Query参数 | 实例类型。取值参考 |
| ip | string | 否 | Query参数 | 内网访问IP。默认为空，表示不按ip筛选。 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| marker | String | 批量获取列表的查询的起始位置。 |
| maxKeys | int | 每页包含的最大数量。 |
| isTruncated | boolean | true表示后面还有数据，false表示已经是最后一页 |
| nextMarker | String | 获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现 |
| dbInstances | List DBInstanceModel | 实例列表。其中，NodeModel只包含nodeId、status、members；Member只包含ip、memberId、mongoHost、mongoStatus。节点的详细信息见于实例详情接口。 |
请求示例
Plain Text
1GET /v1/instance?marker=-1&maxKeys=10 HTTP/1.1
2HOST: mongodb.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
3Content-Type: application/json
4{
5 "marker": "-1",
6 "maxKeys": 10,
7 "isTruncated": false,
8 "dbInstances": [
9 {
10 "dbInstanceId": "m-soQKA7",
11 "connectionString": "mongodb://root:****@soQKA7bQs.bce.qa.sandbox.baidu.com:27017,soQKA7LFG.bce.qa.sandbox.baidu.com:27017/admin?replicaSet=rep-GCHhjz",
12 "dbInstanceName": "M4yui7",
13 "paymentTiming": "Postpaid",
14 "dbInstanceCpuCount": 1,
15 "dbInstanceMemoryCapacity": 2,
16 "dbInstanceStorage": 5,
17 "dbInstanceType": "replica",
18 "dbInstanceStatus": "RUNNING",
19 "createTime": "2020-03-16T02:30:41Z",
20 "shardCount": "0",
21 "engineVersion": "3.4",
22 "storageEngine": "WiredTiger",
23 "mongosCount": "0",
24 "votingMemberNum": 3,
25 "readonlyNodeNum": 0,
26 "vpcId": "vpc-ar6tyh9t2tz7",
27 "port": "27017",
28 "subnets": [
29 {
30 "zoneName": "cn-bj-a",
31 "subnetId": "sbn-rafwenxcnvh5"
32 }
33 ],
34 "tags": [
35 {
36 "tagKey": "默认项目",
37 "tagValue": "test-1"
38 }
39 ]
40 },
41 {
42 "dbInstanceId": "m-Hphyd0",
43 "dbInstanceName": "lZyAew",
44 "connectionString": "mongodb://root:****@Hphyd0Nce.mongodb.fwh.baidubce.com:27017,Hphyd0GH1.mongodb.fwh.baidubce.com:27017/admin",
45 "port": "27017",
46 "engineVersion": "3.6",
47 "storageEngine": "WiredTiger",
48 "dbInstanceCpuCount": 0,
49 "dbInstanceMemoryCapacity": 0,
50 "dbInstanceStorage": 0,
51 "dbInstanceType": "sharding",
52 "dbInstanceStatus": "RUNNING",
53 "mongosCount": "2",
54 "shardCount": "2",
55 "createTime": "2020-03-19T02:08:17Z",
56 "votingMemberNum": 0,
57 "readonlyNodeNum": 0,
58 "vpcId": "vpc-ar6tyh9t2tz7",
59 "paymentTiming": "Postpaid",
60 "subnets": [
61 {
62 "zoneName": "cn-bj-a",
63 "subnetId": "sbn-rafwenxcnvh5"
64 }
65 ],
66 "tags": []
67 }
68 ]
69}