Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Instance Management/ Rebooting a DB Instance
Updated on 2025-08-18 GMT+08:00
View PDF

Rebooting a DB Instance

Function

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

Constraints

The instance cannot reboot when it is being created, scaled, restored, or its instance specifications is being changed.

URI

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

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

Restrictions:

None

Value range:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

None

instance_id

Yes

String

Instance ID.

Request Parameters

None

Response Parameters

Table 2 Response parameters

Parameter

Type

Description

job_id

String

Task ID.

Example Request

POST https://gaussdb-opengauss.eu-west-101.myhuaweicloud.eu/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/restart

Example Response

{
	"job_id": "2b414788a6004883a02390e2eb0ea227"
}

Status Code

Error Code

For details, see Error Codes.

Parent topic: Instance Management