该接口用于查询指定的RDS参数模板信息。
接口说明
如果需要批量管理实例的参数,您可以使用参数模板功能,快速应用模板到实例上。详情请参见MySQL使用参数模板或PostgreSQL使用参数模板。
说明
当前仅支持MySQL实例和PostgreSQL实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:DescribeParameterGroup | READ |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ParameterGroupId | string | 是 | 参数模板ID。可以通过接口DescribeParameterGroups查看参数模板ID。 | rpg-dp**** |
RegionId | string | 是 | 地域ID。可以通过接口DescribeRegions查看地域ID。 | cn-hangzhou |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "498AE8CA-8C81-4A01-AF37-2B902014ED30",
"ParamGroup": {
"ParameterGroup": [
{
"UpdateTime": "2019-10-22T06:07:54Z",
"ParameterGroupDesc": "testGroup1",
"CreateTime": "2019-10-22T06:02:53Z",
"ForceRestart": 1,
"ParameterGroupId": "rpg-dp****",
"ParameterGroupName": "test123456",
"Engine": "mysql",
"ParamCounts": 2,
"EngineVersion": "5.6",
"ParameterGroupType": 1,
"ParamDetail": {
"ParameterDetail": [
{
"ParamName": "back_log",
"ParamValue": "2000"
}
]
}
}
]
},
"RelatedCustinsInfo": {
"RelatedCustinsInfo": [
{
"DBInstanceName": "rm-bp170****",
"AppliedTime": "2022-10-17T03:19:02Z"
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | ParamGroupsNotExist | The specified paramGroups does not exist. | 参数模板不存在,您可以调用DescribeParameterGroups接口查询目标地域的参数模板列表。 |
403 | InvalidUserOperatorPermission | The user permission does not support this operation. | 用户权限不支持此操作。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||
---|---|---|---|---|---|---|---|---|
2022-10-14 | OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更 | 看变更集 | ||||||
|