# 查询数据库规格 - QueryingInstanceSpecifications #### 功能介绍 查询指定条件下的所有实例规格信息。 #### 接口约束 该接口支持如下数据库实例： - GeminiDB Cassandra - GeminiDB Mongo - GeminiDB Influx - GeminiDB Redis #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDBforNoSQL/doc?api=ListFlavorInfos)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | - | - | - | - | - | - | #### URI GET /v3.1/{project_id}/flavors 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一region下的project ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nosql/nosql_projectid.html)。 **约束限制：** 不涉及。 **取值范围：** 长度为32个字符，仅由英文字母和数字组成。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | engine_name | 否 | String | **参数解释：** 引擎名称。 **约束限制：** 不涉及。 **取值范围：** - 取值为"cassandra"，表示查询GeminiDB Cassandra数据库实例支持的规格。 - 取值为"mongodb"，表示查询GeminiDB Mongo数据库实例支持的规格。 - 取值为"influxdb"，表示查询GeminiDB Influx数据库实例支持的规格。 - 取值为"redis"，表示查询GeminiDB Redis数据库实例支持的规格。 **默认取值：** 不传该参数，默认为"cassandra"。 | | mode | 否 | String | **参数解释：** 实例类型。 **约束限制：** 不涉及。 **取值范围：** - 取值为"CloudNativeCluster", 表示查询云原生部署模式支持的规格。 - 取值为"EnhancedCluster", 表示查询GeminiDB Influx经典部署模式集群增强版实例支持的规格。 **默认取值：** 不传该参数表示查询数据库类型下的所有经典部署模式支持的规格。 | | product_type | 否 | String | **参数解释：** 产品类型。 **约束限制：** 当查询GeminiDB Redis云原生部署模式集群类型必传此参数。 **取值范围：** Capacity ：容量型 **默认取值：** 不涉及。 | | offset | 否 | Integer | **参数解释：** 索引位置，偏移量。 **约束限制：** 不涉及。 **取值范围：** 取值必须为数字，且不能为负数。 **默认取值：** 从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询）。 | | limit | 否 | Integer | **参数解释：** 查询规格信息上限值。 **约束限制：** 不涉及。 **取值范围：** 1\~100。 **默认取值：** 不传该参数时，默认查询前100条规格信息。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码： 200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_count | Integer | **参数解释：** 总记录数。 **取值范围：** 不涉及。 | | flavors | Array of [Flavors] objects | **参数解释：** 实例规格信息列表。 **取值范围：** 不涉及。 | 表5Flavors | 参数 | 参数类型 | 描述 | |:---|:---|:---| | engine_name | String | **参数解释**： 引擎名称。 **取值范围**： - 取值为"cassandra"，表示响应结果为GeminiDB Cassandra数据库实例支持的规格。 - 取值为"mongodb"，表示响应结果为GeminiDB Mongo数据库实例支持的规格。 - 取值为"influxdb"，表示响应结果为GeminiDB Influx数据库实例支持的规格。 - 取值为"redis"，表示响应结果为GeminiDB Redis数据库实例支持的规格。 | | engine_version | String | **参数解释**： 引擎版本。 **取值范围**： 不涉及。 | | vcpus | String | **参数解释**： CPU核数。 **取值范围**： 不涉及。 | | ram | String | **参数解释：** 内存大小，单位为兆字节。 **取值范围：** 不涉及。 | | spec_code | String | **参数解释：** 资源规格编码。 例如：geminidb.cassandra.8xlarge.4 说明： - "geminidb.cassandra"表示Cassandra数据库产品。 - "8xlarge.4"表示节点性能规格。 **取值范围：** 不涉及。 | | availability_zone | Array of strings | **参数解释：** 支持该规格的可用区ID。 说明： 该字段已废弃，请不要使用。 | | az_status | Object | **参数解释：** 规格在可用区内的状态。 **取值范围：** - normal：表示在售。 - unsupported：表示暂不支持该规格。 - sellout：表示售罄。 | #### 请求示例 URI样例 ``` GET https://{Endpoint}/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" } } ] } ``` #### 状态码 请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。