获取BEC虚机实例详情

更新时间：2022-01-05

接口描述

本接口用于获取BEC虚机实例详情。

请求结构

GET /v1/vm/instance/{vmId} HTTP/1.1
Host: bec.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
vmId	String	是	URL参数	虚机实例ID

响应头域

除公共头域外，无其它特殊头域。

响应参数

参数名称	类型	描述
vmId	String	虚机实例ID
uuId	String	虚机实例ID
vmName	String	虚机实例名称
status	String	资源状态(CREATING，RUNNING，STOPPING，STOPPED，RESTARTING，REINSTALLING，STARTING，IMAGING，FAILED，UNKNOWN)
spec	String	分机型策略虚机规格族
cpu	Integer	CPU数量
mem	Integer	内存数量
gpu	Integer	GPU数量
rootDiskSize	Integer	系统盘数量
dataStorage	Integer	数据盘数量
regionId	String	节点ID
region	String	地域
serviceProvider	String	运营商
city	String	城市
needPublicIp	Boolean	是否开通公网
needIpv6PublicIp	Boolean	是否开通IPv6公网
multiplePublicIp	List<IpInfo>	三线公网IP
ipv6PublicIp	String	IPv6公网IP
internalIp	String	内网IP
bandwidth	String	公网带宽大小
osImage	ImageDetail	系统镜像详情
serviceId	String	虚机服务ID
createTime	Date	创建时间
systemVolume	SystemVolumeConfig	系统盘
dataVolumeList	List<VolumeConfig>	数据盘列表
rackId	String	宿主机所在机架ID（白名单用户提供）
hostId	String	宿主机ID（白名单用户提供）
switchId	String	宿主机所在交换机ID（白名单用户提供）
privateIps	List<String>	内网辅助IP列表
securityGroups	List<SecurityGroup>	虚机关联的安全组列表。当虚机的网络类型为vpc时有效。
vpc	Vpc	虚机所属的私有网络和子网信息。当虚机的网络类型为vpc时有效。

错误码

请参照错误返回章节的内容。

请求示例

GET /v1/vm/instance/vm-imwcjdtr 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

{
        "publicIp": "112.29.149.223",
        "ipv6PublicIp": "",
        "internalIp": null,
        "multiplePublicIp": null,
        "serviceProvider": "CHINA_MOBILE",
        "vmId": "vm-imwcjdtr",
        "uuid": "askj1293-b8e5-4fcf-u7a1-dd2b71949370",
        "vmName": "vm-imwcjdtr",
        "status": "RUNNING",
        "spec": "bec.c2.c1m2"
        "cpu": 1,
        "mem": 2,
        "gpu": 0,
        "regionId": "cn-xiangtan-cm"
        "region": "CENTRAL_CHINA",
        "city": "XIANGTAN",
        "needPublicIp": true,
        "needIpv6PublicIp": false,
        "bandwidth": "100Mbps",
        "osImage": {
            "id": "49",
            "imageId": "im-awwxnhme-2-u-asknfjnwe",
            "name": "test-image",
            "imageType": "becCustom",
            "snapshotId": null,
            "cpu": 0,
            "memory": 0,
            "osType": "linux",
            "osVersion": "7.3",
            "osName": "CentOS",
            "osBuild": "2020122100",
            "osLang": "ENG",
            "diskSize": 0,
            "createTime": "2021-01-25T13:30:02Z",
            "status": null,
            "minMem": 0,
            "minCpu": 0,
            "minDiskGb": 0,
            "desc": null,
            "osArch": "x86_64 (64bit)",
            "ephemeralSize": 0,
            "imageDescription": null,
            "shareToUserNumLimit": 0,
            "sharedToUserNum": 0,
            "fpgaType": null,
            "name_fri": null
        },
        "serviceId": "s-12kjnd19",
        "rackId": "rk-9059xxxf",
        "hostId": "h-6660xxx3",
        "switchId": "sw-d021xxxa",
        "privateIps":[],
        "createTime": "2021-03-01T10:34:06Z",
        "rootDiskSize": 40,
        "dataStorage": 43,
        "systemVolume": {
            "volumeType": "SATA",
            "sizeInGB": 40,
            "name": "vm-rootfs",
            "pvcName": "lvm-12kjnd19-0-m-xiangtan-knj12-rootfs"
        }，
        "dataVolumeList": [
            {
                "name": "volume1",
                "volumeType": "NVME",
                "sizeInGB": 21,
                "pvcName": "lvm-12kjnd19-0-m-xiangtan-knj12-2n1le"
            }
        ],
        "networkConfig": {
            "needPrivateNetwork": true,
            "needPublicNetwork": true,
            "privateNetworkName": "test-eth0",
            "publicNetworkName": "test-eth1"
        },
        "vpc": {
            "vpcId": "vpc-djn3wxpu",
            "name": "vpc-test",
            "cidr": "192.168.0.0/16",
            "description": "test",
            "subnet": {
                "subnetId": "sbn-lv6crppu",
                "name": "subnet-test",
                "cidr": "192.168.0.0/20",
                "description": "test"
            }
        },
         "securityGroups": [
            {
                "id": "sg-mkvivalw",
                "name": "default",
                "desc": "test",
                "rules": [
                    {
                        "securityGroupRuleId": "sgr-mkvivalw-cjgy7clg",
                        "direction": "egress",
                        "protocol": "all",
                        "portRange": "1-65535",
                        "remark": "default",
                        "etherType": "IPv4",
                        "destIp": "0.0.0.0/0"
                    },
                    {
                        "securityGroupRuleId": "sgr-mkvivalw-zqpec2tj",
                        "direction": "ingress",
                        "protocol": "tcp",
                        "portRange": "22",
                        "remark": "SSH远程终端",
                        "etherType": "IPv4",
                        "sourceIp": "0.0.0.0/0"
                    }
                 ]
            }
        ]
    }

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	分享数量
fpgaType	String	fpgaType
name_fri	String	name_fri

