全部产品
Search
文档中心

云原生数据库 PolarDB:DescribeSupabaseInstances - 查询 Supabase 实例列表

更新时间: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

地域 ID

cn-beijing

ZoneId

string

可用区 ID

cn-beijing-i

CreateTime

string

创建时间

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

SupabaseClassCode

string

Supabase 规格代码

polarx.supabase.x4.2xlarge

TenantMode

boolean

多租户模式

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

错误码

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

变更历史

更多信息,参考变更详情