# Restart PG Instance - RestartUPgSQLInstance

## Overview

Restart PG Instance






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `RestartUPgSQLInstance`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.scloudsg.com/uaccount/api_manage)                                             | **Yes** |
| **Signature**  | string  | User signature generated based on public key and API command, see [Signature Algorithm](/docs/api/summary/signature.md)  | **Yes** |

### Request Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Region** | string | Region. See [List of Regions and Availability Zones](/docs/api/summary/regionlist) |**Yes**|
| **Zone** | string | Availability Zone. See [Availability Zone List](/docs/api/summary/regionlist) |**Yes**|
| **ProjectId** | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the [GetProjectList interface](/docs/api/summary/get_project_list). |No|
| **InstanceID** | string | Instance ID |**Yes**|
| **RestartHost** | boolean | Do you also want to restart the host? |No|
| **ForceToRestart** | boolean | Is a forced restart required? |No|

### Response Field

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **RetCode** | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. |**Yes**|
| **Action** | string | Operation command name. |**Yes**|
| **Message** | string | Returns an error message, providing detailed description when `RetCode` is non-zero. |No|




## Example

### Request Example
    
```
https://api.scloudsg.com/?Action=RestartUPgSQLInstance
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=GEQHsAQm
&InstanceID=EImiOsXx
&RestartHost=JbxTPsEI
&ForceToRestart=zXKqTXiO
```

### Response Example
    
```json
{
  "Action": "RestartUPgSQLInstanceResponse",
  "Message": "ffBquxIW",
  "RetCode": 0
}
```