文档

DescribeLogBackups - 查看日志备份列表

更新时间:

查看日志备份列表。

调试

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

授权信息

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

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

请求参数

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

实例 ID。

说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的实例 ID。
gp-bp12ga6v69h86****
StartTimestring

查询开始时间。格式: yyyy-MM-ddTHH:mmZ(UTC 时间)。

2022-12-12T02:00Z
EndTimestring

查询结束时间,需要大于查询开始时间。格式:yyyy-MM-ddTHH:mmZ(UTC 时间)。

2022-12-12T03:00Z
PageSizeinteger

每页记录数,取值:

  • 30
  • 50
  • 100

默认值:30

30
PageNumberinteger

页码,取值:大于 0 且不超过 Integer 的最大值。默认值:1

1

返回参数

名称类型描述示例值
object
TotalLogSizelong

符合时间范围内的总日志大小,单位为 Byte。

386748
PageSizeinteger

本页备份集个数。

30
PageNumberinteger

页码。

1
RequestIdstring

请求 ID。

24B9FCAF-2CBC-51C3-B563-F1C70D750187
TotalCountinteger

总记录数。

5
Itemsobject []

备份集列表。

LogFileSizelong

备份日志文件大小,单位:Byte。

77350
LogTimestring

日志时间戳。

2022-12-12T02:14:26Z
SegmentNamestring

节点名称。

segment-0
LogFileNamestring

日志文件名(OSS 路径)。

000000010000000400000012
DBInstanceIdstring

实例的 Master 节点 ID。

gp-bp12ga6v69h86****-master
BackupIdstring

备份集 ID。

12413721782

示例

正常返回示例

JSON格式

{
  "TotalLogSize": 386748,
  "PageSize": 30,
  "PageNumber": 1,
  "RequestId": "24B9FCAF-2CBC-51C3-B563-F1C70D750187",
  "TotalCount": 5,
  "Items": [
    {
      "LogFileSize": 77350,
      "LogTime": "2022-12-12T02:14:26Z",
      "SegmentName": "segment-0",
      "LogFileName": "000000010000000400000012",
      "DBInstanceId": "gp-bp12ga6v69h86****-master",
      "BackupId": "12413721782"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