获取参数信息-DescribeUDBParamGroup

获取参数组详细参数信息

Request Parameters

Parameter nameTypeDescriptionRequired
Regionstring地域, 参见 地域和可用区列表Yes
Zonestring可用区, 参见 可用区列表No
ProjectIdstring项目编号No
GroupIdint参数组id,如果指定则获取描述,否则是列表操作,需要 指定Offset/LimitNo
Offsetint分页显示的起始偏移,列表操作则指定No
Limitint分页显示的条目数,列表操作则指定No
IsInUDBCbool是否选取专区中配置No
RegionFlagbool是否是跨可用区的配置文件No
ClassTypestring如果未指定GroupId,则可选是否选取特定DB类型的配置(sql, nosql, postgresql, sqlserver)No

Response Elements

Parameter nameTypeDescriptionRequired
RetCodeint操作返回码Yes
Actionstring操作名称Yes
DataSetarray参数组列表 参照UDBParamGroupSetNo
TotalCountint参数组总数,列表操作时才会有该参数No

UDBParamGroupSet

Parameter nameTypeDescriptionRequired
GroupIdint参数组idNo
GroupNamestring参数组名称No
DBTypeIdstringDB类型id,mysql/mongodb按版本细分各有一个id 目前id的取值范围为[1,7],数值对应的版本如下 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.6No
Descriptionstring参数组描述No
Modifiablebool参数组是否可修改No
ParamMemberarray参数的键值对表 UDBParamMemberSetNo

UDBParamMemberSet

Parameter nameTypeDescriptionRequired
Keystring参数名称No
Valuestring参数值No
ValueTypeint参数值应用类型,取值范围为{0,10,20,30},各值 代表意义为 0-unknown、10-int、20-string、 30-boolNo
AllowedValstring允许的值(根据参数类型,用分隔符表示)No
ApplyTypeint参数值应用类型,取值范围为{0,10,20},各值代表 意义为0-unknown、10-static、20-dynamicNo
Modifiablebool是否可更改,默认为falseNo
FormatTypeint允许值的格式类型,取值范围为{0,10,20},意义分 别为PVFT_UNKOWN=0,PVFT_RANGE=10, PVFT_ENUM=20No

Request Example

http(s)://api.ucloud.cn/?Action=DescribeUDBParamGroup
&Region=cn-bj2
&Zone=cn-bj2-04
&GroupId=20                               

Response Example

{
    "Action": "DescribeUDBParamGroupResponse",
    "TotalCount": 1,
    "RetCode": 0,
    "DataSet": [
        {
            "Description": "mongodb2.4默认配置",
            "Modifiable": true,
            "ParamMember": [
                {
                    "FormatType": "PVFT_ENUM",
                    "ValueType": "PVT_BOOL",
                    "Modifiable": true,
                    "Value": "false",
                    "Key": "auth",
                    "ApplyType": "PAT_STATIC",
                    "AllowedVal": "true,false"
                },
                {
                    "FormatType": "PVFT_RANGE",
                    "ValueType": "PVT_INT",
                    "Modifiable": true,
                    "Value": "2000",
                    "Key": "maxConns",
                    "ApplyType": "PAT_STATIC",
                    "AllowedVal": "1-100000"
                }
            ],
            "GroupName": "mongodb2.4默认配置",
            "GroupId": 20,
            "DBTypeId": "mongodb-2.4"
        }
    ]
}