获取BEC虚机服务列表
更新时间:2020-07-10
获取BEC虚机服务列表
接口描述
获取BEC虚机服务列表
请求结构
GET /v1/vm/service?pageNo={pageNo}&pageSize={pageSize}&keywordType={keywordType}&keyword={keyword}&order={order}&orderBy={orderBy} HTTP/1.1
Host: bec.baidubce.com
Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
---|---|---|---|---|
pageNo | int | 否 | Query参数 | 第几页,默认值1,最小值1 |
pageSize | int | 否 | Query参数 | 每页个数,默认值1000,最小1,最大1000 |
keywordType | String | 否 | Query参数 | 查询实例的关键字类型,instanceId或serviceId,缺省为serviceId |
keyword | String | 否 | Query参数 | 查询实例的关键字 |
order | String | 否 | Query参数 | 排序,缺省为desc |
orderBy | String | 否 | Query参数 | 排序字段,缺省为createTime |
响应头域
除公共头域外,无其它特殊头域。
响应参数
参数名称 | 类型 | 描述 |
---|---|---|
result | List |
列表数据 |
orderBy | String | 排序字段 |
order | String | 排序顺序 |
pageNo | int | 第几页 |
pageSize | int | 每页个数 |
totalCount | int | 总数 |
错误码
请参照前文的统一错误码和平台错误码。
请求示例
GET /v1/vm/service?pageNo=1&pageSize=10&keyword=&keywordType=instanceId 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
{
"result":{
"order":"desc",
"orderBy":"createTime",
"orders":null,
"pageNo":1,
"pageSize":10,
"result":[
{
"bandwidth":null,
"createTime":"2020-06-12T08:11:06Z",
"deployInstances":[
{
"city":"CHENGDU",
"region":"SOUTH_WEST",
"replicas":1,
"serviceProvider":"CHINA_UNICOM"
}],
"osImage":{
"cpu":0,
"createTime":"2019-11-09T20:08:40Z",
"desc":"centos-7u1-x86_64-20191105103704",
"diskSize":0,
"ephemeralSize":0,
"fpgaType":"",
"id":"52262618-802b-4dda-baec-3efa2f90fes5",
"imageDescription":"centos-7u1-x86_64-20191105103704",
"imageId":"m-awDKsUms",
"imageType":"common",
"memory":0,
"minCpu":0,
"minDiskGb":20,
"minMem":1,
"name":"centos-7u1-x86_64-20191105103704",
"name_fri":null,
"osArch":"x86_64 (64bit)",
"osBuild":"2019110600",
"osLang":"ENG",
"osName":"CentOS",
"osType":"linux",
"osVersion":"7.1",
"shareToUserNumLimit":0,
"sharedToUserNum":0,
"snapshotId":"",
"status":"active"
},
"regions":1,
"runningInstances":1,
"serviceId":"s-lqrs2a7u",
"serviceName":"test",
"status":"RUNNING",
"totalCpu":4,
"totalDisk":0,
"totalInstances":1,
"totalMem":8,
"totalRootDisk":45
}],
"totalCount":1
},
"success":true
}
Model对象定义
VmServiceBriefVo
参数名称 | 类型 | 描述 |
---|---|---|
serviceId | String | 虚机服务ID |
serviceName | String | 虚机服务名称 |
status | String | 资源状态(STOP,RUNNING,PENDING,TERMINATING,FAILED,SUCCEEDED,UNKNOWN,TERMINATED,WAITING) |
totalCpu | float | cpu数量 |
totalMem | float | 内存数量 |
totalRootDisk | int | 系统盘数量 |
totalDisk | int | 数据盘数量 |
regions | int | 区域数量 |
deployInstances | List |
部署区域列表 |
totalInstances | int | 总实例数 |
runningInstances | int | 运行实例数 |
osImage | ImageDetail | 系统镜像详情 |
createTime | Date | 创建时间 |
ImageDetail
参数名称 | 类型 | 描述 |
---|---|---|
id | String | id |
imageId | String | imageId |
name | String | 镜像名称 |
imageType | String | 镜像类型 |
snapshotId | String | 快照id |
cpu | int | cpu数量 |
memory | int | 内存数量 |
osType | String | os类型 |
osVersion | String | os版本 |
osName | String | os名称 |
osBuild | String | os创建时间 |
osLang | String | os语言 |
diskSize | int | 磁盘大小 |
createTime | Date | 创建时间 |
minCpu | int | 最小cpu数量 |
minMem | int | 最小内存数量 |
minDiskGb | int | 最小磁盘数量 |
desc | String | 描述 |
osArch | String | osArch |
ephemeralSize | int | ephemeralSize |
imageDescription | String | 镜像描述 |
shareToUserNumLimit | int | 分享数量限制 |
sharedToUserNum | int | 分享数量 |
fpgaType | String | fpgaType |
name_fri | String | name_fri |
DeploymentInstance
参数名称 | 类型 | 描述 |
---|---|---|
region | Region | 区域 |
serviceProvider | ServiceProvider | 运营商 |
city | String | 城市 |
replicas | int | 副本数,最小为1 |