Help Center/ Distributed Database Middleware/ API Reference/ APIs (Recommended)/ DDM Instances/ Querying DDM Node Classes Available in an AZ
Updated on 2022-09-15 GMT+08:00
View PDF

Querying DDM Node Classes Available in an AZ

Function

This API is used to query DDM node classes available in an AZ.

Constraints

None

URI

GET /v2/{project_id}/flavors

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region
Table 2 Query parameters

Parameter

Mandatory

Type

Description

engine_id

Yes

String

Engine ID, which can be obtained by calling the API for querying DDM engine information.

offset

No

Integer

Which page the server starts returning items. The start value cannot be less than 0. The default value is 0.

Minimum value: 0

limit

No

Integer

Number of records displayed on each page. The value is greater than 0 and not greater than 128. The default value is 128.

Minimum value: 1

Maximum value: 128

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

computeFlavorGroups

Array of ComputeFlavorGroupsInfo objects

Compute flavor information
Table 5 ComputeFlavorGroupsInfo

Parameter

Type

Description

groupType

String

Compute resource architecture type. The value can be x86 or ARM.

computeFlavors

Array of ComputeFlavors objects

Compute flavors

offset

Integer

Which page the server starts returning items

limit

Integer

Number of records displayed on each page

total

Integer

Total number of compute flavors
Table 6 ComputeFlavors

Parameter

Type

Description

id

String

Flavor ID

typeCode

String

Resource type code

code

String

VM flavor types recorded in DDM

iaasCode

String

VM flavor types recorded by the IaaS layer

cpu

String

Number of CPUs

mem

String

Memory size, in GB

maxConnections

String

Maximum number of connections

serverType

String

Compute resource type

architecture

String

Compute resource architecture type. The value can be x86 or ARM.

azStatus

Object

AZ status

regionStatus

String

Region status

groupType

String

Compute resource architecture type. The value can be x86 or ARM.

dbType

String

Engine type

extendFields

Object

Extension field for storing AZ information

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Example Request

GET https://{endpoint}/v2/{project_id}/flavors?engine_id={engine_id}

Example Response

Status code: 200

OK

{
  "computeFlavorGroups" : [ {
    "offset" : "0,",
    "limit" : "128,",
    "total" : "6,",
    "groupType" : "X86,",
    "computeFlavors" : [ {
      "id" : "8f2e696c-a9c1-30bd-af90-25522bc67606,",
      "typeCode" : "hws.resource.type.ddm,",
      "code" : "ddm.c3.large.2,",
      "iaasCode" : "c3.large.2,",
      "cpu" : "2,",
      "mem" : "4,",
      "maxConnections" : "null,",
      "serverType" : "KVM,",
      "architecture" : "X86,",
      "azStatus" : {
        "az2.dc0" : "unsupported,",
        "az3xahz" : "normal,",
        "az2xahz" : "normal,",
        "az1xahz" : "normal"
      },
      "regionStatus" : "normal,",
      "dbType" : "DDM,",
      "extendFields" : {
        "azCode" : "az2.dc0,az3xahz,az2xahz,az1xahz,",
        "azDescription" : "az2.dc0,az3xahz,az2xahz,az1xahz"
      }
    } ]
  }, {
    "offset" : "0,",
    "limit" : "128,",
    "total" : "3,",
    "groupType" : "ARM,",
    "computeFlavors" : [ {
      "id" : "87a6cb8b-0c56-3e16-a91d-9b680a1f8b7f,",
      "typeCode" : "hws.resource.type.ddm,",
      "code" : "ddm.rc6.large.2,",
      "iaasCode" : "kc1.xlarge.2,",
      "cpu" : "4,",
      "mem" : "8,",
      "maxConnections" : "null,",
      "serverType" : "KVM,",
      "architecture" : "ARM,",
      "azStatus" : {
        "az2.dc0" : "unsupported,",
        "az3xahz" : "normal,",
        "az2xahz" : "normal,",
        "az1xahz" : "normal"
      },
      "regionStatus" : "normal,",
      "groupType" : "null,",
      "dbType" : "DDM,",
      "extendFields" : {
        "azCode" : "az2.dc0,az3xahz,az2xahz,az1xahz,",
        "azDescription" : "az2.dc0,az3xahz,az2xahz,az1xahz"
      }
    } ]
  } ]
}

Status code: 400

bad request

{
  "externalMessage" : "Parameter error.",
  "errCode" : "DBS.280001"
}

Status code: 500

server error

{
  "externalMessage" : "Server failure.",
  "errCode" : "DBS.200412"
}

Status Codes

Status Code

Description

200

OK

400

bad request

500

server error

Error Codes

For details, see Error Codes.

Parent topic: DDM Instances