裸金属服务器列表
裸金属服务器列表
1. 描述
获取可用裸金属服务器列表
2. 请求地址
请求地址的格式如下：
https://<区域服务地址>/v1/bm/list
3. 请求参数
| Name | Type | Description | Required |
|---|---|---|---|
| projectId | String | 裸金属服务器所属项目ID | 是 |
| azSn | String | azSn | 否 |
| nameOrSn | String | 裸金属服务器名称或SN | 否 |
| status | String | 状态,可选项:(运行:ACTIVE,关闭:SHUTOFF,资源隔离:ISOLATED) | 否 |
| os | String | 操作系统，可选项:(OS-TYPE-CENTOS,OS-TYPE-DEBIAN,OS-TYPE-FG,OS-TYPE-REDHAT,OS-TYPE-SUSE,OS-TYPE-UBUNTU,OS-TYPE-WIN) | 否 |
| vpc | String | 裸金属服务器关联的vpcId | 否 |
| subnet | String | 裸金属服务器关联的subnetId | 否 |
| eip | String | 裸金属服务器绑定的公网IP地址 | 否 |
| curPage | Integer | 当前页码，默认值1 | 否 |
| perPage | Integer | 每页显示条数，默认值10 | 否 |
4. 请求示例
4.1. 请求地址
POST https://cn-east-1.api.yovole.com/v1/bm/list HTTP/1.1
x-ycs-timestamp: 2019-06-19T14:26:26Z
x-ycs-requestid: 2a49cfa2-925b-11e9-bb3a-6c96cfdcd6b9
x-ycs-security-authorization: Authorization: YCS1-HMAC-SHA1 Credential=08e206fb-7b41-45b7-8076-8d43e8aeea89,SignedHeaders=content-type;x-ycs-requestid;x-ycs-timestamp,Signature=2RFjU7C9gICCrQfpAIfAJHqRRlQ=
4.2. 接口请求参数
{
"projectId": "8a83a0966a681da5016a874df50b10ce",
"azSN": "CN-EAST-1-A",
"curPage":1,
"perPage":10
}
5. 返回结果
5.1. 返回正确结果示例
{
"requestId":"c1d4a3f0-d508-4e0a-a447-f203f432b043",
"success":true,
"code":200,
"pager":{
"curPage":1,
"perPage":10,
"totalRecords":1,
"totalPages":1,
"pageData":[
{
"id":"3a52c99b-c6c5-4f2c-af6d-ea1e40a813e6",
"name":"裸机名称",
"sn":"BM-210002P",
"regionSn":"CN-EAST-1",
"azSn":"CN-EAST-1-A",
"created":"2019-12-12 11:33:06",
"billingType":"PRE_PAID",
"vmProductName":"标准 I型",
"expired":"2020-01-12 11:33:00",
"attachVolumeCount":0,
"azName":"可用区A",
"status":"ACTIVE",
"osTypeName":"CentOS",
"sysDiskSize":0,
"portInfos":[
{
"subnetId":"f9b1035e-fbf7-481f-b28b-9b91017ed3fd",
"subnetName":" LP_TEST",
"subnetSn":"SN-21A-3U2H9",
"subnetIp":"10.1.2.12",
"subnetCidr":"10.1.2.0/24"
}
],
"flavorId":"ecs.bm1.xlarge",
"flavorName":"24c16g",
"cpu":8,
"ram":32,
"gpu":0
}
]
}
}
5.2. 返回错误结果示例
{
"requestId": "2a49cfa2-925b-11e9-bb3a-6c96cfdcd6b9",
"success": false,
"code": 400,
"message": "Required attribute 'projectId' not specified",
"errorCode": "Invalid argument"
}
6. 错误码
可以通过错误返回结果中的code、errorCode和message字段了解错误分类和具体的错误原因。
该接口没有特殊错误码，错误码信息和简单的错误分析方法可以参考公共错误码。