RestartDBInstances

Last updated: 2019-11-29 19:50:41

PDF

1. API Description

Domain name for API request: cdb.tencentcloudapi.com.

This API (RestartDBInstances) is used to restart a database instance.

Notes:

  1. Only master instances can be restarted via this API.
  2. You can only restart instances in normal status with no asynchronous task being performed.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. Since Finance regions and non-Finance regions are isolated and not interconnected. If the common parameter Region is a Finance region (such as ap-shanghai-fsi), you need to specify a domain name containing the Finance region that should be identical to the value of Region field, for example: cdb.ap-shanghai-fsi.tencentcloudapi.com.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters.
| Parameter Name | Required | Type | Description |
|---------|---------|---------|---------|
| Action | Yes | String | Common parameter. The value used for this API: RestartDBInstances |
| Version | Yes | String | Common parameter. The value used for this API: 2017-03-20 |
| Region | Yes | String | Common parameter. |
| InstanceIds.N | Yes | Array of String | Instance ID array, such as: cdb-c1nl9rpv. It is identical to the instance ID displayed in the database console page. |

3. Output Parameters

Parameter Name Type Description
AsyncRequestId String ID of async task request, which can be used to query the execution result of the async task.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Error Codes

The following only lists the error codes related to the API business logic.

Error Code Description
InternalError.TaskFrameError An error occurred with the asynchronous task.
InvalidParameter Parameter error.
InvalidParameter.InstanceNotFound The instance does not exist.

5. Example

Example 1 Restart an instance

Input example

https://cdb.tencentcloudapi.com/?Action=RestartDBInstances
&InstanceIds.0=cdb-f35wr6wj
&<Common request parameters>

Output example

{
  "Response": {
    "AsyncRequestId": "9ad9c2d5-88007b27-7d2c8b8c-f2598f12",
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
  }
}

6. Other Resources

Cloud API 3.0 comes with the following development tools to make it easier to call the API.