Help Center/ Distributed Database Middleware/ API Reference/ APIs (Recommended)/ DDM Instances/ Restarting a DDM Instance
Updated on 2026-07-08 GMT+08:00
View PDF

Restarting a DDM Instance

Function

This API is used to restart a DDM instance.

Constraints

None

URI

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

Table 1 URI 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.

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.

You can obtain the token by calling the IAM API used to obtain a user token.
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

orderId

String

Order ID. This parameter is returned only for yearly/monthly instances.

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

Restarting a DDM instance (only the instance process)

POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/action

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

Example Response

Status code: 200

ok

{
  "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: DDM Instances