查询数据库规格(v3)
更新时间:2024-12-24 GMT+08:00
分享
功能介绍
查询数据库的规格信息。
调试
您可以在API Explorer中调试该接口。
URI
GET https://{
Endpoint
}/v3/{
project_id
}/flavors?limit={limit}&offset={offset}&ha_mode={ha_mode}&version={version}&spec_code={spec_code}
表1 参数说明
名称
是否必选
参数类型
说明
project_id
是
String
参数解释:
租户在某一Region下的项目ID。
获取方法请参见获取项目ID。
约束限制:
不涉及。
取值范围:
只能由英文字母、数字组成,且长度为32个字符。
默认取值:
不涉及。
version
否
String
参数解释:
数据库版本号。查询指定版本支持的规格。例如:3.208。
约束限制:
不涉及。
取值范围:
不涉及。
默认取值:
不涉及。
spec_code
否
String
参数解释:
规格编码,查询指定规格编码的具体规格信息。例如:3.208。
约束限制:
不涉及。
取值范围:
不涉及。
默认取值:
不涉及。
ha_mode
否
String
参数解释:
实例类型,查询指定实例类型支持的规格。
约束限制:
不涉及
取值范围:
- 集中式:centralization_standard。
- 分布式:enterprise。
默认取值:
不涉及。
limit
否
Integer
参数解释:
查询记录数。例如该参数设定为10,则查询结果最多只显示10条记录。
约束限制:
不涉及。
取值范围:
[1, 100]
默认取值:
默认为100。
offset
否
Integer
参数解释:
索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。例如:该参数指定为1,limit指定为10,则只展示第2-11条数据。
约束限制:
不涉及。
取值范围:
[0, 2^31-1]
默认取值:
默认为0(偏移0条数据,表示从第一条数据开始查询)。
请求参数
无。
响应参数
表2 响应参数
名称
参数类型
说明
flavors
Array of objects
参数解释:
规格详情。
详情请参见表3。
total
integer
参数解释:
总记录数。
取值范围:
[0, 2^31-1],实际取决于查询。
表3 flavors说明
名称
参数类型
说明
vcpus
string
参数解释:
CPU个数。
取值范围:
不涉及。
ram
string
参数解释:
内存大小,单位为GB。
取值范围:
不涉及。
spec_code
string
参数解释:
资源规格编码。参考数据库实例规格
取值范围:
不涉及。
availability_zone
Array of strings
参数解释:
支持该规格的AZ。
az_status
Map<String,String>
参数解释:
其中key是可用区编号,value是规格所在az的状态,包含以下状态。
取值范围:
- normal:可用。
- unsupported:不支持该规格。
- sellout:售罄。
version
string
参数解释:
该规格支持的数据库版本号。
取值范围:
不涉及。
name
string
参数解释:
数据库引擎名称。
取值范围:
不涉及。
group_type
string
参数解释:
性能规格。
取值范围:
- normal:独享型(1:8)。
- normal2:独享型(1:4)。
- armFlavors:鲲鹏独享型(1:8)。
- general:通用型(1:4)。
- armFlavors2:鲲鹏独享型(1:4)。
- exclusive:独享型(1:4)。仅基础版主备版实例支持。
- armExclusive:鲲鹏独享型(1:4)。仅基础版主备版实例支持。
- economical:惠选型(1:4)。
- economical2:惠选型(1:8)。
请求示例
查询数据库规格。
https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/flavors?offset=0&limit=10&ha_mode=centralization_standard&version=3.100&spec_code=gaussdb.opengauss.ee.dn.m6.2xlarge.8.in
响应示例
{
"flavors": [
{
"vcpus": "2",
"ram": "16",
"availability_zone": [
"az2xahz",
"az1xahz",
"az3xahz"
],
"version": "1.4",
"name": "GaussDB",
"spec_code": "gaussdb.opengauss.ee.dn.m6.large.8.in",
"az_status": {
"az2xahz": "normal",
"az1xahz": "normal",
"az3xahz": "normal"
},
"group_type": "normal2"
}
],
"total": 1
}
状态码
-
正常
200
-
异常
请参见状态码。
错误码
请参见错误码。