DescribeSharedBackups-阿里云帮助中心

Queries 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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

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.	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: backups shared with you. ShareOutgoing: backups you shared.	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. The value must be an integer that is greater than 0. Default value: 1.	1
DBType	string	No	The database type. Valid values: MySQL PostgreSQL Oracle To specify multiple types, separate them with a comma.	MySQL,PostgreSQL,Oracle
DBVersion	string	No	The database version.	8.0

Response elements

Element	Type	Description	Example
	object	The response object.
TotalRecordCount	string	The total record count.	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>	A list of shared backup sets.
	object	The details of a shared backup set.
BackupSetSize	string	The size of the backup set, in bytes.	4639948800
ConsistentTime	string	The UNIX timestamp of the consistent snapshot, in seconds.	1589253947
BackupStatus	string	The backup status. Valid values: Success: The backup is complete. Failed: The backup failed.	Success
BackupType	string	The backup type. Only full backups are supported. The value is fixed to FullBackup.	FullBackup
BackupStartTime	string	The start time of the backup, in UTC.	2020-11-15T07:30:05Z
BackupEndTime	string	The end time of the backup, in UTC.	2020-05-12T03:25:55Z
BackupId	string	The backup set ID.	111111111
DBClusterId	string	The cluster ID.	pc-****************
BackupsLevel	string	The backup level. Valid values: Level-1: Level-1 backup. Level-2: Level-2 backup.	Level-2
BackupMode	string	The backup mode. Valid values: Automated: automated backup Manual: manual backup	Manual
BackupMethod	string	The backup method. Only snapshot backup is supported. The value is fixed to 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: prepaid (subscription)	Postpaid
ServerlessType	string	The Serverless type. A value of AgileServerless indicates a Serverless cluster, while an empty value indicates a standard cluster.	AgileServerless
RegionId	string	The region ID.	cn-hongzhou
SharerUID	string	The UID of the account that shared the backup set.	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.