全部产品
Search
文档中心

云数据库 RDS:DescribeParameterGroup - 查询指定的RDS参数模板信息

更新时间:Dec 08, 2023

该接口用于查询指定的RDS参数模板信息。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL

相关功能文档

注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:DescribeParameterGroupREAD
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

请求参数

名称类型必填描述示例值
ParameterGroupIdstring

参数模板ID。可以通过接口DescribeParameterGroups查看参数模板ID。

rpg-dp****
RegionIdstring

地域ID。可以通过接口DescribeRegions查看地域ID。

cn-hangzhou

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求ID。

498AE8CA-8C81-4A01-AF37-2B902014ED30
ParamGroupobject []

参数模板信息列表。

UpdateTimestring

最近一次参数模板更新时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

2019-10-22T06:07:54Z
ParameterGroupDescstring

参数模板描述。

testGroup1
CreateTimestring

参数模板创建时间。

2019-10-22T06:02:53Z
ForceRestartinteger

应用该参数模板是否需要重启实例。取值:

  • 0:不需要重启
  • 1:需要重启
1
ParameterGroupIdstring

参数模板ID。

rpg-dp****
ParameterGroupNamestring

参数模板名称。

test123456
Enginestring

数据库引擎。

mysql
ParamCountsinteger

参数模板内的参数数量。

2
EngineVersionstring

数据库版本。

5.6
ParameterGroupTypeinteger

参数模板类型。取值:

  • 0:系统默认模板
  • 1:用户自定义模板
  • 2:系统自动备份模板(应用模板后系统会自动备份之前的参数设置为模板)
1
ParamDetailobject []

参数列表。

ParamNamestring

参数名称。

back_log
ParamValuestring

参数值。

2000
RelatedCustinsInfoobject []

关联实例信息列表。

说明 仅PostgreSQL模板适用。
DBInstanceNamestring

实例ID。

rm-bp170****
AppliedTimestring

应用参数模板的时间。

2022-10-17T03:19:02Z

示例

正常返回示例

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错误码错误信息描述
400ParamGroupsNotExistThe specified paramGroups does not exist.参数模板不存在,您可以调用DescribeParameterGroups接口查询目标地域的参数模板列表。
403InvalidUserOperatorPermissionThe user permission does not support this operation.用户权限不支持此操作。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-10-14OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更