DescribeColumnarInfo - PolarDB - Alibaba Cloud Documentation Center

Queries column store information.

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:DescribeColumnarInfo

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance. Note You can call the DescribeRegions operation to query the regions supported by PolarDB-X, including region IDs.	cn-hangzhou
DBInstanceName	string	Yes	The instance ID.	pxc-hzjasd****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	14036EBE-****-44DB-ACE9-AC6157D3A6FC
HttpStatusCode	integer	The HTTP status code.	200
Success	boolean	Indicates whether the request was successful.	true
Data	object	The data struct.
ColumnarNewVersion	string	The new version of the column store.	polarx-col-kernel-5.4.20-20250819_17555906
BinlogSize	integer	The binlog size.	524288000
ServerId	integer	server id	53755321
CheckSumSwitch	string	The checksum switch.	ON
BinlogPersistTime	integer	The number of days that binlogs are retained.	30
ColumnarVersion	string	The column store version.	polarx-col-kernel-5.4.20-20250819_17555906
ClassCode	string	The instance specifications.	polarx.n8.medium.col
InstanceTopologyList	array<object>	The instance list.
	array<object>	The instance list.
InstanceName	string	The instance name.	pxc-***
Comment	string	The instance type description.	***
PhysicalNodes	array<object>	The node array.
	object	The node array.
Disk	integer	The disk size, in MB.	204800
NodeClass	string	The instance specifications.	polarx.n8.medium.col
Version	string	The instance version.	polarx-col-kernel-5.4.20-20250819_17555906
AZone	string	The zone in which the instance resides.	cn-hangzhou-h
Status	string	The instance status.	ACTIVATION
NodeId	string	The node ID.	***

Examples

Success response

JSON format

{
  "RequestId": "14036EBE-****-44DB-ACE9-AC6157D3A6FC",
  "HttpStatusCode": 200,
  "Success": true,
  "Data": {
    "ColumnarNewVersion": "polarx-col-kernel-5.4.20-20250819_17555906",
    "BinlogSize": 524288000,
    "ServerId": 53755321,
    "CheckSumSwitch": "ON",
    "BinlogPersistTime": 30,
    "ColumnarVersion": "polarx-col-kernel-5.4.20-20250819_17555906",
    "ClassCode": "polarx.n8.medium.col",
    "InstanceTopologyList": [
      {
        "InstanceName": "pxc-***",
        "Comment": "***",
        "PhysicalNodes": [
          {
            "Disk": 204800,
            "NodeClass": "polarx.n8.medium.col",
            "Version": "polarx-col-kernel-5.4.20-20250819_17555906",
            "AZone": "cn-hangzhou-h",
            "Status": "ACTIVATION",
            "NodeId": "***"
          }
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.