All Products
Search
Document Center

AnalyticDB for PostgreSQL:DescribeLogBackups

Last Updated:Jan 22, 2024

Queries a list of log backups.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
gpdb:DescribeLogBackupsRead
  • DBInstance
    acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The ID of the instance.

Note You can call the DescribeDBInstances operation to query the IDs of all AnalyticDB for PostgreSQL instances in a specific region.
gp-bp12ga6v69h86****
StartTimestringYes

The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

2022-12-12T02:00Z
EndTimestringYes

The end of the time range to query. The end time must be later than the start time. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

2022-12-12T03:00Z
PageSizeintegerNo

The number of entries to return on each page. Valid values:

  • 30
  • 50
  • 100

Default value: 30.

30
PageNumberintegerNo

The number of the page to return. The value must be an integer that is greater than 0. Default value: 1.

1

Response parameters

ParameterTypeDescriptionExample
object
TotalLogSizelong

The total size of logs in the time range. Unit: bytes.

386748
PageSizeinteger

The number of backup sets on the current page.

30
PageNumberinteger

The page number of the returned page.

1
RequestIdstring

The ID of the request.

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

The total number of entries.

5
Itemsobject []

Details of the backup sets.

LogFileSizelong

The size of the log backup set. Unit: bytes.

77350
LogTimestring

The timestamp of the log.

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

The name of the compute node.

segment-0
LogFileNamestring

The name of the log backup set that is stored in Object Storage Service (OSS).

000000010000000400000012
DBInstanceIdstring

The ID of the coordinator node.

gp-bp12ga6v69h86****-master
BackupIdstring

The ID of the backup set.

12413721782

Examples

Sample success responses

JSONformat

{
  "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"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history