GetSupabaseProject - 查询Supabase实例详情

更新时间:
复制 MD 格式

查询Supabase实例详情。

接口说明

此接口为查询 Supabase 实例详情

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

gpdb:GetSupabaseProject

get

*SupabaseProject

acs:gpdb:{#regionId}:{#accountId}:supabaseproject/{#ProjectId}

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID。

说明

您可以调用 DescribeRegions 接口查看可用的地域 ID。

cn-hangzhou

ProjectId

string

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

sbp-263****

返回参数

名称

类型

描述

示例值

object

AppliedIdleTimeHours

string

自动暂停时间

0.5

AutoScale

string

是否启用自动启停。 取值说明:

  • true:启用。启用后,supabase 会根据流量情况自动暂停和自动恢复。

  • false:关闭,关闭后,会关闭 supabase 自动启停功能。

枚举值:

  • true :

    true

  • false :

    false

false

CreateTime

string

创建时间。

2019-09-08T16:00:00Z

DBSecurityIpList

string

数据库白名单。

127.0.0.1,100.64.XX.XX/10

DashboardPassword

string

Supabase Dashboard 密码(暂未使用)

xxpassword

DashboardUserName

string

Supabase Dashboard 用户名(暂未使用)

username

DiskPerformanceLevel

string

云盘 PL 等级。取值可选:

  • PL0

  • PL1

PL0

Engine

string

数据库引擎类型。

postgres

EngineVersion

string

引擎版本。

15

Eni

string

弹性网卡 ID。

eni-xxxxxx

InstanceVersion

string

当前实例版本。

v1.0.3

Lightweight

string

是否是轻量版 Project

false

PayType

string

计费类型,取值如下:

  • POSTPAY:按量付费。

  • PREPAY:包年包月。

POSTPAY

PrivateConnectUrl

string

Supabase Dashboard 内网连接串。

192.168.0.11

ProjectDescription

string

supabase 项目的详细描述信息。

for-test-project

ProjectId

string

Supabase 实例 ID。

sbp-545434

ProjectName

string

Supabase 项目名称。

supabase_project

ProjectSpec

string

Supabase 实例规格。

1C1G

PublicConnectUrl

string

Supabase Dashboard 公网连接串。

10.154.11.10

RegionId

string

地域 ID。

说明

您可以调用 DescribeRegions 接口查看可用的地域 ID。

cn-hangzhou

RequestId

string

请求 ID。

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

SecurityIpList

string

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

127.0.0.1

Status

string

Supabase 实例状态。

running

StorageSize

integer

存储空间大小,单位 GB。

2

StorageType

string

存储类型取值如下:

  • cloud_essd_pl0

  • cloud_essd_pl1

  • cloud_essd_pl2

  • cloud_essd_pl3

cloud_essd_pl0

VSwitchId

string

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

vsw-bp1cpq8mr64paltkb****

VpcId

string

VPC ID。

说明
  • 您可以调用 DescribeRdsVpcs 接口查看可用的 VPC ID。

  • 该参数必须传入。

vpc-bp*******************

ZoneId

string

可用区 ID。

说明

您可以调用 DescribeRegions 接口查看可用的可用区 ID。

cn-hangzhou-i

示例

正常返回示例

JSON格式

{
  "AppliedIdleTimeHours": "0.5",
  "AutoScale": "false",
  "CreateTime": "2019-09-08T16:00:00Z",
  "DBSecurityIpList": "127.0.0.1,100.64.XX.XX/10",
  "DashboardPassword": "xxpassword",
  "DashboardUserName": "username",
  "DiskPerformanceLevel": "PL0",
  "Engine": "postgres",
  "EngineVersion": "15",
  "Eni": "eni-xxxxxx",
  "InstanceVersion": "v1.0.3",
  "Lightweight": "false",
  "PayType": "POSTPAY",
  "PrivateConnectUrl": "192.168.0.11",
  "ProjectDescription": "for-test-project",
  "ProjectId": "sbp-545434",
  "ProjectName": "supabase_project",
  "ProjectSpec": "1C1G",
  "PublicConnectUrl": "10.154.11.10",
  "RegionId": "cn-hangzhou",
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D****",
  "SecurityIpList": "127.0.0.1",
  "Status": "running",
  "StorageSize": 2,
  "StorageType": "cloud_essd_pl0",
  "VSwitchId": "vsw-bp1cpq8mr64paltkb****",
  "VpcId": "vpc-bp*******************",
  "ZoneId": "cn-hangzhou-i"
}

错误码

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

变更历史

更多信息,参考变更详情