调用DescribeParameters接口获取实例参数。

调试

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

请求参数

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

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

RegionId String 是 cn-hangzhou

实例所属地域。
DBInstanceId String 是 pxc-********

实例ID。
ParamLevel String 否 compute

参数级别，取值：

  • compute：计算层 ；
  • storage：存储层。

返回数据

名称 类型 示例值 描述
RequestId String 6BA32080EEA

请求ID。
Data Object

参数详情。
EngineVersion String 2.0

引擎版本，默认2.0。
Engine String polarx

引擎，默认polarx。
ConfigParameters Array of DBInstanceParameter

原始参数列表。
ParameterDescription String 存储节点私有协议开关(-1关闭，0开启)

参数描述。
ParameterName String CONN_POOL_XPROTO_STORAGE_DB_PORT

参数名称。
ParameterValue String -1

参数值。
RunningParameters Array of DBInstanceParameter

运行中的参数详情列表。
ParameterDescription String 存储节点私有协议开关(-1关闭，0开启)

参数描述。
ParameterName String CONN_POOL_XPROTO_STORAGE_DB_PORT

参数名称。
ParameterValue String -1

参数取值。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeParameters
&RegionId=cn-hangzhou
&DBInstanceId=pxc-********
&ParamLevel=compute
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeParametersResponse>
    <RequestId>6BA32080EEA</RequestId>
    <Data>
        <EngineVersion>2.0</EngineVersion>
        <Engine>polarx</Engine>
        <ConfigParameters>
            <ParameterDescription>存储节点私有协议开关(-1关闭，0开启)</ParameterDescription>
            <ParameterName>CONN_POOL_XPROTO_STORAGE_DB_PORT</ParameterName>
            <ParameterValue>-1</ParameterValue>
        </ConfigParameters>
        <RunningParameters>
            <ParameterDescription>存储节点私有协议开关(-1关闭，0开启)</ParameterDescription>
            <ParameterName>CONN_POOL_XPROTO_STORAGE_DB_PORT</ParameterName>
            <ParameterValue>-1</ParameterValue>
        </RunningParameters>
    </Data>
</DescribeParametersResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "6BA32080EEA",
  "Data" : {
    "EngineVersion" : "2.0",
    "Engine" : "polarx",
    "ConfigParameters" : [ {
      "ParameterDescription" : "存储节点私有协议开关(-1关闭，0开启)",
      "ParameterName" : "CONN_POOL_XPROTO_STORAGE_DB_PORT",
      "ParameterValue" : "-1"
    } ],
    "RunningParameters" : [ {
      "ParameterDescription" : "存储节点私有协议开关(-1关闭，0开启)",
      "ParameterName" : "CONN_POOL_XPROTO_STORAGE_DB_PORT",
      "ParameterValue" : "-1"
    } ]
  }
}

错误码

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

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