接口功能介绍
根据模板id查询RDS参数模板的信息。
接口约束
无
URI
GET /v1/open-api/parameter/describe-parameter-group
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
id | 是 | Integer | 模板id | 1 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | String | 返回码 | 0 | |
returnObj | 否 | Object | 返回对象 | returnObj | |
message | 否 | String | 结果信息 | success |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
id | 是 | Integer | 参数模版id | 1 | |
userId | 是 | Integer | 用户id | 1 | |
parameterGroupName | 是 | String | 参数组名称 | Default-5.7 | |
mysqlEngine | 是 | String | 引擎 | 5.7 | |
createTime | 是 | String | 创建时间 | 2022-08-02 11:11:11 | |
description | 是 | String | 描述 | 5.7的默认 | |
isDefault | 是 | Integer | 属否是默认参数组 | 1 | |
paramDetails | 是 | Array of Objects | 参数信息 | 1 | Object |
paramDetails信息
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
ParamName | 是 | String | 参数名 | auto_increment_increment | |
ParamValue | 是 | String | 参数值 | 1 |
请求示例
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "success",
"opMessage": null,
"returnObj": {
"id": 1,
"userId": 1,
"parameterGroupName":"Default-MySQL-5.7",
"mysqlEngine":"5.7",
"createTime":"2022-08-24 18:41:09",
"description":"Default for 5.7 description",
"isdefault": 1,
"paramDetail": [{
"ParamName": "auto_increment_increment",
"ParamValue": "1"
}]}
}
状态码
状态码 | 描述 |
---|---|
0 | 表示请求成功。 |
错误码
错误码 | 描述 |
---|---|
2001 | 参数异常,失败原因见message |
3001 | 业务异常,失败原因见message |
5001 | 请求响应失败, 失败原因见message |