全部產品
Search
文件中心

PolarDB:DescribeSupabaseInstances

更新時間:Sep 10, 2026

查詢Supabase執行個體列表。

介面說明

該介面用於取得使用者已設定的自訂終端節點(Endpoint)列表,便於管理和查看私有連線或 VPC 終端服務的設定。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

是

地域 ID。

cn-hangzhou

PageNumber

integer

否

分頁頁碼(從 1 起,預設 1)。

1

PageSize

integer

否

每頁大小(預設 20,最大 100)。

30

DBInstanceName

string

否

執行個體名稱(精確過濾,逗號分隔多個)。

pxsp-hz********

Description

string

否

執行個體描述(模糊匹配)。

project name

MaxResults

integer

否

分頁查詢時每頁行數。最大值為 100。預設值:當不設定值或設定的值小於 10 時,預設值為 10。當設定的值大於 100 時,預設值為 100。

1000

NextToken

string

否

下一個查詢開始 Token。

xxdds

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

請求 ID。

C457B28E-9CAB-4B77-B5C6-5D71B7870B6E

Data

object

執行個體列表分頁結果。

TotalNumber

integer

總條數。

10

PageNumber

integer

分頁頁碼。

1

PageSize

integer

每頁大小。

20

Instances

array<object>

執行個體列表。

object

叢集 ID。

DBInstanceName

string

pxsp-jinwusp30

Description

string

我的 Supabase 项目

Status

string

RUNNING

RegionId

string

cn-beijing

ZoneId

string

cn-beijing-i

CreateTime

string

2026-06-08T07:19:05.000+0000

SupabaseClassCode

string

polarx.supabase.x4.2xlarge

TenantMode

boolean

是否为多租户模式,true=多租户,false=单租户

MySQL

AccessDeniedDetail

object

無權限存取詳情。

AuthAction

string

鑑權動作。

xxx

AuthPrincipalType

string

鑑權主體類型。

222

NoPermissionType

string

無權限類型。

ImplicitDeny

PolicyType

string

策略類型。

System

EncodedDiagnosticMessage

string

診斷資訊。

AQEAAAAAacnceTlBNjlFODgyLTlBMDUtNUUyRC04MzE5LUQwMzZDRjJFQTM3NA==

AuthPrincipalOwnerId

string

鑑權主體 OwnerId。

111

AuthPrincipalDisplayName

string

鑑權主體名稱。

xxx

MaxResults

integer

分頁查詢時每頁行數。最大值為 100。預設值:當不設定值或設定的值小於 10 時,預設值為 10。當設定的值大於 100 時,預設值為 100。

1000

NextToken

string

下一個查詢開始 Token。

xxdds

樣本

正常返回樣本

JSON格式

{
  "RequestId": "C457B28E-9CAB-4B77-B5C6-5D71B7870B6E",
  "Data": {
    "TotalNumber": 10,
    "PageNumber": 1,
    "PageSize": 20,
    "Instances": [
      {
        "DBInstanceName": "pxsp-jinwusp30",
        "Description": "我的 Supabase 项目",
        "Status": "RUNNING",
        "RegionId": "cn-beijing",
        "ZoneId": "cn-beijing-i",
        "CreateTime": "2026-06-08T07:19:05.000+0000",
        "SupabaseClassCode": "polarx.supabase.x4.2xlarge",
        "TenantMode": true
      }
    ]
  },
  "AccessDeniedDetail": {
    "AuthAction": "xxx",
    "AuthPrincipalType": "222",
    "NoPermissionType": "ImplicitDeny",
    "PolicyType": "System",
    "EncodedDiagnosticMessage": "AQEAAAAAacnceTlBNjlFODgyLTlBMDUtNUUyRC04MzE5LUQwMzZDRjJFQTM3NA==",
    "AuthPrincipalOwnerId": "111",
    "AuthPrincipalDisplayName": "xxx"
  },
  "MaxResults": 1000,
  "NextToken": "xxdds"
}

錯誤碼

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

變更歷史

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