DescribeSharedBackups

Updated at:

Queries the list of shared backup sets.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardb:DescribeSharedBackups

get

*All Resource

*

None None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

No

The region ID.

Note

You can call the DescribeRegions operation to query the available regions for the target account, including region IDs.

Note

This parameter is required for the API call. Omitting it may result in an InternalFailure (HTTP 500) error.

cn-hangzhou

DBClusterId

string

No

The cluster ID.

pc-**************

BackupId

string

No

The backup set ID.

111111111

ShareType

string

Yes

The share type. Valid values:

  • ShareIncoming: Shared with me.

  • ShareOutgoing: Shared by me.

Valid values:

  • ShareOutgoing
  • ShareIncoming

ShareIncoming

PageSize

integer

No

The number of entries per page. Valid values: 30 to 100. Default value: 30.

30

PageNumber

integer

No

The page number. Valid values: positive integers up to the maximum value of the Integer type. Default value: 1.

1

DBType

string

No

The database type. Valid values:

  • MySQL

  • PostgreSQL

  • Oracle

Separate multiple types with commas (,).

Note

This parameter is required for the API call. Omitting it will result in an InvalidDBType.Malformed (HTTP 400) error.

MySQL,PostgreSQL,Oracle

DBVersion

string

No

The database version.

8.0

Response elements

Element

Type

Description

Example

object

Schema of Response

TotalRecordCount

string

The total number of entries.

16

PageRecordCount

string

The number of entries on the current page.

1

RequestId

string

The request ID.

3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF

PageNumber

string

The page number.

1

Items

array<object>

The list of shared backup sets.

object

The basic information of the shared backup set.

BackupSetSize

string

The size of the backup file. Unit: bytes.

4639948800

ConsistentTime

string

The point in time of the consistent snapshot. The value is a UNIX timestamp. Unit: seconds.

1589253947

BackupStatus

string

The backup status. Valid values:

  • Success: The backup is completed.

  • Failed: The backup failed.

Success

BackupType

string

The backup type. Only full backups are supported. The value is fixed as FullBackup.

FullBackup

BackupStartTime

string

The start time of the backup. The time is displayed in UTC.

2020-11-15T07:30:05Z

BackupEndTime

string

The end time of the backup. The time is displayed in UTC.

2020-05-12T03:25:55Z

BackupId

string

The backup set ID.

111111111

DBClusterId

string

The cluster ID.

pc-****************

BackupsLevel

string

The backup set level. Valid values:

  • Level-1: level-1 backup

  • Level-2: level-2 backup

Level-2

BackupMode

string

The backup mode. Valid values:

  • Automated: automatic backup

  • Manual: manual backup

Manual

BackupMethod

string

The data backup method. Only snapshot backups are supported. The value is fixed as Snapshot.

Snapshot

DBType

string

The database engine type.

MySQL

DBVersion

string

The database engine version.

5.6

ShareType

string

The share type.

ShareIncoming

PayType

string

The billing method. Valid values:

  • Postpaid: pay-as-you-go

  • Prepaid: subscription

Postpaid

ServerlessType

string

The Serverless type. A value of AgileServerless indicates that the current cluster is a Serverless cluster. An empty value indicates that the current cluster is one of the common clusters.

AgileServerless

RegionId

string

The region ID.

cn-hongzhou

SharerUID

string

The UID of the sharer.

170*************

Examples

Success response

JSON format

{
  "TotalRecordCount": "16",
  "PageRecordCount": "1",
  "RequestId": "3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF",
  "PageNumber": "1",
  "Items": [
    {
      "BackupSetSize": "4639948800",
      "ConsistentTime": "1589253947",
      "BackupStatus": "Success",
      "BackupType": "FullBackup",
      "BackupStartTime": "2020-11-15T07:30:05Z",
      "BackupEndTime": "2020-05-12T03:25:55Z",
      "BackupId": "111111111",
      "DBClusterId": "pc-****************",
      "BackupsLevel": "Level-2",
      "BackupMode": "Manual",
      "BackupMethod": "Snapshot",
      "DBType": "MySQL",
      "DBVersion": "5.6",
      "ShareType": "ShareIncoming",
      "PayType": "Postpaid",
      "ServerlessType": "AgileServerless",
      "RegionId": "cn-hongzhou",
      "SharerUID": "170*************"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.