文档中心

裸金属服务器 BMS API 参考手册

最近更新时间：2023-04-16 17:00:00

1 裸金属服务器管理

1.1 GetFlavorDetail

调用 GetFlavorDetail 接口查询指定规格族信息。

1.1.1 使用说明

GET https://{Endpoint}/bms/v1.0/flavors/{FlavorId}

1.1.2 请求参数

1.1.3 返回数据

表1-1 Flavor 结构体

表1-2 FlavorClass 结构体

表1-3 StockSpec 结构体

1.1.4 示例

1. 请求示例

GET https://{Endpoint}/bms/v1.0/flavors/4acadc89-4fb8-4edb-b390-93506ff8c829

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "c9d0bc5a82ca0bb2c320995cfe31f***",

"Data": {

"FlavorId": "0e8476db-0c18-4596-b4a1-d3f3b5cb8a88",

"ImageId": "img-z9lc2iyvvog4w6",

……

}

1.2 CreateBMInstance

调用 CreateBMInstance 接口创建传统裸金属服务器实例。

1.2.1 使用说明

POST https://{Endpoint}/bms/v1.0/servers

1.2.2 请求参数

1.2.3 请求 body

表1-4 Server 结构体

表1-5 Network 结构体

表1-6 EIP 结构体

1.2.4 返回数据

表1-7 OpBmsDetailOutput 结构体

表1-8 Instance 结构体

表1-9 VpcPort 结构体

1.2.5 示例

1. 请求示例

POST https://{Endpoint}/bms/v1.0/servers