SystemVolumeConfig

参数名称	类型	描述
volumeType	DiskType	盘类型
sizeInGB	Integer	盘尺寸
name	String	盘名称
pvcName	String	PVC名称

VolumeConfig

参数名称	类型	描述
volumeType	DiskType	盘类型
sizeInGB	Integer	盘尺寸
name	String	盘名称
pvcName	String	PVC名称
passthroughCode	String	独占盘套餐码

NetworkConfig

参数名称	类型	描述
needPrivateNetwork	boolean	内网是否开通，true：开通，false：不开通
needPublicNetwork	boolean	公网是否开通，true：开通，false：不开通
privateNetworkName	String	内网网卡名称，支持大小写字母，数字，"-_"，必须以字母开头，长度3-16字符。内外网卡的名称不能重复
publicNetworkName	String	公网网卡名称，支持大小写字母，数字，"-_"，必须以字母开头，长度3-16字符。内外网卡的名称不能重复

IpInfo

参数名称	类型	描述
serviceProvider	ServiceProvider	运营商
ip	String	公网IP
ipv6	String	公网IPv6

ServiceProvider

编码	描述
CHINA_MOBILE	中国移动
CHINA_UNICOM	中国联通
CHINA_TELECOM	中国电信
TRIPLE_LINE	三线
INTRA	内网
BGP	海外节点运营商BGP

SecurityGroup

参数名称	类型	描述
id	String	安全组ID
name	String	安全组名称
desc	String	安全组描述
rules	List<SecurityGroupRule>	安全组规则

SecurityGroupRule

参数名称	类型	描述
direction	String	入站/出站，取值ingress或egress。
ethertype	String	网络类型，取值IPv4。暂不支持IPv6
portRange	String	端口范围，单个端口，或者为1-65535格式的端口范围
protocol	String	协议类型，tcp、udp或icmp，值为空时指所有协议
sourceIp	String	源IP地址
destIp	String	目的IP地址
remark	String	备注

Vpc

参数名称	类型	描述
vpcId	String	VPC ID
name	String	VPC名称
cidr	String	VPC 网段及子网掩码CIDR
description	String	VPC 描述
subnet	Subnet	子网信息

Subnet

参数名称	类型	描述
subnetId	String	子网ID
name	String	子网名称
cidr	String	子网网段CIDR
description	String	子网描述

获取BEC虚机实例列表

获取BEC虚机实例监控

百度智能云

边缘计算节点 BEC

边缘计算节点 BEC

获取BEC虚机实例详情

接口描述

请求结构

请求头域

请求参数

响应头域

响应参数

错误码

请求示例

响应示例

Model对象定义

ImageDetail

SystemVolumeConfig

VolumeConfig

NetworkConfig

IpInfo

ServiceProvider

SecurityGroup

SecurityGroupRule

Vpc

Subnet