接口功能介绍
查询物理机库存
接口约束
无
URI
GET /v4/ebm/device-stock-list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 区域ID | 81f7728662dd11ec810800155d307d5b | |
| azName | 是 | String | 可用区名称或者 default。您可以调用 https://eop.ctyun.cn/ebp/ctapiDocument/search?sid=25&api=5855&data=87 获取资源池信息，查询结果中zoneList内返回可用区名称，若查询结果中zoneList为空，即为单可用区，本字段填写default | az1 | |
| deviceType | 否 | String | 套餐类型 | physical.t3.large | |
| count | 否 | Integer | 所需库存数必须大于0 | 123 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败)，默认值:800 | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明 | Ebm.DeviceStockList.NotValid | |
| message | String | 响应结果的描述，一般为英文描述 | error request | |
| description | String | 响应结果的描述，一般为中文描述 | 错误请求 | |
| returnObj | Object | 返回参数，参考表returnObj | {} | returnObj |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| totalCount | Integer | 总记录数 | 200 | |
| results | Array of Objects | 分页明细，元素类型是results，定义请参考表results | [{},{}] | results |
表results
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| available | Integer | 可用物理机数量 | 3 | |
| success | Boolean | 是否库存足够 | true | |
| stocks | Array of Objects | 套餐库存详情 | [{}] | stocks |
表stocks
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| deviceType | String | 套餐名称 | physical.t3.large | |
| available | Integer | 可用物理机数量 | 3 | |
| success | Boolean | 是否库存足够 | true |
请求示例
Query
/v4/ebm/device-stock-list?regionID=bb9fdb42056f11eda1610242ac110002&azName=az2
响应示例
{
"statusCode": 800,
"returnObj": {
"totalCount": 3,
"results": [
{
"success": true,
"available": 3,
"stocks": [
{
"available": 1,
"device_type": "physical.t1.large.1",
"success": true
},
{
"available": 2,
"device_type": "physical.t2.large.1",
"success": true
}
]
}
]
},
"errorCode": "",
"message": "SUCCESS",
"description": "成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功 |
错误码
| 错误码 | 描述 |
|---|---|
| Ebm.DeviceStockList.NotValid | 请求参数非法 |
| Ebm.Common.CheckError | 内部错误，请重试 |
| 其他 | 参见公共错误码说明 |
