Restarts an AnalyticDB for PostgreSQL instance.

Description

A restart takes about 3 to 30 minutes. During the restart, services are unavailable. We recommend that you restart the instance during off-peak hours. After the instance is restarted and enters the running state, you can access the instance.

Limit

You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered and may affect your business. We recommend that you take note of the limit when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes RestartDBInstance

The operation that you want to perform. Set the value to RestartDBInstance.

ClientToken String No 0c593ea1-3bea-11e9-b96b-88**********

The client token that is used to ensure the idempotence of the request. For more information, see How to ensure idempotence.

DBInstanceId String Yes gp-xxxxxxxxx

The ID of the instance.

Note You can call the DescribeDBInstances operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including instance IDs.

Response parameters

Parameter Type Example Description
RequestId String A7356493-7141-4393-8951-CDA8AB5D67EC

The ID of the request.

Examples

Sample requests

https://gpdb.aliyuncs.com/?Action=RestartDBInstance
&DBInstanceId=gp-xxxxxxxxx
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<RestartDBInstance>
         <RequestId>A7356493-7141-4393-8951-CDA8AB5D67EC</RequestId>
</RestartDBInstance>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "A7356493-7141-4393-8951-CDA8AB5D67EC"
}

Error codes

For a list of error codes, visit the API Error Center.