DescribeSupabaseInstanceAttribute - PolarDB - Alibaba Cloud Documentation Center

Queries the details of a Supabase instance.

Operation description

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
DBInstanceName	string	Yes	The instance name.	pxsp-*********

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	C457B28E-9CAB-4B77-B5C6-5D71B7870B6E
Data	object	The instance details.
DBInstanceName	string	The instance name.	pxc-supabase-001
Status	string	The instance status.	Running
RegionId	string	The region ID.	cn-hangzhou
ZoneId	string	The zone ID.	cn-zhangjiakou-a
SupabaseClassCode	string	The Supabase class code.	polarx.supabase.x4.xlarge
NodeClass	string	The node specifications.	polarx.supabase.x2.small
NodeCount	integer	The number of nodes.	1
VpcId	string	VPC ID	vpc-********
VSwitchId	string	The vSwitch ID.	vsw-********
CreateTime	string	The creation time.	2025-07-13 10:01:50 +0800
TopologyType	string	The topology type.	1azone
EngineVersion	string	The database engine version.	2.0
MinorVersion	string	The minor engine version.	polardb-2.6.0_xcluster8.4.21-20260716_pxbaas-20260915
LockMode	string	The lock mode.	Unlock
Expired	boolean	Indicates whether the instance has expired.	false
PolarDBXDBInstanceName	string	The name of the associated PolarDB-X instance.	pxc-*********
ConnAddrs	array<object>	The list of endpoints.
	object	The endpoint.
ConnectionString	string	The endpoint.	pxsp-********.rds.aliyuncs.com
Port	integer	The port.	3306
NetType	string	The network type.	0
VpcId	string	VPC ID	vpc-********
Nodes	array<object>	The list of nodes.
	object	The node ID.
Id	string	The node ID.	2005777
Name	string	The node name.	pxsp-********
ZoneId	string	The zone ID.	cn-hangzhou-a
ClassCode	string	The class code.	polarx.supabase.x2.small
TenantMode	boolean	The multi-tenant mode.	false
AccessDeniedDetail	object	The details of the access denial.
AuthAction	string	The authentication action.	xxx
AuthPrincipalType	string	The authentication principal type.	222
NoPermissionType	string	The type of the permission denial.	ImplicitDeny
PolicyType	string	The policy type.	PRIORITY
EncodedDiagnosticMessage	string	The encoded diagnostic message.	AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==
AuthPrincipalOwnerId	string	The owner ID of the authentication principal.	111
AuthPrincipalDisplayName	string	The display name of the authentication principal.	xxx

Examples

Success response

JSON format

{
  "RequestId": "C457B28E-9CAB-4B77-B5C6-5D71B7870B6E",
  "Data": {
    "DBInstanceName": "pxc-supabase-001",
    "Status": "Running",
    "RegionId": "cn-hangzhou",
    "ZoneId": "cn-zhangjiakou-a",
    "SupabaseClassCode": "polarx.supabase.x4.xlarge",
    "NodeClass": "polarx.supabase.x2.small",
    "NodeCount": 1,
    "VpcId": "vpc-********",
    "VSwitchId": "vsw-********",
    "CreateTime": "2025-07-13 10:01:50 +0800",
    "TopologyType": "1azone",
    "EngineVersion": "2.0",
    "MinorVersion": "polardb-2.6.0_xcluster8.4.21-20260716_pxbaas-20260915",
    "LockMode": "Unlock",
    "Expired": false,
    "PolarDBXDBInstanceName": "pxc-*********",
    "ConnAddrs": [
      {
        "ConnectionString": "pxsp-********.rds.aliyuncs.com",
        "Port": 3306,
        "NetType": "0",
        "VpcId": "vpc-********"
      }
    ],
    "Nodes": [
      {
        "Id": "2005777",
        "Name": "pxsp-********",
        "ZoneId": "cn-hangzhou-a",
        "ClassCode": "polarx.supabase.x2.small"
      }
    ],
    "TenantMode": false
  },
  "AccessDeniedDetail": {
    "AuthAction": "xxx",
    "AuthPrincipalType": "222",
    "NoPermissionType": "ImplicitDeny",
    "PolicyType": "PRIORITY",
    "EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==",
    "AuthPrincipalOwnerId": "111",
    "AuthPrincipalDisplayName": "xxx"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.