查询实例列表
更新时间：2025-02-10
该接口用于查询所有实例的详细信息。
注意事项：不同查询字段之间是and关系，同一查询字段传入的多个值之间是or关系。
请求结构
Plain Text
1GET /v{version}/instance?marker={marker}&maxKeys={maxKeys}&internalIp={internalIp}&dedicatedHostId={dedicatedHostId}&zoneName={zoneName}&autoRenew={autoRenew} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| marker | String | 否 | Query参数 | 批量获取列表的查询的起始位置，是一个由系统生成的字符串 |
| maxKeys | int | 否 | Query参数 | 每页包含的最大数量，最大数量通常不超过1000，缺省值为1000 |
| internalIp | String | 否 | Query参数 | 内网IP |
| dedicatedHostId | String | 否 | Query参数 | 专属服务器ID |
| zoneName | String | 否 | Query参数 | 可用区信息 |
| instanceIds | String | 否 | Query参数 | 多个实例ID，英文逗号分割，最多支持100个 |
| volumeIds | String | 否 | Query参数 | 多个磁盘ID，英文逗号分割，最多支持100个 |
| instanceNames | String | 否 | Query参数 | 多个实例名称，英文逗号分割，精确搜索。最多支持100个 |
| fuzzyInstanceName | String | 否 | Query参数 | 实例的名称，支持关键字模糊查询。与instanceNames参数只能2选1，不能同时传值，否则报错。 |
| deploySetIds | String | 否 | Query参数 | 多个部署集ID，英文逗号分割，最多支持100个 |
| securityGroupIds | String | 否 | Query参数 | 多个安全组ID，英文逗号分割，最多支持100个 |
| paymentTiming | String | 否 | Query参数 | 支付方式（Prepaid / Postpaid） |
| status | String | 否 | Query参数 | 实例状态（Recycled / Running / Stopped / Stopping / Starting） |
| tags | String | 否 | Query参数 | 多个标签，逗号分割，格式：tagKey:tagValue 或 tagKey |
| vpcId | String | 否 | Query参数 | vpcId，只能与privateIps查询参数组合使用 |
| privateIps | String | 否 | Query参数 | 多个内网IP，英文逗号分隔，最多支持100个，必须和vpcId组合使用 |
| ehcClusterId | String | 否 | Query参数 | ehc集群id |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| marker | String | 标记查询的起始位置 |
| isTruncated | boolean | true表示后面还有数据，false表示已经是最后一页 |
| nextMarker | String | 获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现 |
| maxKeys | int | 每页包含的最大数量 |
| instances | List<InstanceModel> | 实例信息，由 InstanceModel 组成的集合 |
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| BadRequest | zone is invalid. | 400 | 无效的可用区 |
| NoSuchObject | subnet not exists. | 404 | 子网不存在 |
请求示例
Plain Text
1GET /v2/instance?vpcId=vpc-vv3xw6d9970b&privateIps=192.168.48.3 HTTP/1.1
2Host: bcc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{
8 "marker": "",
9 "isTruncated": false,
10 "maxKeys": 1000,
11 "instances": [
12 {
13 "id": "i-zadG8d4l",
14 "name": "instance-696snyc6",
15 "roleName": "",
16 "hostname": "instance-696snyc6",
17 "instanceType": "N6",
18 "spec": "bcc.g5.c1m4",
19 "status": "Running",
20 "desc": "",
21 "createdFrom": "customPurchase",
22 "paymentTiming": "Prepaid",
23 "createTime": "2022-10-11T06:11:42Z",
24 "expireTime": "2023-01-11T06:11:42Z",
25 "internalIp": "192.168.48.3",
26 "publicIp": "",
27 "cpuCount": 1,
28 "isomerismCard": "",
29 "cardCount": "0",
30 "npuVideoMemory": "",
31 "memoryCapacityInGB": 4,
32 "localDiskSizeInGB": 0,
33 "imageId": "m-zlaNc3qH",
34 "placementPolicy": "unknown",
35 "subnetId": "sbn-2escuever5fi",
36 "vpcId": "vpc-vv3xw6d9970b",
37 "zoneName": "cn-bj-a",
38 "dedicatedHostId": "",
39 "deletionProtection": 0,
40 "deploysetList": [],
41 "autoRenew": true,
42 "ipv6": "",
43 "resGroupInfos":[
44 {
45 "groupId":"RESG-jec9gimkKaY",
46 "groupName":"test2"
47 }
48 ],
49 "nicInfo": {
50 "eniId": "eni-ramtd68yeyiq",
51 "eniUuid": "8ed449ff-b2ee-4491-b117-35fb731c4370",
52 "name": "eth0",
53 "type": "primary",
54 "subnetId": "sbn-2escuever5fi",
55 "subnetType": "BCC",
56 "az": "zoneA",
57 "description": "",
58 "deviceId": "608666b9-7156-4f47-8445-9c5497282573",
59 "status": "inuse",
60 "macAddress": "fa:f6:00:01:7e:ef",
61 "vpcId": "vpc-vv3xw6d9970b",
62 "createdTime": "Tue Oct 11 14:11:44 UTC 2022",
63 "eniNum": 1,
64 "eriNum": 0,
65 "eriInfos": [],
66 "ips": [
67 {
68 "privateIp": "192.168.48.3",
69 "eip": "null",
70 "primary": "true",
71 "eipId": "",
72 "eipAllocationId": "",
73 "eipSize": "0",
74 "eipStatus": "",
75 "eipGroupId": "",
76 "eipType": "null"
77 }
78 ],
79 "securityGroups": []
80 },
81 "eniNum": "1",
82 "tags": [
83 {
84 "tagKey": "test2",
85 "tagValue": "bcc"
86 }
87 ],
88 "networkCapacityInMbps": 0
89 }
90 ]
91}