查询实例列表
更新时间：2024-10-29
该接口用于查询所有实例的详细信息。
注意事项：不同查询字段之间是and关系，同一查询字段传入的多个值之间是or关系。
请求结构
GET /v{version}/instance?marker={marker}&maxKeys={maxKeys}&internalIp={internalIp}&dedicatedHostId={dedicatedHostId}&zoneName={zoneName}&autoRenew={autoRenew} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: 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个 |
| instanceNames | String | 否 | Query参数 | 多个实例名称，英文逗号分割，最多支持100个 |
| 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 | 子网不存在 |
请求示例
GET /v2/instance?vpcId=vpc-vv3xw6d9970b&privateIps=192.168.48.3 HTTP/1.1
Host: bcc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"marker": "",
"isTruncated": false,
"maxKeys": 1000,
"instances": [
{
"id": "i-zadG8d4l",
"name": "instance-696snyc6",
"roleName": "",
"hostname": "instance-696snyc6",
"instanceType": "N6",
"spec": "bcc.g5.c1m4",
"status": "Running",
"desc": "",
"createdFrom": "customPurchase",
"paymentTiming": "Prepaid",
"createTime": "2022-10-11T06:11:42Z",
"expireTime": "2023-01-11T06:11:42Z",
"internalIp": "192.168.48.3",
"publicIp": "",
"cpuCount": 1,
"isomerismCard": "",
"cardCount": "0",
"npuVideoMemory": "",
"memoryCapacityInGB": 4,
"localDiskSizeInGB": 0,
"imageId": "m-zlaNc3qH",
"placementPolicy": "unknown",
"subnetId": "sbn-2escuever5fi",
"vpcId": "vpc-vv3xw6d9970b",
"zoneName": "cn-bj-a",
"dedicatedHostId": "",
"deletionProtection": 0,
"deploysetList": [],
"autoRenew": true,
"ipv6": "",
"resGroupInfos":[
{
"groupId":"RESG-jec9gimkKaY",
"groupName":"test2"
}
],
"nicInfo": {
"eniId": "eni-ramtd68yeyiq",
"eniUuid": "8ed449ff-b2ee-4491-b117-35fb731c4370",
"name": "eth0",
"type": "primary",
"subnetId": "sbn-2escuever5fi",
"subnetType": "BCC",
"az": "zoneA",
"description": "",
"deviceId": "608666b9-7156-4f47-8445-9c5497282573",
"status": "inuse",
"macAddress": "fa:f6:00:01:7e:ef",
"vpcId": "vpc-vv3xw6d9970b",
"createdTime": "Tue Oct 11 14:11:44 UTC 2022",
"eniNum": 1,
"eriNum": 0,
"eriInfos": [],
"ips": [
{
"privateIp": "192.168.48.3",
"eip": "null",
"primary": "true",
"eipId": "",
"eipAllocationId": "",
"eipSize": "0",
"eipStatus": "",
"eipGroupId": "",
"eipType": "null"
}
],
"securityGroups": []
},
"eniNum": "1",
"tags": [
{
"tagKey": "test2",
"tagValue": "bcc"
}
],
"networkCapacityInMbps": 0
}
]
}