docs
api
Cloud PostgreSQL Database(UDB NVMe)
CreateUPgSQLInstance

Create PG Cloud Database - CreateUPgSQLInstance

Overview

Create PG Cloud Database

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is CreateUPgSQLInstance.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesYes
ZonestringAvailability Zone. See Availability Zone ListYes
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.No
NamestringInstance name, at least 6 charactersYes
DBVersionstringVersion of PostgreSQL, pg10.4:postgresql-10.4, pg13.4:postgresql-13.4Yes
ParamGroupIDintConfiguration parameter group id used by the DB instanceYes
AdminPasswordstringAdministrator PasswordYes
PortintThe default port is 5432.Yes
DiskSpacestringDisk Space (GB)Yes
MachineTypestringMachine configuration type, 2 cores 4G machine: o.pgsql2m.mediumYes
SubnetIDstringSubnet IDYes
VPCIDstringID of VPCYes
InstanceModestringUDB 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 NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
InstanceIDstringResource IDNo

Example

Request Example

https://api.surfercloud.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

{
  "Action": "CreateUPgSQLInstanceResponse",
  "InstanceID": "PKvSpnFx",
  "RetCode": 0
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved