查询数据库规格
功能介绍
查询指定条件下的所有实例规格信息。
接口约束
该接口支持如下数据库实例:
- GeminiDB Cassandra
- GeminiDB Mongo
- GeminiDB Influx
- GeminiDB Redis
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET https://{Endpoint}/v3.1/{project_id}/flavors
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
engine_name |
否 |
String |
参数解释: 数据库类型。 约束限制: 不涉及。 取值范围:
默认取值: 不传该参数,默认为“cassandra”。 |
mode |
否 |
String |
参数解释: 实例类型。 约束限制: 不涉及。 取值范围:
默认取值: 不传该参数表示查询数据库类型下的所有经典部署模式支持的规格。 |
product_type |
否 |
String |
参数解释: 产品类型。 约束限制: 当创建GeminiDB Redis云原生部署模式集群类型必传此参数。 取值范围:
默认取值: 不涉及。 |
offset |
否 |
Integer |
参数解释: 索引位置,偏移量。 约束限制: 不涉及。 取值范围: 取值必须为数字,且不能为负数。 默认取值: 从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询)。 |
limit |
否 |
Integer |
参数解释: 查询规格信息上限值。 约束限制: 不涉及。 取值范围: 1~100。 默认取值: 不传该参数时,默认查询前100条规格信息。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
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://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3.1/375d8d8fad1f43039e23d3b6c0f60a19/flavors?engine_name=cassandra&offset=0&limit=10
响应示例
状态码: 200
Success
{ "total_count" : 4, "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" } }, { "engine_name" : "cassandra", "engine_version" : "3.11", "vcpus" : "16", "ram" : "64", "spec_code" : "geminidb.cassandra.4xlarge.4", "availability_zone" : [ "az1", "az2" ], "az_status" : { "az1" : "normal", "az2" : "sellout" } }, { "engine_name" : "cassandra", "engine_version" : "3.11", "vcpus" : "32", "ram" : "128", "spec_code" : "geminidb.cassandra.8xlarge.4", "availability_zone" : [ "az1", "az2" ], "az_status" : { "az1" : "normal", "az2" : "normal" } } ] }
状态码
请参见状态码。
错误码
请参见错误码。