查询所有实例规格信息 - InstanceSpecifications
功能介绍
查询指定条件下的所有实例规格信息。
该接口计划下线,建议及时切换到新接口查询数据库规格。
接口约束
该接口支持如下数据库实例:
- GeminiDB Cassandra
- GeminiDB Mongo
- GeminiDB Influx
- GeminiDB Redis
调试
您可以在API Explorer中调试该接口。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
-
-
-
-
-
-
URI
- URI格式
- URI样例
https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/flavors?region=cn-north-4&engine_name=cassandra
- 参数说明
表1 参数说明 名称
是否必选
描述
project_id
是
参数解释:
租户在某一region下的project ID。获取方法请参见获取项目ID。
约束限制:
不涉及。
取值范围:
不涉及。
默认取值:
不涉及。
region
否
参数解释:
实例所在区域。具体信息请参见地区和终端节点。
约束限制:
不涉及。
取值范围:
不涉及。
默认取值:
不涉及。
engine_name
否
参数解释:
数据库类型。
约束限制:
不涉及。
取值范围:
- 取值为“cassandra”,表示查询GeminiDB Cassandra数据库实例支持的规格。
- 取值为“mongodb”,表示查询GeminiDB Mongo数据库实例支持的规格。
- 取值为“influxdb”,表示查询GeminiDB Influx数据库实例支持的规格。
- 取值为“redis”,表示查询GeminiDB Redis数据库实例支持的规格。
默认取值:
默认为“cassandra”。
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
| 名称 | 参数类型 | 描述 |
|---|---|---|
| total_count | Integer | 参数解释: 总记录数。 取值范围: 不涉及。 |
| flavors | Array of flavors objects | 参数解释: 实例规格信息列表。 取值范围: 不涉及。 |
| 名称 | 参数类型 | 描述 |
|---|---|---|
| engine_name | String | 参数解释: 引擎名称。 取值范围: 不涉及。 |
| engine_version | String | 参数解释: 引擎版本。 取值范围: 不涉及。 |
| vcpus | String | 参数解释: CPU核数。 取值范围: 不涉及。 |
| ram | String | 参数解释: 内存大小,单位为兆字节。 取值范围: 不涉及。 |
| spec_code | String | 参数解释: 资源规格编码。例如:geminidb.cassandra.8xlarge.4 取值范围:
|
| availability_zone | Array of strings | 参数解释: 支持该规格的可用区ID。 取值范围: 该字段已废弃,请不要使用。 |
| az_status | Object | 参数解释: 规格在可用区内的状态。 取值范围:
|
请求示例
GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/flavors?region=cn-north-7&engine_name=cassandra 响应示例
状态码:200
Success.
{
"total_count" : 2,
"flavors" : [ {
"engine_name" : "cassandra",
"engine_version" : "3.11",
"vcpus" : "4",
"ram" : "16",
"spec_code" : "geminidb.cassandra.xlarge.4",
"availability_zone" : [ "az1", "az2" ],
"az_status" : {
"az1" : "normal",
"az2" : "unsupported"
}
},{
"engine_name" : "cassandra",
"engine_version" : "3.11",
"vcpus" : "8",
"ram" : "32",
"spec_code" : "geminidb.cassandra.2xlarge.4",
"availability_zone" : [ "az1", "az2" ],
"az_status" : {
"az1" : "unsupported",
"az2" : "normal"
}
} ]
} 状态码
详情请参见状态码。
错误码
详情请参见错误码。