获取BEC虚机实例列表
更新时间：2023-08-17
接口描述
本接口用于获取BEC虚机实例列表。
请求结构
GET /v2/vm/instance?marker={marker}&maxKeys={maxKeys} HTTP/1.1
Host: bec.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| marker | 标记查询的起始位置 | query | 否 | string |
| maxKeys | 每页包含的最大数量，1-1000，默认1000 | query | 否 | integer |
| regionId | 按节点ID查询 | query | 否 | String |
| internalIp | 按内网IP查询 | query | 否 | String |
| vpcId | 按VPC ID查询 | query | 否 | String |
| imageId | 按镜像ID查询 | query | 否 | String |
| instanceIds | 多个实例ID，逗号分割 | query | 否 | String |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| instances | 虚机实例列表 | List<BecVmInstanceModel> |
| autoRenew | 是否自动续费 是：true 否：false | boolean |
| cardCount | GPU卡数量 | integer |
| cpuCount | CPU(Core)个数 | integer |
| createTime | 创建时间 | string |
| desc | 实例描述信息 | string |
| expireTime | 过期时间，后付费虚机无此字段 | string |
| gpuCard | GPU卡类型 | string |
| id | 实例ID | string |
| imageId | 镜像ID | string |
| imageType | 镜像类型 | string |
| internalIp | 内网IP | string |
| ipv6 | IPv6地址 | string |
| keypairId | 密钥对ID | string |
| keypairName | 密钥对名称 | string |
| memoryCapacityInGB | 内存容量，单位为GB | integer |
| name | 实例名称 | string |
| networkCapacityInMbps | 公网带宽，单位为Mbps | integer |
| paymentTiming | 付费方式 | string |
| publicIp | 外网IP | string |
| regionId | 节点ID | string |
| rootDiskSizeInGb | 系统盘容量，单位GB | integer |
| spec | 实例规格族 | string |
| status | 实例状态。Starting：启动中 Failed：启动失败 Running：运行中 Stopping：停止中 Stopped：已停止 Expired：已过期或欠费 Restarting：重启中 Reinstalling：重装系统中 Deleting：删除中 SnapshotProcessing：快照操作中 ImageProcessing：镜像操作中 Error：错误 |
string |
| subnetId | 子网ID | string |
| vpcId | VPC ID | string |
| isTruncated | true表示后面还有数据，false表示已经是最后一页 | boolean |
| marker | 标记查询的起始位置 | string |
| maxKeys | 每页包含的最大数量 | integer |
| nextMarker | 获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现 | string |
错误码
请参照错误返回章节的内容。
请求示例
GET /v2/vm/instance?maxKeys=10&marker= HTTP/1.1
Host: bec.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:28:11 GMT
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
Server: BWS
{
"marker": "",
"isTruncated": true,
"nextMarker": "vm-fumfe5ba-1-m-hangzhou-hbwey",
"maxKeys": 10,
"instances": [
{
"id": "vm-2gx5qgiy-1-m-hangzhou-ycq6a",
"createTime": "2022-02-15T08:31:25Z",
"name": "vm-2gx5qgiy-1-m-hangzhou-ycq6a",
"status": "FAILED",
"regionId": "cn-hangzhou-cm",
"paymentTiming": "Postpaid",
"internalIp": "172.16.8.78",
"publicIp": "112.xxx.xxx.xxx",
"ipv6": "",
"cpuCount": 1,
"memoryCapacityInGB": 2,
"rootDiskSizeInGb": 40,
"imageType": "bec",
"imageId": "m-kHYPoKjl",
"networkCapacityInMbps": 67,
"autoRenew": false
}
]
}