文档

DescribeParameterGroups - 查询目标地域的参数模板列表

更新时间:
重要

本文中含有需要您注意的重要提示信息,忽略该信息可能对您的业务造成影响,请务必仔细阅读。

该接口用于查询目标地域的参数模板列表。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL

相关功能文档

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

调试

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

授权信息

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

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

请求参数

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

地域 ID,可以通过 DescribeRegions 查看地域 ID。

cn-hangzhou
ResourceGroupIdstring

资源组 ID。

rg-acfmy****
EnableDetailboolean

参数概览信息。

  • false:返回参数概览信息,默认值。

  • true:不返回参数概览信息。

false

返回参数

名称类型描述示例值
object

返回参数详情。

SignalForOptimizeParamsboolean

目标地域是否有参数模板。取值:

  • true:无参数模板
  • false:有参数模板
    警告 该参数已废弃,不建议使用。
false
RequestIdstring

请求 ID。

D4A23265-C5B6-42E1-98A0-EFA1EB42E723
ParameterGroupsobject []

参数模板列表。

UpdateTimestring

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

2019-11-21T02:21:35Z
ParameterGroupDescstring

参数模板类型。取值:

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

参数模板创建时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2019-11-21T01:48:39Z
ForceRestartinteger

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

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

参数模板 ID。

rpg-****
ParameterGroupNamestring

参数模板名称。

test1234
Enginestring

数据库引擎。

mysql
ParamCountsinteger

参数模板内的参数数量。

2
EngineVersionstring

数据库版本。

5.7
ParameterGroupTypeinteger

参数模板类型。取值:

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

示例

正常返回示例

JSON格式

{
  "SignalForOptimizeParams": false,
  "RequestId": "D4A23265-C5B6-42E1-98A0-EFA1EB42E723",
  "ParameterGroups": {
    "ParameterGroup": [
      {
        "UpdateTime": "2019-11-21T02:21:35Z",
        "ParameterGroupDesc": "1",
        "CreateTime": "2019-11-21T01:48:39Z",
        "ForceRestart": 1,
        "ParameterGroupId": "rpg-****",
        "ParameterGroupName": "test1234",
        "Engine": "mysql",
        "ParamCounts": 2,
        "EngineVersion": "5.7",
        "ParameterGroupType": 1
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0,请先充值后再尝试购买。
400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。

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

变更历史

变更时间变更内容概要操作
2024-01-23OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:EnableDetail
2022-07-27OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ResourceGroupId
  • 本页导读 (1)
文档反馈