doc-exports/docs/ddm/api-ref/ddm_api_01_0109.html

Querying DDM Engine Information (a V3 API)

Function

This V3 API is used to query information about DDM engine.

Constraints

None

URI

• URL format

GET /v3/{project_id}/engines?offset={offset}&limit={limit}

• Parameter description

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
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 number but cannot be a negative number.
limit	No	Integer	Maximum records to be queried. Value range: 1 to 128 If the parameter value is not specified, 10 records are obtained 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.

Example Request

Querying DDM engine information

GET https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/engines?offset=0&limit=10

Response

• Normal response

Table 4 Response body parameters

Parameter	Type	Description
engine_groups	Array of EngineGroupInfo 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 EngineGroupInfo

Parameter	Type	Description
id	String	Engine ID
name	String	Engine name
version	String	Engine version

• Normal response example

{
  "engine_groups": [
    {
      "id": "036dc44a-b560-4316-9e7f-e25a60f2aea2",
      "name": "ddm",
      "version": "3.1.0.8"
    }
  ],
  "offset": 0,
  "limit": 1,
  "total": 1
}

• Abnormal response

  For details, see Abnormal Request Results.

Status Codes

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: DDM Instances