• Relational Database Service

rds
  1. Help Center
  2. Relational Database Service
  3. API Reference
  4. API v3 (Recommended)
  5. Querying Database Specifications

Querying Database Specifications

Function

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

URI

  • URI format

    PATH: /{version_id}/{project_id}/flavors/{database_name}?version_name={version_name}

    Method: GET

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    version_id

    Yes

    Specifies the API version. It is case-sensitive and the value is v3.

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

    database_name

    Yes

    Specifies the DB engine name. Its value can be any of the following and is case-insensitive:

    • MySQL
    • PostgreSQL
    • SQLServer

    version_name

    Yes

    Specifies the database version. For details about how to obtain the database version, see section Querying the DB Engine Version.

Example

GET /v3/0483b6b16e954cb88930a360d2c4e663/flavors/mysql?version_name=5.7

Request

N/A

Normal Response

  • Parameter description
    Table 2 Parameter description

    Name

    Type

    Description

    flavors

    List data structure

    Indicates the DB instance specifications information list.

    For details, see Table 3.

    Table 3 flavors field data structure description

    Name

    Type

    Description

    vcpus

    String

    Indicates the CPU size. For example, the value 1 indicates 1 vCPU.

    ram

    int

    Indicates the memory size in GB.

    spec_code

    String

    Indicates the resource specification code, such as rds.mysql.m1.xlarge.rr.

    • rds indicates the RDS product.
    • mysql indicates the DB engine.
    • m1.xlarge indicates the high memory performance specifications.
    • rr indicates the read replica (.ha indicates primary/standby DB instances).

    instance_mode

    String

    Indicates the DB instance type. Its value can be any of the following:

    • ha: indicates primary/standby DB instances.
    • replica: indicates read replicas.
    • single: indicates single DB instances.
  • Response example
    {
    	"flavors": [{
    		"vcpus": "1",
    		"ram": 2,
    		"spec_code": "rds.mysql.c2.medium.ha",
    		"instance_mode": "ha"
    	}, {
    		"vcpus": "1",
    		"ram": 2,
    		"spec_code": "rds.mysql.c2.medium.rr",
    		"instance_mode": "replica"
    	}]
    }

Abnormal Response

For details, see Abnormal Request Results.