# Create PG Cloud Database - CreateUPgSQLInstance

## Overview

Create PG Cloud Database






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `CreateUPgSQLInstance`.                      | **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|
| **Name** | string | Instance name, at least 6 characters |**Yes**|
| **DBVersion** | string | Version of PostgreSQL, pg10.4:postgresql-10.4, pg13.4:postgresql-13.4 |**Yes**|
| **ParamGroupID** | int | Configuration parameter group id used by the DB instance |**Yes**|
| **AdminPassword** | string | Administrator Password |**Yes**|
| **Port** | int | The default port is 5432. |**Yes**|
| **DiskSpace** | string | Disk Space (GB) |**Yes**|
| **MachineType** | string | Machine configuration type, 2 cores 4G machine: o.pgsql2m.medium |**Yes**|
| **SubnetID** | string | Subnet ID |**Yes**|
| **VPCID** | string | ID of VPC |**Yes**|
| **InstanceMode** | string | UDB instance mode type, optional values are as follows: "Normal": Standard version UDB instance "HA": High availability version UDB instance The default is "Normal". |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|
| **InstanceID** | string | Resource ID |No|




## Example

### Request Example
    
```
https://api.scloudsg.com/?Action=CreateUPgSQLInstance
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=rRMHysZc
&Name=nyWogTGQ
&DBVersion=BwXYndWK
&ParamGroupID=9
&AdminPassword=ttiytaRC
&Port=1
&DiskSpace=wugxxeez
&MachineType=EtOtOWVL
&SubnetID=vYfdUNLf
&VPCID=JkndYJUI
&InstanceMode=YgRHGskR
```

### Response Example
    
```json
{
  "Action": "CreateUPgSQLInstanceResponse",
  "InstanceID": "PKvSpnFx",
  "RetCode": 0
}
```