docs
api
Cloud PostgreSQL Database(UDB NVMe)
GetUPgSQLParamTemplate

Get Template Information - GetUPgSQLParamTemplate

Overview

Get Template Information

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is GetUPgSQLParamTemplate.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
GroupIDintTemplate IDYes

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
Dataarray[Param]Parameter ListNo

Data Model

Param

Field NameTypeDescription InformationRequired
KeystringNo
ValuestringNo
ValueTypeintNo
AllowedValstringNo
ApplyTypeintNo
ModifiablebooleanNo
FormatTypeintNo

Example

Request Example

https://api.surfercloud.com/?Action=GetUPgSQLParamTemplate
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=GJtXaIvw
&GroupId=AwjAPmTr

Response Example

{
  "Action": "GetUPgSQLParamTemplateResponse",
  "Data": {},
  "Message": "XwCzQBxT",
  "RetCode": 0
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved