Files

Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: wangdengke2 <wangdengke2@huawei.com>
Co-committed-by: wangdengke2 <wangdengke2@huawei.com>

2026-03-03 12:01:43 +00:00

21 KiB

Raw Blame History

Restarting a DDM Instance (a V1 API)

Function

This API is used to restart a DDM instance.

Constraints

This API is to be removed soon, so it is not recommended.
Use the latest API. For details, see Restarting a DDM Instance (a V3 API).

URI

POST /v1/{project_id}/instances/{instance_id}/action

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region
instance_id	Yes	String	DDM instance ID

Request Parameters

**Table 2** Request header 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.
Content-Type	Yes	String	MIME type of the request body. Value range: application/json application/json;charset=utf-8

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
restart	No	RestarInstanceInfo object	Restart-related parameter

**Table 4** RestarInstanceInfo
Parameter	Mandatory	Type	Description
type	No	String	Restart type, which can be soft or hard. soft: Only the process is restarted. hard: The instance VM is forcibly restarted. Enumerated values: soft hard

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
instanceId	String	DDM instance ID
instanceName	String	DDM instance name
jobId	String	Task ID

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

POST https://ddm.eu-de.otc.t-systems.com/v1/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/action

{
  "restart" : {
    "type" : "soft"
  }
}

Example Response

Status code: 200

{
  "instanceId" : "28e8841d0b9c4f6a9a30742ee60e1068in09",
  "instanceName" : "ddm-fb88-test",
  "jobId" : "1eb697c0-1842-43a3-8671-f562d0385cb9"
}

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: Instance Management

21 KiB Raw Blame History