获取BEC虚机服务详情
更新时间：2025-08-05
接口描述
本接口用于获取BEC虚机服务详情。
请求结构
Plain Text
1GET /v1/vm/service/{serviceId} HTTP/1.1
2Host: bec.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| serviceId | String | 是 | URL参数 | 虚机服务ID |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| 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 | 运行实例数 |
| osImage | ImageDetail | 系统镜像详情 |
| createTime | Date | 创建时间 |
| bandwidth | String | 公网带宽模板大小 |
| totalBandwidth | String | 总公网带宽大小 |
| tags | List<TagModel> | 标签信息 |
错误码
请参照错误返回章节的内容。
请求示例
Plain Text
1GET /v1/vm/service/s-lqrs2a7u 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 "serviceId": "s-lqrs2a7u",
9 "serviceName": "test",
10 "status": "NORMAL",
11 "totalCpu": 1,
12 "totalMem": 2,
13 "totalDisk": 20,
14 "totalRootDisk": 40,
15 "regions": 1,
16 "deployInstances": [
17 {
18 "region": "SOUTH_CHINA",
19 "serviceProvider": "CHINA_UNICOM",
20 "replicas": 1,
21 "city": "GUANGZHOU"
22 }
23 ],
24 "totalInstances": 1,
25 "runningInstances": 1,
26 "osImage": {
27 "id": "8d3e507f-8b7f-44aa-a3b2-fc52fedecdc3",
28 "imageId": "m-IIyr1NaO",
29 "name": "ubuntu-18.04-amd64-20201113213429",
30 "imageType": "common",
31 "snapshotId": "",
32 "cpu": 0,
33 "memory": 0,
34 "osType": "linux",
35 "osVersion": "18.04 LTS",
36 "osName": "Ubuntu",
37 "osBuild": "2020111300",
38 "osLang": "ENG",
39 "diskSize": 0,
40 "createTime": "2020-11-13T13:47:10Z",
41 "status": "active",
42 "minMem": 1,
43 "minCpu": 0,
44 "minDiskGb": 20,
45 "desc": "ubuntu-18.04-amd64-20201113213429",
46 "osArch": "amd64 (64bit)",
47 "ephemeralSize": 0,
48 "imageDescription": "ubuntu-18.04-amd64-20201113213429",
49 "shareToUserNumLimit": 0,
50 "sharedToUserNum": 0,
51 "fpgaType": "",
52 "name_fri": null
53 },
54 "createTime": "2021-02-08T12:06:33Z",
55 "totalGpu": 0,
56 "bandwidth": "99Mbps",
57 "totalBandwidth": "99Mbps",
58 "tags": [
59 {
60 "tagKey": "tagKey",
61 "tagValue": "tagValue"
62 }
63 ]
64}Model对象定义
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 | 分享数量 |
DeploymentInstance
| 参数名称 | 类型 | 描述 |
|---|---|---|
| region | Region | 区域 |
| serviceProvider | ServiceProvider | 运营商 |
| city | String | 城市 |
| replicas | Integer | 副本数，最小为1 |
TagModel
| 参数名称 | 类型 | 描述 |
|---|---|---|
| tagKey | String | 标签键 |
| tagValue | String | 标签值 |