Rebooting a DB Instance

Function

This API is used to reboot a DB instance.

• Before calling this API, learn how to authenticate it.
• Before calling this API, learn about request header parameters.

Constraints

• The DB instance cannot reboot when it is being created, scaled, backed up, frozen, restored, or its instance class or port is being changed.
• The RDS DB instance will be unavailable during the reboot process. Exercise caution when performing this operation.

URI

• URI format

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

• Parameter description

  Table 1 Parameters

  Parameter	Mandatory	Description
  project_id	Yes	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
  instance_id	Yes	Definition Instance ID. Constraints N/A Range N/A Default Value N/A

Request

Example Request

• Reboot an RDS for MySQL or RDS for PostgreSQL instance.

  POST https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action
  {
        "restart": {}
  }

• Reboot an RDS for SQL Server instance.

  { 
     "restart" : { 
       "restart_server" : false, 
       "forcible" : false, 
       "delay" : false 
     } 
   }

• Forcibly reboot an RDS for SQL Server instance.

  { 
     "restart" : { 
       "restart_server" : false, 
       "forcible" : true, 
       "delay" : false 
     } 
   }

• Reboot an RDS for SQL Server instance during the maintenance window.

  { 
     "restart" : { 
       "restart_server" : false, 
       "forcible" : false, 
       "delay" : true 
     } 
   }

• Reboot the VM of an RDS for SQL Server instance.

  { 
     "restart" : { 
       "restart_server" : true, 
       "forcible" : false, 
       "delay" : false 
     } 
   }

Response

• Normal response

  Table 4 Parameters

  Parameter	Type	Description
  job_id	String	Definition Task ID. Range N/A

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