Get the available parameter template list - ListUPgSQLParamTemplate

Overview

Get the available parameter template list

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `ListUPgSQLParamTemplate`.	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	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.	No
Offset	int	Offset, default is 0,100	No
Count	int	Total	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
Data	array[TemplateGroup]	Parameter Template Information	Yes

Data Model

TemplateGroup

Field Name	Type	Description Information	Required
GroupID	int	Parameter Template ID	No
GroupName	string	Parameter Template Name	No
DBVersion	string	Application's DB Version	No
Description	string	Description Information	No
Modifiable	boolean	Can it be modified?	No
ParamGroupTypeName	string	Template Group Type Name	No

Example

Request Example

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

ListUPgSQLMachineType ListUPgSQLVersion