DescribeSupabaseInstanceAttribute - 查询 Supabase 实例详情 - 云原生数据库 PolarDB

查询Supabase实例详情

接口说明

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardbx:DescribeSupabaseInstanceAttribute

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID	cn-hangzhou
DBInstanceName	string	是	实例名称	pxsp-*********

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID	C457B28E-9CAB-4B77-B5C6-5D71B7870B6E
Data	object	实例详情
DBInstanceName	string	实例名称	pxc-supabase-001
Status	string	实例状态	Running
RegionId	string	地域 ID	cn-hangzhou
ZoneId	string	可用区 ID	cn-zhangjiakou-a
SupabaseClassCode	string	Supabase 规格代码	polarx.supabase.x4.xlarge
NodeClass	string	节点规格	polarx.supabase.x2.small
NodeCount	integer	节点数量	1
VpcId	string	VPC ID	vpc-********
VSwitchId	string	交换机 ID	vsw-********
CreateTime	string	创建时间	2025-07-13 10:01:50 +0800
TopologyType	string	拓扑类型	1azone
EngineVersion	string	引擎版本	2.0
MinorVersion	string	小版本	polardb-2.6.0_xcluster8.4.21-20260716_pxbaas-20260915
LockMode	string	锁定模式	Unlock
Expired	boolean	是否过期	false
PolarDBXDBInstanceName	string	关联的 PolarDB-X 实例名	pxc-*********
ConnAddrs	array<object>	连接地址列表
	object	连接地址。
ConnectionString	string	连接地址	pxsp-********.rds.aliyuncs.com
Port	integer	端口	3306
NetType	string	网络类型	0
VpcId	string	VPC ID	vpc-********
Nodes	array<object>	节点列表
	object	节点 ID。
Id	string	节点 ID	2005777
Name	string	节点名称	pxsp-********
ZoneId	string	可用区 ID	cn-hangzhou-a
ClassCode	string	规格代码	polarx.supabase.x2.small
TenantMode	boolean	多租户模式	false
AccessDeniedDetail	object	无权限访问详情
AuthAction	string	鉴权动作	xxx
AuthPrincipalType	string	鉴权主体类型	222
NoPermissionType	string	无权限类型	ImplicitDeny
PolicyType	string	策略类型	PRIORITY
EncodedDiagnosticMessage	string	诊断信息	AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==
AuthPrincipalOwnerId	string	鉴权主体 OwnerId	111
AuthPrincipalDisplayName	string	鉴权主体名称	xxx

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。