Docs
api
Cloud PostgreSQL Database(UDB NVMe)
ListUPgSQLParamTemplate

Get the available parameter template list - ListUPgSQLParamTemplate

Overview

Get the available parameter template list

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is ListUPgSQLParamTemplate.Yes
PublicKeystringThe user’s public key can be obtained from ConsoleYes
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
OffsetintOffset, default is 0,100No
CountintTotalNo

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[TemplateGroup]Parameter Template InformationYes

Data Model

TemplateGroup

Field NameTypeDescription InformationRequired
GroupIDintParameter Template IDNo
GroupNamestringParameter Template NameNo
DBVersionstringApplication’s DB VersionNo
DescriptionstringDescription InformationNo
ModifiablebooleanCan it be modified?No
ParamGroupTypeNamestringTemplate Group Type NameNo

Example

Request Example

https://api.dezai.com/?Action=ListUPgSQLParamTemplate
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=EJimHTRB
&Offset=4
&Count=1

Response Example

{
  "Action": "ListUPgSQLParamTemplateResponse",
  "Data": [
    {
      "DbVersion": "mgmMARnm",
      "Description": "TGVwMNYJ",
      "GroupId": 1,
      "GroupName": "ytGWHtVS",
      "Modifiable": true,
      "ParamGroupTypeName": "znltxisP"
    }
  ],
  "Message": "YabdGJdS",
  "RetCode": 0
}