接口功能介绍
调用接口查询某地域可售卖资源信息。
接口约束
无
URI
GET /v1/open-api/instance/describe-available-resource
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
accountId | 是 | String | 用户账户id | 0 | |
regionId | 是 | String | 资源池Id | d15ff6c8f92011e4a2fbe2ad47403cef | |
edition | 否 | String | 版本类型 (可选值: basic 单机版, advanced 一主两备版 ,highAvailability 主备版) | highAvailability | |
volumeType | 否 | String | 磁盘类型 (可选值:SAS,SATA,SSD) | SATA | |
engineVersion | 否 | String | 引擎版本,5.7版本、8.0版本 | 5.7 | |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回码 取值范围:0 成功 | 0 | |
message | 是 | String | 返回消息 | ||
returnObj | 是 | Object | 返回结果信息 | returnObj |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池Id | d15ff6c8f92011e4a2fbe2ad47403cef | |
regionName | 是 | String | 资源池名称 | ||
model | 是 | Object | 规格信息 | model |
表 model
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
8.0 | 是 | Array of Objects | 8.0版本规格列表 | product | |
5.7 | 是 | Array of Objects | 5.7版本规格列表 | product |
表 product
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
product_desc | 是 | String | 产品描述 | 一主一从异步,适用初创企业/测试应用 | |
product_version | 是 | String | 产品版本 | highAvailability | |
product_version_text | 是 | String | 产品版本文本 | 主备版 | |
product_id | 是 | String | 产品id | 10001101 | |
disk_type | 是 | Array of String | 硬盘类型 | ||
cpu_mem | 是 | Array of Object | cpu和内存信息 | cpu_mem |
表cpu_mem
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
mem | 是 | Integer | 内存大小 | 4 | |
cpu | 是 | Integer | cpu核数 | 1 | |
support_version | 是 | Array of Integer | 支持的系列 |
请求示例
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": [
{
"regionId": "100054c0416811e9a6690242ac110002",
"regionName": "保定",
"model": {
"8.0": [
{
"product_desc": "一主两从半同步,适合于对数据可靠性要求较高的企业级应用",
"product_version": "advanced",
"product_version_text": "一主两备版",
"disk_type": [
"SATA",
"SAS"
],
"product_id": "10001102",
"cpu_mem": [
{
"mem": 4,
"support_version": [
2
],
"cpu": 1
},
{
"mem": 4,
"support_version": [
2
],
"cpu": 2
},
{
"mem": 8,
"support_version": [
2
],
"cpu": 2
},
{
"mem": 16,
"support_version": [
2
],
"cpu": 2
},
{
"mem": 8,
"support_version": [
2
],
"cpu": 4
},
{
"mem": 16,
"support_version": [
2
],
"cpu": 4
},
{
"mem": 16,
"support_version": [
2
],
"cpu": 8
},
{
"mem": 32,
"support_version": [
2
],
"cpu": 8
},
{
"mem": 64,
"support_version": [
2
],
"cpu": 16
}
]
}
]
}
}
]
}
状态码
状态码 | 描述 |
---|---|
0 | 请求响应成功 |
错误码
错误码 | 描述 |
---|---|
2001 | 参数异常,失败原因见message |
3001 | 业务异常,失败原因见message |
5001 | 请求响应失败,失败原因见message |