doc-exports/docs/opengauss/api-ref/opengauss_newapi_0001.html

Rebooting a DB Instance

Function

This API is used to reboot a DB instance. Before calling this API:

• Learn how to authenticate this API.
• Understand the API in Using APIs.
• Obtain the required region and endpoint.

Constraints

The instance cannot reboot when it is being created, scaled, backed up, and restored.

URI

• URI format

  POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/restart

• Example

  https://gaussdb.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/restart

• Parameter description

  Table 1 Parameter description

  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	DB instance ID.

Request

None

Response

• Normal response

  Table 2 Parameter description

  Parameter	Type	Description
  job_id	String	Task ID.

• Example normal response

  {
  	"job_id": "2b414788a6004883a02390e2eb0ea227"
  }

• Abnormal response

  For details, see Abnormal Request Results.

Status Code

• Normal

  202

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Instance Management