Queries the parameter settings of a PolarDB-X instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeParameters

The operation that you want to perform. Set the value to DescribeParameters.

RegionId String Yes cn-hangzhou

The ID of the region.

DBInstanceId String Yes pxc-********

The ID of the instance.

ParamLevel String No compute

The type of nodes whose parameters you want to query. Valid values:

  • compute: data nodes
  • storage: storage nodes

Response parameters

Parameter Type Example Description
RequestId String 6BA32080EEA

The ID of the request.

Data Object

The details of the parameters.

EngineVersion String 2.0

The engine version. The default value is 2.0.

Engine String polarx

The engine type. The default value is polarx.

ConfigParameters Array of DBInstanceParameter

The list of original parameters.

ParameterDescription String Specifies whether to turn on the proprietary protocol for storage nodes.(-1: turn off; 0: turn on)

The description of the parameter.

ParameterName String CONN_POOL_XPROTO_STORAGE_DB_PORT

The name of the parameter.

ParameterValue String -1

The value of the parameter.

RunningParameters Array of DBInstanceParameter

The details of each parameter.

ParameterDescription String Specifies whether to turn on the proprietary protocol for storage nodes.(-1: turn off; 0: turn on)

The description of the parameter.

ParameterName String CONN_POOL_XPROTO_STORAGE_DB_PORT

The name of the parameter.

ParameterValue String -1

The value of the parameter.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeParameters
&RegionId=cn-hangzhou
&DBInstanceId=pxc-********
&ParamLevel=compute
&<Common request parameters>

Sample success responses

XML format 

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

<DescribeParametersResponse>
    <RequestId>6BA32080EEA</RequestId>
    <Data>
        <EngineVersion>2.0</EngineVersion>
        <Engine>polarx</Engine>
        <ConfigParameters>
            <ParameterDescription>Specifies whether to turn on the proprietary protocol for storage nodes.(-1: turn off; 0: turn on)</ParameterDescription>
            <ParameterName>CONN_POOL_XPROTO_STORAGE_DB_PORT</ParameterName>
            <ParameterValue>-1</ParameterValue>
        </ConfigParameters>
        <RunningParameters>
            <ParameterDescription>Specifies whether to turn on the proprietary protocol for storage nodes.(-1: turn off; 0: turn on)</ParameterDescription>
            <ParameterName>CONN_POOL_XPROTO_STORAGE_DB_PORT</ParameterName>
            <ParameterValue>-1</ParameterValue>
        </RunningParameters>
    </Data>
</DescribeParametersResponse>

JSON format 

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

{
  "RequestId" : "6BA32080EEA",
  "Data" : {
    "EngineVersion" : "2.0",
    "Engine" : "polarx",
    "ConfigParameters" : [ {
      "ParameterDescription" : "Specifies whether to turn on the proprietary protocol for storage nodes.(-1: turn off; 0: turn on)",
      "ParameterName" : "CONN_POOL_XPROTO_STORAGE_DB_PORT",
      "ParameterValue" : "-1"
    } ],
    "RunningParameters" : [ {
      "ParameterDescription" : "Specifies whether to turn on the proprietary protocol for storage nodes.(-1: turn off; 0: turn on)",
      "ParameterName" : "CONN_POOL_XPROTO_STORAGE_DB_PORT",
      "ParameterValue" : "-1"
    } ]
  }
}

Error codes

HttpCode Error code Error message Description
404 InvalidDBInstance.NotFound The specified DB instance does not exist. The error message returned because the specified database instance does not exist.

For a list of error codes, visit the API Error Center.