DescribeDBInstanceConfig - PolarDB - Alibaba Cloud Documentation Center

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardbx:DescribeDBInstanceConfig

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the instance resides.	cn-hangzhou
DBInstanceName	string	Yes	The instance ID.	pxc-*********
ConfigName	string	Yes	The configuration identifier. Default value: htap.	htap

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	C458B1E8-1683-3645-B154-6BA32080EEA
Data	object	The data struct.
ConfigName	string	The configuration key.	htap
DbInstanceName	string	The instance ID.	pxc-sprcym7g7w****
ConfigValue	string	The configuration item. Description: attendHtapList: the list of instances with HTAP enabled. autoAttendHtap: specifies whether to automatically add newly created read-only instances to the HTAP list. delayExecutionStrategy: when the read-only instance lag reaches the value specified by storageDelayThreshold, read-only traffic is switched back to the primary instance. Default value: 1. Valid values: 0 and 1. enableConsistentReplicaRead: specifies whether to enable consistent reads. storageDelayThreshold: the latency threshold for read-only instances. Default value: 3s. Valid values: 0 to 3600*24. enableHtap: specifies whether to enable HTAP. masterReadWeight: the read weight of the primary node. A value of 100 indicates that 100% of traffic is routed to the primary node. Valid values: 0 to 100.	{\"attendHtapList\":[\"pxc-hzruyzes08****\"],\"autoAttendHtap\":\"true\",\"delayExecutionStrategy\":1,\"enableConsistentReplicaRead\":true,\"enableHtap\":\"true\",\"masterReadWeight\":100,\"storageDelayThreshold\":3}

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.