Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ DB Engine Versions and Specifications/ Querying Specifications that a DB Instance Can Be Changed To
Updated on 2024-08-20 GMT+08:00

Querying Specifications that a DB Instance Can Be Changed To

Function

This API is used to query specifications that a DB instance can be changed to. Before calling this API:

URI

GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/available-flavors
Table 1 Parameter description

Name

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

Restrictions:

None

Value range:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

None

instance_id

Yes

String

DB instance ID.

limit

No

Integer

Number of records to be queried. The default value is 100. The value cannot be a negative number. The minimum value is 1 and the maximum value is 100. For example, if this parameter is set to 10, a maximum of 10 records can be displayed.

offset

No

Integer

Index offset. If offset is set to N, the resource query starts from the N+1 data entry. The default value is 0, indicating that the query starts from the first data entry. The value cannot be a negative number. For example, if this parameter is set to 1 and limit is set to 10, only the 2nd to 11th records are displayed.

Request Parameters

None

Response Parameters

Table 2 Parameter description

Name

Type

Description

flavors

Array of objects

Specification details.

For details, see Table 3.

total_count

integer

Total number of records.

Table 3 flavors description

Name

Type

Description

vcpus

string

Number of vCPUs.

ram

string

Memory size in GB.

spec_code

string

Resource specification code, for example, gaussdb.opengauss.ee.dn.m6.4xlarge.8.in

az_status

Map<String,String>

key indicates the AZ ID, and value indicates the specification status in the AZ. Its value can be any of the following:

  • normal: available.
  • unsupported: not supported.
  • sellout: sold out.

Example Request

Querying specifications that a DB instance can be changed to (The number of query records is 10, and the offset is 0.)
GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/available-flavors

Example Response

Instance specifications queried.
{
  "flavors" : [ { 
     "spec_code" : "gaussdb.opengauss.ee.m6.2xlarge.x868.ha", 
     "vcpus" : "8", 
     "ram" : "64", 
     "az_status" : [ { 
       "az2xahz" : "normal" 
      } ] 
    } ], 
   "total_count" : 1
}

Status Code

Error Code

For details, see Error Codes.