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-sprcym7g7w****

The ID of the instance.

ConfigValue String {\"attendHtapList\":[\"pxc-hzruyzes08****\"],\"autoAttendHtap\":\"true\",\"delayExecutionStrategy\":1,\"enableConsistentReplicaRead\":true,\"enableHtap\":\"true\",\"masterReadWeight\":100,\"storageDelayThreshold\":3}

The items that are used to configure the instance. The following items are returned:

  • attenHtapList: The list of instances for which HTAP is enabled.
  • autoAttendHtap: Indicates whether read-only instances are automatically added to the HTAP list.
  • delayExecutionStrategy: Indicates whether read-only requests are switched to the primary instance when the read-only latency reaches the value of storageDelayThreshold. Valid values: 0 and 1. Default value: 1.
  • enableConsistentReplicaRead: Indicates whether read consistency is enabled.
  • storageDelayThreshold: The latency threshold of the read-only instance. Valid values: 0 to 3600 × 24. Default value: 3.
  • enableHtap: Indicates whether HTAP is enabled.
  • masterReadWeight: The read weight of the primary node. For example, the value 100 indicates that all traffic is forwarded to the primary node. Valid values: 0 to 100.

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-sprcym7g7w****</DbInstanceName>
        <ConfigValue>{\"attendHtapList\":[\"pxc-hzruyzes08****\"],\"autoAttendHtap\":\"true\",\"delayExecutionStrategy\":1,\"enableConsistentReplicaRead\":true,\"enableHtap\":\"true\",\"masterReadWeight\":100,\"storageDelayThreshold\":3}</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-sprcym7g7w****",
    "ConfigValue" : "{\\\"attendHtapList\\\":[\\\"pxc-hzruyzes08****\\\"],\\\"autoAttendHtap\\\":\\\"true\\\",\\\"delayExecutionStrategy\\\":1,\\\"enableConsistentReplicaRead\\\":true,\\\"enableHtap\\\":\\\"true\\\",\\\"masterReadWeight\\\":100,\\\"storageDelayThreshold\\\":3}"
  }
}

Error codes

For a list of error codes, see Service error codes.