获取BEC虚机服务列表
更新时间：2025-08-05
接口描述
本接口用于获取BEC虚机服务列表。
请求结构
Plain Text
1GET /v1/vm/service?pageNo={pageNo}&pageSize={pageSize}&keywordType={keywordType}&keyword={keyword}&order={order}&orderBy={orderBy} HTTP/1.1
2Host: bec.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| pageNo | Integer | 否 | Query参数 | 页数，缺省值为1 |
| pageSize | Integer | 否 | Query参数 | 每页个数，取值范围为1～1000，缺省值为1000 |
| keywordType | String | 否 | Query参数 | 查询实例的关键字类型，取值为serviceId、serviceName，分别对应服务ID、服务名字。默认为serviceId |
| keyword | String | 否 | Query参数 | 查询实例的关键字 |
| order | String | 否 | Query参数 | 排序，取值为DESC、ASC，分别表示为降序、升序。缺省为DESC |
| orderBy | String | 否 | Query参数 | 排序字段，缺省为createTime |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| result | List<VmServiceBriefVo> | 列表数据 |
| orderBy | String | 排序字段 |
| order | String | 排序顺序 |
| pageNo | Integer | 页码 |
| pageSize | Integer | 每页结果数 |
| totalCount | Integer | 结果总数 |
错误码
请参照错误返回章节的内容。
请求示例
Plain Text
1GET /v1/vm/service?pageNo=1&pageSize=10&keyword=&keywordType=instanceId HTTP/1.1
2Host: bec.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7 {
8 "result": [
9 {
10 "serviceId": "s-c3beibkn",
11 "serviceName": "test",
12 "status": "NORMAL",
13 "totalCpu": 2,
14 "totalMem": 4,
15 "totalDisk": 0,
16 "totalRootDisk": 80,
17 "regions": 1,
18 "deployInstances": [
19 {
20 "region": "SOUTH_CHINA",
21 "serviceProvider": "CHINA_UNICOM",
22 "replicas": 2,
23 "city": "GUANGZHOU"
24 }
25 ],
26 "totalInstances": 2,
27 "runningInstances": 2,
28 "createTime": "2021-02-20T03:12:35Z",
29 "totalGpu": 0,
30 "bandwidth": "49Mbps",
31 "totalBandwidth": "98Mbps",
32 "tags": [
33 {
34 "tagKey": "tagKey",
35 "tagValue": "tagValue"
36 }
37 ]
38 }
39 ],
40 "orders": null,
41 "orderBy": "createTime",
42 "order": "desc",
43 "pageNo": 1,
44 "pageSize": 1,
45 "totalCount": 17
46 }Model对象定义
VmServiceBriefVo
| 参数名称 | 类型 | 描述 |
|---|---|---|
| serviceId | String | 虚机服务ID |
| serviceName | String | 虚机服务名称 |
| status | String | 资源状态（NORMAL、FAILED） |
| totalCpu | Integer | CPU数量 |
| totalGpu | Integer | GPU数量 |
| totalMem | Integer | 内存数量 |
| totalRootDisk | Integer | 系统盘总量 |
| totalDisk | Integer | 数据盘总量 |
| regions | Integer | 区域数量 |
| deployInstances | List<DeploymentInstance> | 部署区域列表 |
| totalInstances | Integer | 总实例数 |
| runningInstances | Integer | 运行实例数 |
| createTime | Date | 创建时间 |
| totalBandwidth | String | 虚机服务内带宽的总和 |
| bandwidth | String | 虚机服务内带宽的模板 |
| tags | List<TagModel> | 标签信息 |
ImageDetail
| 参数名称 | 类型 | 描述 |
|---|---|---|
| id | String | ID |
| imageId | String | imageId |
| name | String | 镜像名称 |
| imageType | String | 镜像类型 |
| snapshotId | String | 快照ID |
| cpu | Integer | CPU数量 |
| memory | Integer | 内存数量 |
| osType | String | OS类型 |
| osVersion | String | OS版本 |
| osName | String | OS名称 |
| osBuild | String | OS创建时间 |
| osLang | String | OS语言 |
| diskSize | Integer | 磁盘大小 |
| createTime | Date | 创建时间 |
| minCpu | Integer | 最小CPU数量 |
| minMem | Integer | 最小内存数量 |
| minDiskGb | Integer | 最小磁盘数量 |
| desc | String | 描述 |
| osArch | String | osArch |
| ephemeralSize | Integer | ephemeralSize |
| imageDescription | String | 镜像描述 |
| shareToUserNumLimit | Integer | 分享数量限制 |
| sharedToUserNum | Integer | 分享数量 |
| fpgaType | String | fpgaType |
| name_fri | String | name_fri |
DeploymentInstance
| 参数名称 | 类型 | 描述 |
|---|---|---|
| region | Region | 区域 |
| serviceProvider | ServiceProvider | 运营商 |
| city | String | 城市 |
| replicas | Integer | 副本数，最小为1 |
TagModel
| 参数名称 | 类型 | 描述 |
|---|---|---|
| tagKey | String | 标签键 |
| tagValue | String | 标签值 |