Help Center/ Distributed Database Middleware/ API Reference (Kuala Lumpur Region)/ DDM Instance Management/ Querying DDM Engine
Updated on 2022-08-17 GMT+08:00
View PDF
Share

Querying DDM Engine

Function

This API is used to query information about DDM engine.

Constraints

None

URI

GET /v2/{project_id}/engines
Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

engineGroups

Array of EngineGroupsInfo objects

Information of available engines

total

Integer

Number of engine versions
Table 4 EngineGroupsInfo

Parameter

Type

Description

id

String

Engine ID

name

String

Engine name

version

String

Engine version

supportAzs

Array of SupportAzsInfo objects

AZs
Table 5 SupportAzsInfo

Parameter

Type

Description

code

String

AZ code

name

String

AZ name

favored

Boolean

Whether the AZ supports the current engine version

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Example Request

GET https://{endpoint}/v2/{project_id}/engines

Example Response

Status code: 200

OK

{
    "engineGroups": [
        {
            "id": "ac68ac8d-35ab-3924-8de2-a186ff5f960e",
            "name": "ddm",
            "version": "2.4.2.9",
            "supportAzs": [
                {
                    "code": "az1xahz",
                    "name": "az1xahz",
                    "favored": false
                },
                {
                    "code": "az2xahz",
                    "name": "az2xahz",
                    "favored": true
                },
                {
                    "code": "az3xahz",
                    "name": "az3xahz",
                    "favored": false
                }
            ]
        },
        {
            "id": "c790ea2d-9d51-3fa8-9304-3b065f274aa9",
            "name": "ddm",
            "version": "2.3.3.6",
            "supportAzs": [
                {
                    "code": "az1xahz",
                    "name": "az1xahz",
                    "favored": false
                },
                {
                    "code": "az2xahz",
                    "name": "az2xahz",
                    "favored": true
                },
                {
                    "code": "az3xahz",
                    "name": "az3xahz",
                    "favored": false
                }
            ]
        }
    ],
    "total": 2
}

Status code: 400

bad request

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

Status code: 500

server error

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

Status Codes

Status Code

Description

200

OK

400

bad request

500

server error

Error Codes

For details, see Error Codes.

Parent topic: DDM Instance Management