Get the description of the cloud database instance - GetUPgSQLInstance

Overview

Get PG Cloud Database Instance Description

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `GetUPgSQLInstance`.	Yes
PublicKey	string	The user's public key can be obtained from Console (opens in a new tab)	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Request Parameters

Parameter Name	Type	Description Information	Required
Region	string	Region. See List of Regions and Availability Zones	Yes
Zone	string	Availability Zone. See Availability Zone List	No
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.	No
InstanceID	string	Resource ID	Yes

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
DataSet	UDBInstance		Yes

Data Model

UDBInstance

Field Name	Type	Description Information	Required
Zone	string	Availability Zone of the DB Instance	No
BackupZone	string	Backup Availability Zone	No
InstanceID	string	DB Instance id	No
Name	string	Instance Name	No
DBVersion	string	DB Version	No
ParamGroupID	int	Configuration parameter group id used by the DB instance	No
AdminUser	string	Administrator account name, default is root	No
IP	string	The text "DBip" doesn't seem to be a standard Chinese phrase or term related to cloud computing. Could you please provide more context or check if there might be a typo?	No
Port	int	DB Port	No
VPCID	string	ID of VPC	No
SubnetID	string	Subnet ID	No
Remark	string	Note	No
BackupCount	int	The number of backup files retained, default is 7 times	No
BackupBeginTime	int	Backup start time, measured in hours, default is 3 o'clock.	No
BackupTimeRange	int	Backup time period, range [0,23]	No
BackupDate	string	The backup date tag used for setting up the backup strategy. There are 7 bits in total, each representing the backup status of one day of the week. 0 means the backup is turned off for that day, 1 means the backup is turned on. The rightmost bit is the backup switch for Sunday, and the rest from right to left are the backup configuration switches for Monday to Saturday, respectively. At least two days of backup must be set each week. For example: 1100000 means the automatic backup function for Saturday and Friday is turned on.	No
State	string	DB Status Tags Init: Initializing, Fail: Installation Failed, Starting: Starting Up, Running: Running, Shutdown: Shutting Down, Shutoff: Shut Off, Delete: Deleted, Upgrading: Upgrading, Promoting: Promoting to Standalone Database in Progress, Recovering: Recovering, Recover fail: Recovery Failed	No
CreateTime	int	DB instance creation time, using UTC timestamp	No
ModifyTime	int	DB instance modification time, using UTC timestamp	No
ExpiredTime	int	Expiration time of the DB instance, using UTC timestamp	No
Cpu	int	CPU Limit (Core), default according to configuration model	No
MemoryLimit	int	Memory Limit (MB), default based on configuration model	No
DiskSpace	int	Disk Space (GB), default according to configuration model	No
DiskUsedSize	float	Used space of DB instance disk, unit GB	No
DataFileSize	float	Size of DB instance data file, in GB	No
SystemFileSize	float	Size of DB instance system file, unit GB	No
LogFileSize	float	Size of DB instance log file, in GB	No
InstanceMode	string	Normal/High Availability	No
MachineType	string	Configuration Model Name	No

Example

Request Example

https://api.surfercloud.com/?Action=GetUPgSQLInstance
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=NmpXWjBt
&InstanceID=zercJTxf

Response Example

{
  "Action": "GetUPgSQLInstanceResponse",
  "DataSet": {},
  "Message": "BTbgDWAl",
  "RetCode": 0
}

GetUPgSQLBackupURL GetUPgSQLInstanceLog