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

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?engine_id={engine_id}&offset={offset}&limit={limit}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region

To obtain this value, see Obtaining a Project ID.
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

Index offset.

The query starts from the next piece of data indexed by this parameter. The value is 0 by default.

The value must be a positive integer.

limit

No

Integer

Maximum node classes to be queried.

Value range: 1 to 128.

If the parameter value is not specified, 10 node classes are queried by default.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

You can obtain the token by calling the IAM API used to obtain a 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

Class 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 vCPUs

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

Map<String,String>

Status of the AZ where node classes are available. The key is the AZ ID and the value is the AZ status. The value can be:

  • normal: indicates that the node classes in the AZ are available.
  • unsupported: indicates that the node classes are not supported by the AZ.
  • sellout: indicates that the node classes in the AZ are sold out.

regionStatus

String

Region status

groupType

String

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

dbType

String

Engine type

extendFields

Map<String,String>

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

Querying DDM node classes available in an AZ

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

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