DescribeParameters - 获取配置参数信息

获取AnalyticDB PostgreSQL版实例的配置参数信息。

接口说明

本接口仅支持查看存储弹性模式和 Serverless 版本的 AnalyticDB PostgreSQL 版实例的配置参数和相关信息。

调试

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

授权信息

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

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

请求参数

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

实例 ID。

说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情,包括实例 ID。
gp-bp***************

返回参数

名称类型描述示例值
object
Parametersarray<object>

配置参数列表。

Parametersobject
IsChangeableConfigstring

配置参数是否可修改。取值说明:

  • true:可修改。
  • false:不可修改。
true
ForceRestartInstancestring

是否需要重启实例。取值说明:

  • true:需要重启实例。
  • false:不需要重启实例。
false
OptionalRangestring

配置参数的取值范围。

[0-2147483647]
ParameterNamestring

配置参数名称。

statement_timeout
ParameterValuestring

配置参数默认值。

10800000
ParameterDescriptionstring

配置参数的说明。

Sets the maximum allowed duration of any statement,A value of 0 turns off the timeout.
CurrentValuestring

配置参数当前值。

10800000
RequestIdstring

请求 ID。

62506167-D284-562A-B7C2-0A**********

示例

正常返回示例

JSON格式

{
  "Parameters": [
    {
      "IsChangeableConfig": "true",
      "ForceRestartInstance": "false",
      "OptionalRange": "[0-2147483647]",
      "ParameterName": "statement_timeout",
      "ParameterValue": "10800000",
      "ParameterDescription": "Sets the maximum allowed duration of any statement,A value of 0 turns off the timeout.",
      "CurrentValue": "10800000"
    }
  ],
  "RequestId": "62506167-D284-562A-B7C2-0A**********"
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史