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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。