文档中心 > DescribeBms
DescribeBms

最近更新时间:2022-01-20

请求方法:GET

接口描述:使用DescribeBms查询裸金属服务器实例列表。


请求参数

Param

名称

类型

是否必选

描述

Action

String

是

操作名取值DescribeBms

RegionId

String

是

区域ID

  • HB1-BJMY (华北2-北京2) 

  • HD1-SHMY(华东1-上海)

Page

int

否

页码,默认1

Size

int

否

列表容量,默认10

InstanceId

String

否

以裸金属ID筛选

Status

String

否

以裸金属状态筛选

InstanceName

String

否

以裸金属名筛选

IpAddr

String

否

以裸金属主IP筛选


返回参数

名称

类型

描述

RequestId

String

请求ID

page

int

请求page

size

int

请求size

totalCount

int

总条数

totalPages

int

总页数

list

object

内容

+instanceId

String

裸金属ID

+instanceName

String

裸金属名称

+instanceCode

String

规格编码

+instanceCodeName

String

规格描述

+status

String

裸金属状态,详见枚举说明

+imageId

String

镜像ID

+imageType

String

镜像类型

+imageCode

String

镜像规格

+imageParentCode

String

镜像规格族编码

+instanceSystem

String

裸金属操作系统

+description

String

裸金属描述

+ip

String

裸金属IP

+eipId

String

EIP-ID

+eipAddr

String

EIP-IP

+eipSize

String

EIP带宽

+eipCode

String

EIP规格

+sysDisk

String

系统盘信息

+startTime

String

裸金属开通时间

+endTime

String

裸金属到期时间

+iscsiDiskCount

int

已绑定共享盘数量

+maxIscsi

int

最大共享盘限制数量

+azoneId

String

裸金属所在可见域

+payType

String

计费方式

+cpu

String

裸金属核心描述

+dataDisk

String

硬盘规格描述

+regionId

String

地区ID

+regionName

String

地区名称

+vpcId

String

vpcID

+vpcCidr

String

vpc网段

+subnetId

String

子网ID

+subnetCidr

String

子网网段

+instanceCpu

int

规格核数

+instanceMemory

int

规格内存数

+projectId

String

项目ID

+networkInterfaces

Array

裸金属网卡

++ip

String

网卡IP

++eniId

String

网卡ID

++bond

String

聚合方式

示例

请求示例

GET https://api.unicloud.com/compute/bms?
Action=DescribeBms
&RegionId=HB1-BJMY
&Page=1
&Size=10
&公共请求参数

返回示例

JSON格式

{
"RequestId": "b9de1a62-d09e-4d34-9a61-38f0f56564b6",
   "page": 1,
   "size": 10,
   "totalCount": 1,
   "totalPages": 1,
   "list": [
      {
           "instanceId": "bms-kawkob3nq4wk",
           "instanceName": "i-MTlrq5yLTJ",
           "instanceCode": "physical.c2.8xlarge",
           "instanceCodeName": "通用II型",
           "status": "RUNNING",
           "imageId": "uploadNFS-Centos7.6_uefi_en",
           "imageType": "linux",
           "imageCode": "uploadNFS-Centos7.6_uefi_en",
           "imageParentCode": "bms.image.public",
           "instanceSystem": "uploadNFS-Centos7.6_uefi_en",
           "description": "",
           "ip": "10.1.0.13",
           "eipId": null,
           "eipAddr": null,
           "eipSize": null,
           "eipCode": null,
           "sysDisk": "600G HDD*2",
           "startTime": 1603185715000,
           "endTime": 1605888000000,
           "iscsiDiskCount": 0,
           "maxIscsi": 1,
           "azoneId": "cn-beijing-a",
           "payType": "YEAR_MONTH",
           "cpu": "Intel Xeon Gold 4110(2*8核/2.1GHz) 256G",
           "dataDisk": "1.92T SSD*2",
           "regionId": "cn-beijing",
           "regionName": "华北2-北京2",

            "instanceCpu": 16,

            "instanceMemory": 256,

            "vpcId": "vpc-c8xc0kb4fdlv",

            "vpcCidr": "192.168.0.0/16",

            "subnetId": "a53f710afd08414e95a61d18c78729c6",

            "subnetCidr": "192.168.0.0/24",

            "projectId": "rg-c8xc0kb4fdly",

           "networkInterfaces": [
              {
                   "ip": "10.1.0.13",
                   "eniId": "eni-kawkob3nq4wl",
                   "bond": "bond4"
              }
          ]
      }
  ]
}