GetSupabaseProject - 查询Supabase实例详情

更新时间:

查询Supabase实例详情。

接口说明

此接口为查询 Supabase 实例详情

调试

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

授权信息

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

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

请求参数

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

地域 ID。

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

Supabase 实例 ID,可以在控制台 Supabase 页面获取。

sbp-263****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

Supabase 项目名称。

supabase_project
ProjectSpecstring

Supabase 实例规格。

1C1G
Statusstring

Supabase 实例状态。

running
PublicConnectUrlstring

Supabase Dashboard 公网连接串。

10.154.11.10
PrivateConnectUrlstring

Supabase Dashboard 内网连接串。

192.168.0.11
RegionIdstring

地域 ID。

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

可用区 ID。

说明 您可以调用 DescribeRegions 接口查看可用的可用区 ID。
cn-hangzhou-i
VpcIdstring

VPC ID。

说明
  • 您可以调用 DescribeRdsVpcs 接口查看可用的 VPC ID。
  • 该参数必须传入。
  • vpc-bp*******************
    VSwitchIdstring

    vSwitch ID,若传入 VPC ID 的值,则该参数必传。

    vsw-bp1cpq8mr64paltkb****
    SecurityIpListstring

    IP 白名单分组下的 IP 列表,以逗号隔开

    127.0.0.1
    DiskPerformanceLevelstring

    云盘 PL 等级。取值可选:

    • PL0
    • PL1
    PL0
    Enginestring

    数据库引擎类型。

    postgres
    EngineVersionstring

    引擎版本。

    15
    StorageSizelong

    存储空间大小,单位 GB。

    2
    CreateTimestring

    创建时间。

    2019-09-08T16:00:00Z
    DashboardUserNamestring

    Supabase Dashboard 用户名(暂未使用)

    username
    ProjectIdstring

    Supabase 实例 ID。

    sbp-545434
    DashboardPasswordstring

    Supabase Dashboard 密码(暂未使用)

    xxpassword

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D****",
      "ProjectName": "supabase_project",
      "ProjectSpec": "1C1G",
      "Status": "running",
      "PublicConnectUrl": "10.154.11.10",
      "PrivateConnectUrl": "192.168.0.11",
      "RegionId": "cn-hangzhou",
      "ZoneId": "cn-hangzhou-i",
      "VpcId": "vpc-bp*******************",
      "VSwitchId": "vsw-bp1cpq8mr64paltkb****",
      "SecurityIpList": "127.0.0.1",
      "DiskPerformanceLevel": "PL0",
      "Engine": "postgres",
      "EngineVersion": 15,
      "StorageSize": 2,
      "CreateTime": "2019-09-08T16:00:00Z",
      "DashboardUserName": "username",
      "ProjectId": "sbp-545434",
      "DashboardPassword": "xxpassword"
    }

    错误码

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