{ "ChargingMode":"1",

"PeriodType":"month",

"Duration":5,

"ImageId": "img-m3d5k4az6flwic",

"Protected": 0,

"ZoneId": "zone-1",

"Networks": [

{

"VpcId": "vpc-45cpxlv7ae",

"SubnetId": "snet-zqoljwv930",

"FixedIp": ""

}

"FlavorId": "00000000-0000-0000-0000-000000000003",

"AdminPass": "Cestc@123",

"Hostname": "test-release",

"Userdata": ""

}

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "c9d0bc5a82ca0bb2c320995cfe31f***",

"Data": {

"Server": {

"InstanceId": "xxxx",

...

"Flavor": {

"FlavorId": "xxxxx",

"Name": "xxxxx",

……

}

1.3 DeleteBMInstance

调用 DeleteBMInstance 接口退还一台传统裸金属服务器实例。

1.3.1 使用说明

DELETE https://{Endpoint}/v1.0/servers/{BmsId}

1.3.2 请求参数

1.3.3 返回数据

1.3.4 示例

1. 请求示例

DELETE https://{Endpoint}/bms/v1.0/servers/{BmsId}

2. 返回示例

{

"RequestId":"671ea0ab-411f-47bf-b06a-693c2bf53b90",

"Data":true

}

1.4 RenewOrder

调用 RenewOrder 接口续费传统裸金属服务器实例。

1.4.1 使用说明

POST https://{Endpoint}/bms/v1.0/instance/reneworde

1.4.2 请求参数

1.4.3 返回数据

1.4.4 示例

1. 请求示例

POST https://{Endpoint}/bms/v1.0/instance/reneworde

{"ChargingMode":"1",

"PeriodType":"month",

"Duration":12,

"InstanceList":["bms-ha2o2lvhaih0xj"]

}

2. 返回示例

{

"RequestId":"c59857f6-1b74-4568-9809-b353b2dcd745"，

"Data":true

}

1.5 GetBMInstances

调用 GetBMInstances 接口获取传统裸金属服务器实例列表信息。

1.5.1 使用说明

GET https://{Endpoint}/bms/v1.0/servers?PageSize=10&PageNumber=1

1.5.2 请求参数

1.5.3 返回数据

表1-10 Server 结构体

1.5.4 示例

1. 请求示例

GET https://{Endpoint}/bms/v1.0/servers

2. 返回示例

{

"RequestId": "",

"Data": {

"Servers": [{

"InstanceId": "bms-paei9cv35qmcof",

"Description": "",

"FlavorId": "4acadc89-4fb8-4edb-b390-93506ff8c829",

"CpuArch": "x86",

"RegionId": "",

"ZoneId": "",

"Name": "test-x86-80",

"ImageId": "img-m3d5k4az6flwic",

"Protected": false,

"TenantId": "210011023000400",

"NodeId": "80",

"VpcPorts": [],

"State": "pending",

"TransitionStatus": "creating",

"DefaultPasswd": "Cestc@123",

"Userdata": "",

"PayModel": "",

"OrderId": "",

"BmType": 1,

"SecurityGroupIds": "",

"SecurityGroups": null,

"CreatedAt": "2022-01-07T11:47:34.59+08:00",

"UpdatedAt": "2022-01-07T11:47:42.676+08:00",

"ExpireTime": "",

"EipUid": "",

"Eip": ""

}],

"TotalCount": 1

}

1.6 GetBMInstance

调用 GetBMInstance 接口获取传统裸金属服务器实例详情信息。

1.6.1 使用说明

GET https://{Endpoint}/bms/v1.0/servers/{ServerId}

1.6.2 请求参数

1.6.3 返回数据

表1-11 实例详情结构体

表1-12 VPC 详情结构体

表1-13 Subnet 详情结构体

表1-14 实例详情结构体

1.6.4 示例

1. 请求示例

GET https://{Endpoint}/bms/v1.0/servers/{ServerId}

2. 返回示例

{

"RequestId": "",

"Data": {

"Server": {

"InstanceId": "bms-pagtabemu5gmk2",

"Description": "",

"FlavorId": "4acadc89-4fb8-4edb-b390-93506ff8c829",

"CpuArch": "x86",

"RegionId": "paas-dev",

"ZoneId": "center-cluster",

"Name": "cecloud-ecs-15613",

"ImageId": "img-m3d5k4az6flwic",

"Protected": false,

"TenantId": "220001010600400",

"NodeId": "80",

"State": "running",

"TransitionStatus": "",

"DefaultPasswd": "123qweQWE",

"Userdata": "",

"PayModel": "1",

"OrderId": "120113000000062",

"BmType": 1,

"SecurityGroupIds": "",

"CreatedAt;default:0;not null": "2022-01-16T15:40:49.602+08:00",

"UpdatedAt;default:0;not null": "2022-01-16T16:40:56.402+08:00"

"Flavor": {

"FlavorId": "4acadc89-4fb8-4edb-b390-93506ff8c829",

"Name": "bms.c12.mili122",

"ZoneId": "zone-1",

"Title": "class-democ12",

"ClassId": "class_id_demo",

"Description": "erer",

"Arch": "x86",

"Ram": 1024,

"Cpus": 2,

"CpuBaseHz": "2.4",

"CpuPeakHz": "2.4",

"CpuModel": "intel a333",

"IntranetBandwidth": "3",

"IntranetPps": "3",

"StorageBaseIops": "3",

"StoragePeakIops": "3",

"Ipv6": 1,

"Status": "",

"CreatedAt": "2021-12-15T10:32:48.364+08:00",

"UpdatedAt": "2021-12-15T10:32:48.364+08:00",

"Baremetal": 0,

"BmType": 0,

"Stock": null,

"OsDiskSize": 20,

"Disk": 3

}

1.7 StartBMInstance/StopBMInstance/RebootBmInstance

调用 StartBMInstance 接口开启一台传统裸金属服务器实例，或调用 StoptBMInstance 接口关闭一台弹性裸金属服务器实例，或 RebootBMInstance 调用接口重启一台裸金属服务器实例。

1.7.1 使用说明

POST https://{Endpoint}/bms/v1.0/servers/{ServerId}/start

POST https://{Endpoint}/bms/v1.0/servers/{ServerId}/stop

POST https://{Endpoint}/bms/v1.0/servers/{ServerId}/reboot

1.7.2 请求参数

1.7.3 返回数据

1.7.4 示例

1. 请求示例

POST https://{Endpoint}/bms/v1.0/servers/{ServerId}/start

POST https://{Endpoint}/bms/v1.0/servers/{ServerId}/stop

POST https://{Endpoint}/bms/v1.0/servers/{ServerId}/reboot

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId":"xxxx",

"Data":true

}

1.8 BindEip

调用 BindEip 接口绑定一个弹性公网 IP。

1.8.1 使用说明

POST https://{Endpoint}/bms/v1.0/servers/bindeip

1.8.2 请求参数

1.8.3 返回数据

1.8.4 示例

1. 请求示例

POST https://{Endpoint}/bms/v1.0/servers/bindeip

{

"BmType": 1,

"BmId": "bms-de6c8a1m8zymwy",

"EipId": "eip-ipjisy3xdva9"

}

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be",

"Data":true

}

1.9 UnbindEip

调用 UnbindEip 接口解绑一个弹性公网 IP。

1.9.1 使用说明

POST https://{Endpoint}/bms/v1.0/servers/unbindeip

1.9.2 请求参数

1.9.3 返回数据

1.9.4 示例

1. 请求示例

POST https://{Endpoint}/bms/v1.0/servers/unbindeip

{

"BmType": 1,

"BmId": "bms-de6c8a1m8zymwy",

"EipId": "eip-ipjisy3xdva9"

}

2. 正常返回示例

HTTP/1.1 200 OK

Content-Type:application/json

{

"RequestId": "71e69b56-32be-4412-ab45-49eded6a87be",

"Data":true

}

意见反馈

文档内容是否对您有帮助？

如您有其他疑问，您也可以通过在线客服来与我们联系探讨在线客服