Querying DDM Engine Information
Function
This API is used to query information about DDM engine.
Constraints
None
URI
GET /v2/{project_id}/engines
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID of a tenant in a region |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| 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
| 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
| 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 |
| Parameter | Type | Description |
|---|---|---|
| id | String | Engine ID |
| name | String | Engine name |
| version | String | Engine version |
| supportAzs | Array of SupportAzsInfo objects | AZs |
| Parameter | Type | Description |
|---|---|---|
| code | String | AZ code |
| name | String | AZ name |
| favored | Boolean | Whether the current AZ is supported |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| errCode | String | Service error code |
| externalMessage | String | Error message |
Status code: 500
| 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" : "b6907aa2-aacb-3ac9-9782-b90b152d456c,",
"name" : "ddm,",
"version" : "3.0.8,",
"supportAzs" : [ {
"code" : "az1xahz,",
"name" : "az1xahz,",
"favored" : false
}, {
"code" : "az2xahz,",
"name" : "az2xahz,",
"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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
