查询所有实例规格信息

功能介绍

查询指定条件下的所有实例规格信息。

接口约束

该接口支持如下数据库实例：

• GeminiDB Cassandra
• GeminiDB Mongo
• GeminiDB Influx
• GeminiDB Redis

调试

您可以在API Explorer中调试该接口。

URI

• URI格式

  GET https://{Endpoint}/v3/{project_id}/flavors?region={region}&engine_name={engine_name}

• 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”。

请求消息

无。

响应消息

• 正常响应要素说明

  表2 要素说明

  名称	参数类型	描述
  total_count	Integer	总记录数。
  flavors	Array of objects	实例规格信息列表。详情请参见表3。

  表3 flavors字段数据结构说明

  名称	参数类型	描述
  engine_name	String	接口名称。
  engine_version	String	接口版本。
  vcpus	String	CPU核数。
  ram	String	内存大小，单位为兆字节。
  spec_code	String	资源规格编码。 示例：geminidb.cassandra.8xlarge.4 说明： “geminidb.cassandra”表示云数据库 GeminiDB的Cassandra数据库产品。 “8xlarge.4”表示节点性能规格。
  availability_zone	Array of strings	支持该规格的可用区ID。 说明： 该字段已废弃，请不要使用。
  az_status	Object	规格在可用区内的状态，包含以下状态： normal，在售。 unsupported，暂不支持该规格。 sellout，售罄。

响应样例中“az_status”字段下可用区的值为示例值。

• 正常响应样例

  {  
      "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"
               }
          }  
      ]  
  }

• 异常响应

  请参见异常请求结果。

状态码

详情请参见状态码。

错误码

详情请参见错误码。