Queries the parameters that are used to configure 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 DescribeDBInstanceConfig

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

RegionId String Yes cn-hangzhou

The region ID of the instance.

DBInstanceName String Yes pxc-*********

The ID of the instance.

ConfigName String Yes htap

The identifier of the configuration. Default value: htap.

Response parameters

Parameter Type Example Description
RequestId String C458B1E8-1683-3645-B154-6BA32080EEA

The ID of the request.

Data Object

The returned data.

ConfigName String htap

The identifier of the configuration.

DbInstanceName String pxc-sprcym7g7wj7kv

The ID of the instance.

ConfigValue String {\"attendHtapList\":[\"pxc-sprcym7g7wj7kv\"],\"autoAttendHtap\":\"true\",\"enableHtap\":\"true\"}

The values of the parameters for the configuration.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeDBInstanceConfig
&RegionId=cn-hangzhou
&DBInstanceName=pxc-*********
&ConfigName=htap
&<Common request parameters>

Sample success responses

XML format

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

<DescribeDBInstanceConfigResponse>
    <RequestId>C458B1E8-1683-3645-B154-6BA32080EEA</RequestId>
    <Data>
        <ConfigName>htap</ConfigName>
        <DbInstanceName>pxc-sprcym7g7wj7kv</DbInstanceName>
        <ConfigValue>{\"attendHtapList\":[\"pxc-sprcym7g7wj7kv\"],\"autoAttendHtap\":\"true\",\"enableHtap\":\"true\"}</ConfigValue>
    </Data>
</DescribeDBInstanceConfigResponse>

JSON format

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

{
  "RequestId" : "C458B1E8-1683-3645-B154-6BA32080EEA",
  "Data" : {
    "ConfigName" : "htap",
    "DbInstanceName" : "pxc-sprcym7g7wj7kv",
    "ConfigValue" : "{\\\"attendHtapList\\\":[\\\"pxc-sprcym7g7wj7kv\\\"],\\\"autoAttendHtap\\\":\\\"true\\\",\\\"enableHtap\\\":\\\"true\\\"}"
  }
}

Error codes

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