Help Center/ Distributed Database Middleware/ API Reference/ APIs (Recommended)/ DDM Instances/ Querying DDM Engine Information
Updated on 2026-06-02 GMT+08:00
View PDF

Querying DDM Engine Information

Function

This API is used to query information about DDM engine.

Constraints

None

URI

GET /v2/{project_id}/engines?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

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 engines to be queried.

Value range: 1 to 128.

If the parameter value is not specified, 128 nodes 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

engineGroups

Array of EngineGroupsInfo objects

Information of available engines

offset

Integer

Which page the server starts returning items

limit

Integer

Number of records displayed on each page

total

Integer

Number of engine versions
Table 5 EngineGroupsInfo

Parameter

Type

Description

id

String

Engine ID

name

String

Engine name

version

String

Engine version

supportAzs

Array of SupportAzsInfo objects

AZs
Table 6 SupportAzsInfo

Parameter

Type

Description

code

String

AZ code

name

String

AZ name

favored

Boolean

Whether the current AZ is supported

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 engine information

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

Example Response

Status code: 200

OK

{
  "engineGroups" : [ {
    "id" : "b6907aa2-aacb-3ac9-9782-b90b152d456c",
    "name" : "ddm",
    "version" : "3.0.8",
    "supportAzs" : [ {
      "code" : "az1",
      "name" : "az1",
      "favored" : false
    }, {
      "code" : "az2",
      "name" : "az2",
      "favored" : true
    } ]
  } ],
  "offset" : 0,
  "limit" : 128,
  "total" : 1
}

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