Restarting a DDM Instance¶

Function¶

This API is used to restart a DDM instance.

None

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

**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.

**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

Status code: 200

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

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

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

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"
}

For details, see Error Codes.

last updated: 2024-12-11 13:43 UTC - commit: 0e04c4a111cf440cbe530f17da84f5c1ac074d8f