首页 云数据库 RDS 开发参考 API参考 API目录 参数 DescribeParameters - 查询实例当前的参数配置

DescribeParameters - 查询实例当前的参数配置

更新时间: 2023-12-06 16:51:08

该接口用于查询实例当前的参数配置。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

调试

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

调试

授权信息

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

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

请求参数

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

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。

ETnLKlblzczshOTUbOCz****
DBInstanceIdstring

实例ID。可调用DescribeDBInstances获取。

rm-uf6wjk5****

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求ID。

1AD222E9-E606-4A42-BF6D-8A4442913CEF
Enginestring

数据库类型。

MySQL
EngineVersionstring

数据库版本号。

8.0
ParamGroupInfoobject

参数模板信息。

ParameterGroupNamestring

参数模板名称。

mysql_innodb_8.0_basic_normal_high
ParameterGroupDescstring

参数模板描述。

sync_binlog=1000, innodb_flush_log_at_trx_commit=2, async
ParameterGroupTypestring

参数模板类型。

0
ParamGroupIdstring

参数模板ID。

rpg-sys-01040401010200
ConfigParametersobject []

正在同步的参数列表。

说明 修改并提交参数后,需要等待实例同步参数,同步结束后从此列表删除。
ParameterDescriptionstring

参数描述。

The amount in bytes by which to increase a per-transaction memory pool which needs memory. See the description of transaction_prealloc_size.
ParameterNamestring

参数名称。

transaction_alloc_block_size
ParameterValuestring

参数值。

8192
RunningParametersobject []

当前运行的参数列表。

ParameterDescriptionstring

参数描述。

The amount in bytes by which to increase a per-transaction memory pool which needs memory. See the description of transaction_prealloc_size.
ParameterNamestring

参数名称。

transaction_alloc_block_size
ParameterValuestring

参数值。

1024

示例

正常返回示例

JSON格式

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Engine": "MySQL",
  "EngineVersion": "8.0",
  "ParamGroupInfo": {
    "ParameterGroupName": "mysql_innodb_8.0_basic_normal_high",
    "ParameterGroupDesc": "sync_binlog=1000, innodb_flush_log_at_trx_commit=2, async",
    "ParameterGroupType": "0",
    "ParamGroupId": "rpg-sys-01040401010200"
  },
  "ConfigParameters": {
    "DBInstanceParameter": [
      {
        "ParameterDescription": "The amount in bytes by which to increase a per-transaction memory pool which needs memory. See the description of transaction_prealloc_size.",
        "ParameterName": "transaction_alloc_block_size",
        "ParameterValue": "8192"
      }
    ]
  },
  "RunningParameters": {
    "DBInstanceParameter": [
      {
        "ParameterDescription": "The amount in bytes by which to increase a per-transaction memory pool which needs memory. See the description of transaction_prealloc_size.",
        "ParameterName": "transaction_alloc_block_size",
        "ParameterValue": "1024"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
404InvalidDBInstance.NotFoundSpecified instance does not exist or not support.指定的实例不存在指定的实例被删除或者实例不支持当前操作。

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

变更历史

变更时间变更内容概要操作
2023-05-23OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
出参OpenAPI 返回结构发生变更
2023-03-01OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:404
阿里云首页 云数据库 RDS 相关技术圈