获取BEC虚机服务列表

边缘计算节点 BEC

所有文档

          边缘计算节点 BEC

          • BEC
          • >
          • API参考
          • >
          • 边缘云服务器
          • >
          • 虚机服务管理相关接口
          • >
          • 获取BEC虚机服务列表

          获取BEC虚机服务列表

          更新时间：2021-02-20

          获取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参数 查询实例的关键字类型，serviceId和serviceName，默认为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": [
            {
                "serviceId": "s-c3beibkn",
                "serviceName": "test",
                "status": "RUNNING",
                "totalCpu": 2,
                "totalMem": 4,
                "totalDisk": 0,
                "totalRootDisk": 80,
                "regions": 1,
                "deployInstances": [
                    {
                        "region": "SOUTH_CHINA",
                        "serviceProvider": "CHINA_UNICOM",
                        "replicas": 2,
                        "city": "GUANGZHOU"
                    }
                ],
                "totalInstances": 2,
                "runningInstances": 2,
                "osImage": {
                    "id": "1e84845f-e28a-4f84-ac5e-d5978dcae761",
                    "imageId": "m-Hj0rMRY5",
                    "name": "ubuntu-16.04-i386-20201113213222",
                    "imageType": "common",
                    "snapshotId": "",
                    "cpu": 0,
                    "memory": 0,
                    "osType": "linux",
                    "osVersion": "16.04 LTS",
                    "osName": "Ubuntu",
                    "osBuild": "2020111300",
                    "osLang": "ENG",
                    "diskSize": 0,
                    "createTime": "2020-11-13T13:45:28Z",
                    "status": "active",
                    "minMem": 1,
                    "minCpu": 0,
                    "minDiskGb": 20,
                    "desc": "ubuntu-16.04-i386-20201113213222",
                    "osArch": "i386 (32bit)",
                    "ephemeralSize": 0,
                    "imageDescription": "ubuntu-16.04-i386-20201113213222",
                    "shareToUserNumLimit": 0,
                    "sharedToUserNum": 0,
                    "fpgaType": "",
                    "name_fri": null
                },
                "createTime": "2021-02-20T03:12:35Z",
                "totalGpu": 0,
                "bandwidth": "49Mbps",
                "totalBandwidth": "98Mbps"
            }
        ],
        "orders": null,
        "orderBy": "createTime",
        "order": "desc",
        "pageNo": 1,
        "pageSize": 1,
        "totalCount": 17
    }

          Model对象定义

          VmServiceBriefVo

          参数名称 类型 描述
          serviceId String 虚机服务ID
          serviceName String 虚机服务名称
          status String 资源状态(STOP，RUNNING，PENDING，TERMINATING，FAILED，SUCCEEDED，UNKNOWN，TERMINATED，WAITING)
          totalCpu int cpu数量
          totalGpu int gpu数量
          totalMem int 内存数量
          totalRootDisk int 系统盘总量
          totalDisk int 数据盘总量
          regions int 区域数量
          deployInstances List 部署区域列表
          totalInstances int 总实例数
          runningInstances int 运行实例数
          osImage ImageDetail 系统镜像详情
          createTime Date 创建时间
          totalBandwidth String 虚机服务内带宽的总和
          bandwidth String 虚机服务内带宽的模板

          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
          上一篇
          获取BEC虚机服务详情
          下一篇
          创建BEC虚机服务