获取RDS参数模板信息
更新时间 2025-09-24 14:48:41
最近更新时间: 2025-09-24 14:48:41
接口功能介绍
根据模板id查询RDS参数模板的信息
接口约束
无
URI
GET /RDS2/v1/open-api/parameter/describe-parameter-group
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| id | 是 | Integer | 模板id | 1 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 项目id | b829cb71308746a094853c21d5aac0a1 | |
| regionId | 是 | String | 资源区regionId，比如实例在资源区A，则需要填写A资源区的regionId | 81f7728662dd11ec810800155d307d5b |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回码 取值范围：0 成功; 2001 参数异常；3001 业务异常；5001 请求响应失败 | 0 | |
| returnObj | Object | 返回对象 | returnObj | |
| opMessage | String | 操作信息 | ||
| message | String | 结果信息 | success | |
| error | String | 错误码。当接口失败时才返回具体错误编码，成功不返回或者为空 | MYSQL_10001 | |
| 表 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 | |
| restart | Boolean | 修改该参数是否需要重启 | false | |
| paramDetail | Array of Objects | 参数信息 | Object | |
| 表 Object |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| ParamName | String | 参数名 | auto_increment_increment | |
| ParamValue | String | 参数值 | 1 |
枚举参数
无
请求示例
请求url
/RDS2/v1/open-api/parameter/describe-parameter-group?id=2
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": {
"id": 1,
"userId": 1,
"parameterGroupName":"Default-MySQL-5.7",
"mysqlEngine":"5.7",
"createTime":"2022-08-24 18:41:09",
"restart":false,
"description":"Default for 5.7 description",
"isdefault": 1,
"paramDetail": [{
"ParamName": "auto_increment_increment",
"ParamValue": "1"
}]}
}
状态码
请参考 状态码
错误码
请参考 错误码
