All Products
Search
Document Center

ApsaraDB RDS:DescribeDetachedBackups

Last Updated:May 29, 2023

You can call the DescribeDetachedBackups operation to query the data backup files of an instance that is deleted.

Operation Description

The ID of the resource group.

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
rds:DescribeDetachedBackupsREAD
  • RDS
    acs:rds:*:{#accountId}:dbinstance/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringNo

The backup mode of the data backup file. Valid values:

  • Automated
  • Manual
rm-uf6wjk5xxxxxxx
BackupIdstringNo

The beginning of the time range to query.

Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

327xxxxx3
BackupStatusstringNo

The end of the time range to query. The end time must be later than the start time.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.

Success
BackupModestringNo

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

  • 30
  • 50
  • 100
NoteDefault value: 30.
Automated
StartTimestringNo

The number of the page to return. Valid values: any non-zero positive integer.

NoteDefault value: 1.
2021-03-01T16:00Z
EndTimestringNo

The region ID of the instance.

2021-03-15T16:00Z
PageSizeintegerNo

The ID of the resource group.

30
PageNumberintegerNo

The page number of the returned page.

1
RegionstringYes

The ID of the request.

cn-hangzhou
ResourceGroupIdstringNo

The number of data backup files on the page.

rg-acfmy*****

Response parameters

ParameterTypeDescriptionExample
object
PageNumberstring

The total number of entries returned.

1
RequestIdstring

The details of the returned data backup files.

1A6D328C-84B8-40DC-BF49-6C73984D7494
PageRecordCountstring

The point in time at which the data in the data backup file is consistent. The return value of this parameter is a timestamp.

NoteIf the instance runs MySQL 5.6, a timestamp is returned. Otherwise, the value 0 is returned.
30
TotalRecordCountstring

Indicates whether the data backup file can be deleted. Valid values:

  • Enabled: The data backup file can be deleted.
  • Disabled: The data backup file cannot be deleted.
100
Itemsobject []

The status of the data backup file. Valid values:

  • Success
  • Failed
ConsistentTimelong

The backup type. Valid values:

  • FullBackup
  • IncrementalBackup
1576506856
StoreStatusstring

The start time of the backup.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.

Disabled
BackupStatusstring

The URL that is used to download the data backup file over the Internet. If the data backup file cannot be downloaded, an empty string is returned.

Success
BackupTypestring

Indicates whether the data backup file is available. Valid values:

  • 0: The data backup file is unavailable.
  • 1: The data backup file is available.
FullBackup
BackupStartTimestring

The status of the data backup file that is used to restore individual databases or tables. Valid values:

  • OK: The data backup file is normal.
  • LARGE: The data backup file contains an abnormally large number of tables. It cannot be used to restore individual databases or tables.
  • EMPTY: The data backup file is generated from a failed backup task.
2019-02-03T12:20:00Z
BackupDownloadURLstring

The end time of the backup.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.

http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx
IsAvailinteger

The ID of the data backup file.

1
MetaStatusstring

The No. of the instance that generates the data backup file. This parameter is used to indicate whether the instance that generates the data backup file is a primary instance or a secondary instance.

OK
BackupEndTimestring

The URL that is used to download the data backup file over an internal network. If the data backup file cannot be downloaded, an empty string is returned.

2019-02-13T12:20:00Z
BackupIdstring

The size of the data backup file. Unit: bytes.

321020562
HostInstanceIDstring

The backup mode of the data backup file. Valid values:

  • Automated
  • Manual
5882781
BackupIntranetDownloadURLstring

The ID of the instance.

http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxx
BackupSizelong

The description of the instance.

2167808
BackupModestring

The method that is used to generate the data backup file. Valid values:

  • Logical: logical backup
  • Physical: physical backup
Automated
DBInstanceIdstring

This operation is supported for instances that run MySQL with local SSDs. For more information about how to retain the data backup files of an instance after the instance is released, see Configure automatic backup.

rm-uf6wjk5xxxxxxx
DBInstanceCommentstring

Indicates whether the data backup file is available. Valid values:

  • 0: The data backup file is unavailable.
  • 1: The data backup file is available.
test
BackupMethodstring

Indicates whether the data backup file can be deleted. Valid values:

  • Enabled: The data backup file can be deleted.
  • Disabled: The data backup file cannot be deleted.
Physical

Examples

Sample success responses

JSONformat

{
  "PageNumber": "1",
  "RequestId": "1A6D328C-84B8-40DC-BF49-6C73984D7494",
  "PageRecordCount": "30",
  "TotalRecordCount": "100",
  "Items": {
    "Backup": [
      {
        "ConsistentTime": 1576506856,
        "StoreStatus": "Disabled",
        "BackupStatus": "Success",
        "BackupType": "FullBackup",
        "BackupStartTime": "2019-02-03T12:20:00Z",
        "BackupDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx",
        "IsAvail": 1,
        "MetaStatus": "OK",
        "BackupEndTime": "2019-02-13T12:20:00Z",
        "BackupId": "321020562",
        "HostInstanceID": "5882781",
        "BackupIntranetDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxx",
        "BackupSize": 2167808,
        "BackupMode": "Automated",
        "DBInstanceId": "rm-uf6wjk5xxxxxxx",
        "DBInstanceComment": "test",
        "BackupMethod": "Physical"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2022-08-04The input parameters of the API operation change.
Change itemChange content
Input ParametersThe input parameters of the API operation change.
    Added Input Parameters: ResourceGroupId