ListSupabaseBackupJobs - 查询 Supabase 备份任务列表

更新时间:
复制 MD 格式

查询指定 Supabase 实例的备份任务及任务进度。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

gpdb:ListSupabaseBackupJobs

list

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

RegionId

string

否

地域 ID。

说明

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

cn-hangzhou

ProjectId

string

是

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

sbp-263****

BackupMode

string

否

备份模式。取值说明:

  • Automated:系统自动备份。

  • Manual:手动备份。

如果不传,则返回所有。

Automated

MaxResults

integer

否

本次请求返回的最大记录数。

50

NextToken

string

否

分页查询标记。首次查询不传入;后续查询传入上一次响应返回的 NextToken。

caeba0bbb2be03f84eb48b699f0a****

返回参数

名称

类型

描述

示例值

object

Items

array<object>

备份任务列表。

object

BackupJobId

string

备份任务 ID。

123

BackupMode

string

备份模式。取值说明:

  • Automated:系统自动备份

  • Manual:手动备份

Automated

BackupStatus

string

备份任务状态。已确认的状态包括:schedule(等待调度)、backup(备份中)。

backup

Process

string

备份任务进度百分比,例如 0%。任务处于 schedule(等待调度)状态时可能为空字符串。

0%

StartTime

string

备份任务开始时间,使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。任务处于 schedule(等待调度)状态时可能为空字符串。

2026-10-09T04:37:01Z

MaxResults

integer

本次请求返回的最大记录数。

50

NextToken

string

下一页的查询标记,可作为下次请求的 NextToken。

caeba0bbb2be03f84eb48b699f0a****

RequestId

string

请求 ID。

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

示例

正常返回示例

JSON格式

{
  "Items": [
    {
      "BackupJobId": "123",
      "BackupMode": "Automated",
      "BackupStatus": "backup",
      "Process": "0%",
      "StartTime": "2026-10-09T04:37:01Z"
    }
  ],
  "MaxResults": 50,
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D****"
}

错误码

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

变更历史

更多信息,参考变更详情。