调用DescribeParameters接口查看被修改的参数详情。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeParameters

系统规定参数。取值为DescribeParameters。

DBInstanceId String 是 pxc-********************

实例ID。
RegionId String 是 cn-hangzhou

实例所在地域。
ParamLevel String 否 compute

参数级别，取值范围如下：

  • compute：计算级别
  • storage：存储级别

返回数据

名称 类型 示例值 描述
Data Struct

返回数据。
ConfigParameters Array of DBInstanceParameter

参数正在修改时的信息详情。

说明
  • 发起修改参数请求后，参数状态会短暂地处于修改中状态，此时会返回该参数信息详情。
  • 参数修改完成后，则不会返回该参数信息详情。
ParameterDescription String 物理连接池获取连接的最大等待时间

参数描述信息。
ParameterName String CONN_POOL_BLOCK_TIMEOUT

参数名称。
ParameterValue String 5040

参数修改完成后的目标取值。
Engine String polarx

引擎类型，目前仅支持polarx。

EngineVersion String 1.0

引擎版本，目前仅支持1.0。

RunningParameters Array of DBInstanceParameter

当前状态下的参数信息详情。

说明
  • 若参数正在修改中（即同时返回ConfigParameters和RunningParameters参数详情），则此处显示的是修改前的参数信息详情。
  • 若参数修改完成（即仅返回RunningParameters参数详情），则此处显示的是修改完成后的参数信息详情。
ParameterDescription String 物理连接池获取连接的最大等待时间

参数描述信息。
ParameterName String CONN_POOL_BLOCK_TIMEOUT

参数名称。
ParameterValue String 4999

参数修改后的取值。
RequestId String 618F9A9A-633E-4B43-838F-EF7544******

请求ID。

示例

请求示例

http(s)://polardbx.cn-hangzhou.aliyuncs.com/?Action=DescribeParameters
&DBInstanceId=pxc-********************
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式 

<code>200</code>
<data>
    <RequestId>618F9A9A-633E-4B43-838F-EF7544135B6D</RequestId>
    <Data>
        <RunningParameters>
            <ParameterValue>4999</ParameterValue>
            <ParameterName>CONN_POOL_BLOCK_TIMEOUT</ParameterName>
            <ParameterDescription>物理连接池获取连接的最大等待时间</ParameterDescription>
        </RunningParameters>
        <RunningParameters>
            <ParameterValue>36</ParameterValue>
            <ParameterName>CONN_POOL_IDLE_TIMEOUT</ParameterName>
            <ParameterDescription>物理空闲链接超时时间</ParameterDescription>
        </RunningParameters>
        <RunningParameters>
            <ParameterValue>+07:00</ParameterValue>
            <ParameterName>LOGICAL_DB_TIME_ZONE</ParameterName>
            <ParameterDescription>数据库时区</ParameterDescription>
        </RunningParameters>
        <EngineVersion>1.0</EngineVersion>
        <ConfigParameters>
            <ParameterValue>5040</ParameterValue>
            <ParameterName>CONN_POOL_BLOCK_TIMEOUT</ParameterName>
            <ParameterDescription>物理连接池获取连接的最大等待时间</ParameterDescription>
        </ConfigParameters>
        <ConfigParameters>
            <ParameterValue>34</ParameterValue>
            <ParameterName>CONN_POOL_IDLE_TIMEOUT</ParameterName>
            <ParameterDescription>物理空闲链接超时时间</ParameterDescription>
        </ConfigParameters>
        <Engine>polarx</Engine>
    </Data>
</data>
<httpStatusCode>200</httpStatusCode>
<requestId>618F9A9A-633E-4B43-838F-EF7544******</requestId>
<successResponse>true</successResponse>

JSON 格式 

{
 "code": "200",
 "data": {
  "RequestId": "618F9A9A-633E-4B43-838F-EF7544135B6D",
  "Data": {
   "RunningParameters": [{
    "ParameterValue": "4999",
    "ParameterName": "CONN_POOL_BLOCK_TIMEOUT",
    "ParameterDescription": "物理连接池获取连接的最大等待时间"
   }, {
    "ParameterValue": "36",
    "ParameterName": "CONN_POOL_IDLE_TIMEOUT",
    "ParameterDescription": "物理空闲链接超时时间"
   }, {
    "ParameterValue": "+07:00",
    "ParameterName": "LOGICAL_DB_TIME_ZONE",
    "ParameterDescription": "数据库时区"
   }],
   "EngineVersion": "1.0",
   "ConfigParameters": [{
    "ParameterValue": "5040",
    "ParameterName": "CONN_POOL_BLOCK_TIMEOUT",
    "ParameterDescription": "物理连接池获取连接的最大等待时间"
   }, {
    "ParameterValue": "34",
    "ParameterName": "CONN_POOL_IDLE_TIMEOUT",
    "ParameterDescription": "物理空闲链接超时时间"
   }],
   "Engine": "polarx"
  }
 },
 "httpStatusCode": "200",
 "requestId": "618F9A9A-633E-4B43-838F-EF7544******",
 "successResponse": true
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidDBInstance.NotFound The specified DB instance does not exist. 数据库实例不存在

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