ListSupabaseProjects - 查询Supabase项目列表

更新时间:

查询Supabase实例列表。

接口说明

  • 本接口用于查询 Supabase 实例列表

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

说明 您可以调用 DescribeRegions 接口查看可用的地域 ID。
cn-hangzhou
NextTokenstring

下一个查询开始 Token。

caeba0bbb2be03f84eb48b699f0a****
MaxResultsinteger

本次读取的最大数据量,默认值为 10。

20

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

ABB39CC3-4488-4857-905D-2E4A051D****
PageNumberinteger

当前页码。

1
PageRecordCountinteger

当前页记录数。

20
TotalRecordCountinteger

总记录数。

2
Itemsarray<object>

实例详情列表。

itemsobject

实例详情。

Statusstring

Supabase 实例状态。

running
PublicConnectUrlstring

Supabase DashBoard 公网连接串。

10.154.11.10
DashboardUserNamestring

Supabase Dashboard 用户名(暂未使用)。

null
EngineVersionstring

数据库版本。

6.0
ZoneIdstring

可用区 ID。

cn-hangzhou-h
ProjectNamestring

Supabase 项目名称。

supabase_project
VSwitchIdstring

vSwitch ID。

vsw-bp1cpq8mr64paltkb****
CreateTimestring

创建时间。

2021-10-09T04:54:08Z
ProjectIdstring

Supabase 实例 ID。

sbp-12***
DiskPerformanceLevelstring

云盘等级。

PL0
StorageSizelong

存储空间大小,单位 GB。

2
PayTypestring

计费类型,取值说明:

  • Postpaid:按量付费。
  • Prepaid:包年包月。
  • Free: 免费。
Postpaid
PrivateConnectUrlstring

Supbase Dashboard 内网连接串。

192.168.0.1
ProjectSpecstring

Supabase 实例规格。

1C1G
VpcIdstring

VPC ID。

vpc-bp19ame5m1r3oejns****
SecurityIPListstring

IP 白名单分组下的 IP 列表,以逗号隔开,有以下三种格式:

  • 0.0.0.0/0
  • 10.23.12.24(IP)
  • 10.23.12.24/24(CIDR 模式,无类域间路由,/24表示了地址中前缀的长度,范围为[1,32]
127.0.0.1
DashboardPasswordstring

Supabase Dashboard 密码(暂未使用)。

xxpassword
RegionIdstring

地域 ID。

cn-hangzhou
Enginestring

数据库类型。

gpdb
NextTokenstring

下一个查询开始 Token。

caeba0bbb2be03f84eb48b699f0a****
MaxResultsinteger

本次读取的最大数据量,默认值为 10。

50

示例

正常返回示例

JSON格式

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D****",
  "PageNumber": 1,
  "PageRecordCount": 20,
  "TotalRecordCount": 2,
  "Items": [
    {
      "Status": "running",
      "PublicConnectUrl": "10.154.11.10",
      "DashboardUserName": null,
      "EngineVersion": 6,
      "ZoneId": "cn-hangzhou-h",
      "ProjectName": "supabase_project",
      "VSwitchId": "vsw-bp1cpq8mr64paltkb****",
      "CreateTime": "2021-10-09T04:54:08Z",
      "ProjectId": "sbp-12***",
      "DiskPerformanceLevel": "PL0",
      "StorageSize": 2,
      "PayType": "Postpaid",
      "PrivateConnectUrl": "192.168.0.1",
      "ProjectSpec": "1C1G",
      "VpcId": "vpc-bp19ame5m1r3oejns****",
      "SecurityIPList": "127.0.0.1",
      "DashboardPassword": "xxpassword",
      "RegionId": "cn-hangzhou",
      "Engine": "gpdb"
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "MaxResults": 50
}

错误码

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