Get Parameter Information - DescribeUDBParamGroup

Overview

Get parameter group detailed parameter information

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeUDBParamGroup`.	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
Offset	int	The starting offset for pagination display, specified for list operations.	Yes
Limit	int	The number of items displayed per page, specified by the list operation.	Yes
GroupId	int	Parameter group id, if specified, the description will be obtained, otherwise it is a list operation, need to specify Offset/Limit	No
IsInUDBC	boolean	Whether to select configuration in the special zone	No
RegionFlag	boolean	When the request does not specify a Zone, if set to true, it means to only pull the configuration files across availability zones. Otherwise, it will pull configuration files from all data centers (including each single availability zone and across availability zones).	No
ClassType	string	If GroupId is not specified, you can optionally choose the configuration of a specific DB type (sql, nosql, postgresql, sqlserver).	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
DataSet	array[UDBParamGroupSet]	Parameter Group List Refer to UDBParamGroupSet	No
TotalCount	int	The total number of parameter groups, this parameter only appears during list operations.	No

Data Model

UDBParamGroupSet

Field Name	Type	Description Information	Required
GroupId	int	Parameter Group ID	No
GroupName	string	Parameter Group Name	No
DBTypeId	string	DB type id, mysql/mongodb each have an id subdivided by version. The current id value range is [1,7], and the corresponding versions are as follows: 1: mysql-5.5, 2: mysql-5.1, 3: percona-5.5 4: mongodb-2.4, 5: mongodb-2.6, 6: mysql-5.6 7: percona-5.6	No
Description	string	Parameter Group Description	No
Modifiable	boolean	Is the parameter group modifiable?	No
ParamMember	array[UDBParamMemberSet]	Key-value pair table of parameters UDBParamMemberSet	No

UDBParamMemberSet

Field Name	Type	Description Information	Required
Key	string	Parameter Name	No
Value	string	Parameter Value	No
ValueType	int	The parameter value application type, the range of values is {0,10,20,30}, each value represents the meaning of 0-unknown, 10-int, 20-string, 30-bool.	No
AllowedVal	string	Allowed values (represented by separators according to parameter type)	No
ApplyType	int	Parameter value application type, the value range is {0,10,20}, each value represents the meaning of 0-unknown, 10-static, 20-dynamic	No
Modifiable	boolean	Can it be changed, default is false	No
FormatType	int	The format type of allowed values, the range of values is {0,10,20}, the meanings are PVFT_UNKOWN=0, PVFT_RANGE=10, PVFT_ENUM=20 respectively.	No

Example

Request Example

https://api.surfercloud.com/?Action=DescribeUDBParamGroup
&Region=cn-bj2
&Zone=cn-bj2-04
&Offset=0
&Limit=3

Response Example

{
  "Action": "DescribeUDBParamGroupResponse",
  "DataSet": [
    {
      "DBTypeId": "postgresql-9.6",
      "Description": "postgresql-9.6默认配置",
      "GroupId": 1859,
      "GroupName": "postgresql-9.6默认配置",
      "Modifiable": false,
      "ParamGroupTypeName": "Undefined",
      "RegionFlag": false,
      "Zone": "cn-bj2-02"
    },
    {
      "DBTypeId": "mysql-5.1",
      "Description": "mysql5.1默认配置",
      "GroupId": 2,
      "GroupName": "mysql5.1默认配置",
      "Modifiable": false,
      "ParamGroupTypeName": "Undefined",
      "RegionFlag": false,
      "Zone": "cn-bj2-02"
    },
    {
      "DBTypeId": "mysql-5.5",
      "Description": "mysql5.5默认配置",
      "GroupId": 1,
      "GroupName": "mysql5.5默认配置",
      "Modifiable": false,
      "ParamGroupTypeName": "Undefined",
      "RegionFlag": false,
      "Zone": "cn-bj2-02"
    }
  ],
  "RetCode": 0,
  "TotalCount": 3
}

CreateUDBParamGroup DescribeUDBBackup