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

Restarting a DDM Instance

Function

This API is used to restart a specified DDM instance.

Constraints

None

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 the IAM API (value of X-Subject-Token in the response header).
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

restart

No

RestarDDMInstanceInfo object

Restart-related parameter
Table 4 Parameters for restarting a DDM instance

Parameter

Mandatory

Type

Description

type

No

String

Restart type. The value can be soft or hard. The default value is soft. This parameter only applies for DDM instances of version 1.0. For DDM 2.0, this parameter may not be available. In this case, only processes are restarted by default.

  • soft: Only processes are restarted.
  • hard: The instance VM is forcibly restarted.

Possible values are as follows:

  • soft
  • hard

Response Parameters

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Example Request

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

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

Example Response

Status code: 400

bad request

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

Status code: 500

server error

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

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: DDM Instance Management