:original_name: gaussdb_11_0002.html

.. _gaussdb_11_0002:

Querying Database Specifications
================================

Function
--------

This API is used to query the database specifications of a specified DB engine version. Before calling this API:

-  Learn how to :ref:`authorize and authenticate <gaussdb_03_0001>` it.
-  Obtain the required :ref:`region and endpoint <gaussdb_00_0003>`.

URI
---

-  URI format

   GET https://{endpoint}/mysql/v3/{project_id}/flavors/{database_name}?version_name={version_name}&spec_code={spec_code}&availability_zone_mode={availability_zone_mode}

-  Example

   GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/flavors/gaussdb-mysql

-  Parameter description

   .. table:: **Table 1** Parameter description

      +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
      | Name                   | Mandatory       | Type            | Description                                                                                                           |
      +========================+=================+=================+=======================================================================================================================+
      | project_id             | Yes             | String          | Project ID of a tenant in a region.                                                                                   |
      |                        |                 |                 |                                                                                                                       |
      |                        |                 |                 | To obtain this value, see :ref:`Obtaining a Project ID <gaussdb_10_0004>`.                                            |
      +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
      | database_name          | Yes             | String          | DB engine. Its value is case-insensitive and can be:                                                                  |
      |                        |                 |                 |                                                                                                                       |
      |                        |                 |                 | gaussdb-mysql                                                                                                         |
      +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
      | version_name           | No              | String          | DB version number. To obtain this value, see :ref:`Querying Version Information About a DB Engine <gaussdb_11_0001>`. |
      |                        |                 |                 |                                                                                                                       |
      |                        |                 |                 | Currently, only MySQL 8.0 is supported.                                                                               |
      +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
      | availability_zone_mode | Yes             | String          | AZ mode. Its value can be **single** or **multi** and is case-insensitive.                                            |
      +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+
      | spec_code              | No              | String          | Specification code.                                                                                                   |
      +------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------+

Request Parameters
------------------

.. table:: **Table 2** Request header parameters

   +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | Parameter    | Mandatory | Type   | Description                                                                                                                                                                             |
   +==============+===========+========+=========================================================================================================================================================================================+
   | X-Auth-Token | Yes       | String | User token.                                                                                                                                                                             |
   +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | X-Language   | No        | String | Language.                                                                                                                                                                               |
   +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | Content-Type | Yes       | String | MIME type of the request body. You are advised to use the default value **application/json**. For APIs used to upload objects or images, the value can vary depending on the flow type. |
   +--------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Response Parameters
-------------------

**Status code: 202**

.. table:: **Table 3** Response body parameter

   +-----------+--------------------------------------------------------------------------------------------------------------------+--------------------------+
   | Parameter | Type                                                                                                               | Description              |
   +===========+====================================================================================================================+==========================+
   | flavors   | Array of :ref:`MysqlFlavorsInfo <gaussdb_11_0002__en-us_topic_0000001181244182_response_mysqlflavorsinfo>` objects | Instance specifications. |
   +-----------+--------------------------------------------------------------------------------------------------------------------+--------------------------+

.. _gaussdb_11_0002__en-us_topic_0000001181244182_response_mysqlflavorsinfo:

.. table:: **Table 4** MysqlFlavorsInfo

   +-----------------------+-----------------------+------------------------------------------------------------------------------------------+
   | Parameter             | Type                  | Description                                                                              |
   +=======================+=======================+==========================================================================================+
   | vcpus                 | String                | Number of vCPUs. For example, the value **1** indicates 1 vCPU.                          |
   +-----------------------+-----------------------+------------------------------------------------------------------------------------------+
   | ram                   | String                | Memory size in GB.                                                                       |
   +-----------------------+-----------------------+------------------------------------------------------------------------------------------+
   | type                  | String                | Specification type. The value can be **arm**.                                            |
   +-----------------------+-----------------------+------------------------------------------------------------------------------------------+
   | id                    | String                | Specification ID. The value must be unique.                                              |
   +-----------------------+-----------------------+------------------------------------------------------------------------------------------+
   | spec_code             | String                | Resource specification code. Its value is same as the value of **flavor_ref**.           |
   |                       |                       |                                                                                          |
   |                       |                       | For example, **gaussdb.mysql.4xlarge.arm.8**                                             |
   +-----------------------+-----------------------+------------------------------------------------------------------------------------------+
   | version_name          | String                | DB version number.                                                                       |
   +-----------------------+-----------------------+------------------------------------------------------------------------------------------+
   | instance_mode         | String                | DB instance type. Its value is **Cluster**.                                              |
   +-----------------------+-----------------------+------------------------------------------------------------------------------------------+
   | az_status             | Map<String,String>    | Status of the AZ where the specification belongs. Its value can be any of the following: |
   |                       |                       |                                                                                          |
   |                       |                       | -  **normal**: on sale                                                                   |
   |                       |                       | -  **unsupported**: not supported                                                        |
   |                       |                       | -  **sellout**: sold out                                                                 |
   +-----------------------+-----------------------+------------------------------------------------------------------------------------------+

**Status code: 400**

.. table:: **Table 5** Response body parameters

   ========== ====== ==============
   Parameter  Type   Description
   ========== ====== ==============
   error_code String Error code.
   error_msg  String Error message.
   ========== ====== ==============

**Status code: 500**

.. table:: **Table 6** Response body parameters

   ========== ====== ==============
   Parameter  Type   Description
   ========== ====== ==============
   error_code String Error code.
   error_msg  String Error message.
   ========== ====== ==============

Example Request
---------------

.. code-block:: text

   GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/flavors/gaussdb-mysql

Example Response
----------------

**Status code: 202**

Success.

.. code-block::

   {
     "flavors" : [ {
       "vcpus" : "16",
       "ram" : "128",
       "type" : "arm",
       "id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
       "spec_code" : "gaussdb.mysql.4xlarge.arm.8",
       "instance_mode" : "Cluster",
       "version_name" : "8.0",
       "az_status" : {
         "az1" : "normal"
       }
     } ]
   }

Status Code
-----------

For details, see :ref:`Status Codes <gaussdb_10_0002>`.

Error Code
----------

For details, see :ref:`Error Codes <gaussdb_10_0003>`.