接口功能介绍
查询实例可变更规格。
接口约束
无
URI
GET /v1/open-api/instance/describe-avaliable-classes
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
outerProdInstId | 是 | String | 实例Id | 0e48285e153444b883d51261502f27cc |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回码 | 0 | |
message | 是 | String | 返回消息 | success | |
returnObj | 是 | Array of Objects | 返回对象 | returnObj |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
instance_info | 是 | String | 实例信息 | instance_info | |
products | 是 | Object | 可用区列表 | product |
表 instance_info
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
name | 是 | String | 实例名称 | testName | |
db_type | 是 | String | 数据库类型 | MySQL | |
version | 是 | String | 版本 | advanced | |
db_version | 是 | String | 数据库版本 | 8.0 | |
bill_mode | 是 | String | 计费模式 | 2 | |
product_type | 是 | String | 产品类型 | rds | |
version_name | 是 | String | 产品版本名称 | 一主两备版 | |
spec | 是 | String | cpu和内存信息 | 1C4G | |
eff_date | 是 | String | 订购时间 | 2022年10月12日 17:48:15 | |
exp_date | 是 | String | 过期时间 | 2122年10月12日 17:48:15 | |
disk_size | 是 | String | 磁盘大小 | 100GB | |
disk_type | 是 | String | 磁盘类型 | 普通IO | |
disk_type_id | 是 | String | 磁盘类型id | SATA | |
bak_disk_size | 是 | String | 备份磁盘大小 | 100GB | |
bak_disk_type | 是 | String | 备份磁盘类型 | 普通IO | |
bak_disk_type_id | 是 | String | 备份磁盘类型id | SATA | |
storage_resource_id | 是 | String | 存储资源id | 673956b8905d45ec8fbe00cf4cad5be8 | |
bak_storage_resource_id | 是 | String | 备份资源id | 3c8d62579ea94598aa0c74f89cd7cc72 |
表 product
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
node_storage | 是 | Object | 可变更存储大小信息 | storage | |
bak_storage | 是 | Object | 可变更存储大小信息 | storage | |
specs | 是 | Array of Objects | 可内存和cpu列表 | spec | |
upgrade_version | 是 | Array of Objects | 可变更version列表 | version |
表storage
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
storage_max | 是 | Integer | 可变更最大存储容量 | 2048 | |
storage_min | 是 | Integer | 可变更最小存储容量 | 110 | |
step_size | 是 | Integer | 变更步长 | 10 |
表spec
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
mem | 是 | Integer | 变更内存容量 | 4 | |
cpu | 是 | Integer | 变更cpu核数 | 1 | |
type | 是 | String | 变更类型(当前、升级、降级) | up | |
expansionType | 是 | Integer | 变更类型 | 3 |
表version
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
version_name | 是 | String | 版本名 | 主备版 | |
type | 是 | String | 变更类型 | current | |
version | 是 | String | 版本 | advanced | |
expansionType | 是 | Integer | 变更类型 | 2 |
请求示例
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": {
"instance_info": {
"db_type": "MySQL",
"eff_date": "2022年10月12日 17:48:15",
"disk_size": "100GB",
"bak_disk_size": "100GB",
"bak_storage_resource_id": "3c8d62579ea94598aa0c74f89cd7cc72",
"version": "advanced",
"spec": "1C4G",
"db_version": "8.0",
"bak_disk_type": "普通IO",
"bill_mode": "2",
"product_type": "rds",
"version_name": "一主两备版",
"disk_type": "普通IO",
"name": "Rds-7701",
"exp_date": "2122年10月12日 17:48:15",
"storage_resource_id": "673956b8905d45ec8fbe00cf4cad5be8",
"bak_disk_type_id": "SATA",
"disk_type_id": "SATA"
},
"products": {
"node_storage": {
"storage_max": 2048,
"step_size": 10,
"storage_min": 110
},
"specs": [
{
"mem": 4,
"cpu": 1,
"type": "current",
"expansionType": 3
},
{
"mem": 4,
"cpu": 2,
"type": "up",
"expansionType": 3
}
],
"bak_storage": {
"storage_max": 2048,
"step_size": 10,
"storage_min": 110
},
"upgrade_version": [
{
"version_name": "单机版",
"type": "down",
"version": "basic",
"expansionType": 2
},
{
"version_name": "主备版",
"type": "down",
"version": "highAvailability",
"expansionType": 2
},
{
"version_name": "一主两备版\t",
"type": "current",
"version": "advanced",
"expansionType": 2
}
]
}
}
}
状态码
状态码 | 描述 |
---|---|
0 | 请求响应成功 |
错误码
状态码 | 描述 |
---|---|
2001 | 参数异常,失败原因见message |
3001 | 业务异常,失败原因见message |
5001 | 请求响应失败,失败原因见message |