Querying Database Specifications

Function

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

URI

Request Parameters

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 3 Response body parameter

Parameter

Type

Description

flavors

Array of MysqlFlavorsInfo objects

Instance specifications.

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 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

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

Example Response

Status code: 202

Success.

{
  "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 Status Codes.

Error Code

For details, see Error Codes.