DescribeBackups - ApsaraDB RDS - Alibaba Cloud Documentation Center

Operasi ini digunakan untuk mengkueri daftar backup dari instance RDS.

Deskripsi operasi

Mesin database yang didukung

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

rds:DescribeBackups

get

DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	ID instance. Anda dapat memanggil DescribeDBInstances untuk mendapatkannya.	rm-uf6wjk5****
BackupId	string	No	ID set backup.	327329803
BackupStatus	string	No	Status set backup. Nilai yang valid: Success: Backup telah selesai. Failed: Backup gagal.	Success
BackupMode	string	No	Mode backup. Nilai yang valid: Automated: backup otomatis yang dilakukan oleh sistem Manual: backup manual	Automated
StartTime	string	No	Waktu mulai kueri. Tentukan waktu dalam format yyyy-MM-ddTHH:mmZ. Waktu harus dalam UTC.	2011-06-01T16:00Z
EndTime	string	No	Waktu akhir kueri. Waktu akhir harus lebih lambat dari waktu mulai. Tentukan waktu dalam format yyyy-MM-ddTHH:mmZ. Waktu harus dalam UTC. Catatan Saat Anda menggunakan operasi ini untuk mengkueri daftar backup, sebaiknya persempit rentang waktu antara waktu mulai dan waktu akhir. Rentang waktu yang panjang dapat menyebabkan masalah timeout.	2011-06-15T16:00Z
PageSize	integer	No	Jumlah entri per halaman. Nilai yang valid: 30 50 100 Nilai default: 30.	30
PageNumber	integer	No	Nomor halaman. Nilai yang valid: bilangan bulat apa pun yang lebih besar dari 0 dan tidak melebihi nilai maksimum dari tipe data Integer. Nilai default: 1.	1
BackupType	string	No	Tipe backup. Nilai yang valid: FullBackup: backup penuh IncrementalBackup: backup inkremental	FullBackup

Elemen respons

Element	Type	Description	Example
	object	Detail parameter respons.
Items	object
Backup	array<object>	Daftar set backup.
	array<object>	Detail dari daftar set backup.
BackupDownloadLinkByDB	object
BackupDownloadLinkByDB	array<object>	An array consisting of URLs from which you can download backup sets of individual databases.
	object
DataBase	string	The name of the database.	dbs
DownloadLink	string	The public URL from which you can download the backup set.	https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=****&dbList=tb1
IntranetDownloadLink	string	The internal URL from which you can download the backup set.	https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=****&dbList=tb1
BackupDownloadURL	string	The URL that is used to download the backup set over the Internet. If the backup set cannot be downloaded, null is returned. Catatan For example, if BackupMethod of an ApsaraDB RDS for SQL Server instance is set to Snapshot, a null string is returned.	http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/****
BackupEndTime	string	The end time of the backup task. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.	2019-02-13T12:20:00Z
BackupId	string	The ID of the backup set.	321020562
BackupInitiator	string	The initiator of the backup task. Valid values: System User	System
BackupIntranetDownloadURL	string	The URL that is used to download the backup set over an internal network. If the backup set cannot be downloaded, null is returned. Catatan For example, if BackupMethod of an ApsaraDB RDS for SQL Server instance is set to Snapshot, a null string is returned.	http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/****
BackupMethod	string	The method that is used to generate the backup set. Valid values: Logical: logical backup Physical: physical backup Snapshot: snapshot backup	Physical
BackupMode	string	The backup mode of the backup set. Valid values: Automated Manual	Automated
BackupSize	integer	The size of the data backup file. Unit: bytes.	2167808
BackupStartTime	string	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.	2019-02-03T12:20:00Z
BackupStatus	string	The state of the backup set.	Success
BackupType	string	The backup type of the backup set. Valid values: FullBackup IncrementalBackup	FullBackup
Checksum	string	The checksum. The value of this parameter is calculated by using the CRC64 algorithm.	1835830439****
ConsistentTime	integer	The point in time at which the data in the backup set is consistent. The return value of this parameter is a timestamp. Catatan If the instance runs MySQL 5.6, a timestamp is returned. Otherwise, the value 0 is returned.	1576506856
CopyOnlyBackup	string	The backup mode of the backup set. Valid values: 0: the standard mode. This mode supports full backups and incremental backups. 1: the copy-only mode. This mode supports only full backups. Catatan This parameter is returned only when the instance runs SQL Server.	0
DBInstanceId	string	The instance ID.	rm-uf6wjk5****
Encryption	string	The encryption information about the backup set.	{}
Engine	string	The type of the database engine. Valid values: MySQL SQLServer PostgreSQL MariaDB	MySQL
EngineVersion	string	The version of the database engine.	8.0
HostInstanceID	string	The ID of the instance that generates the backup set. This parameter is used to indicate whether the instance that generates the backup set is a primary instance or a secondary instance.	5882781
IsAvail	integer	Indicates whether the backup set is available. Valid values: 0: The backup set is unavailable. 1: The backup set is available.	1
MetaStatus	string	The status of the backup set 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. Catatan If an empty string is returned, the data backup file cannot be used to restore individual databases or tables.	OK
StorageClass	string	The storage class of the backup set. Valid values: 0: regular storage 1: archive storage	0
StoreStatus	string	Indicates whether the backup set can be deleted. Valid values: Enabled: The backup set can be deleted. Disabled: The backup set cannot be deleted.	Disabled
ExpectExpireTime	string		2025-06-17T12:10:23Z
PageNumber	string	Nomor halaman.	1
PageRecordCount	string	Jumlah set backup pada halaman saat ini.	30
RequestId	string	ID permintaan.	1A6D328C-84B8-40DC-BF49-6C73984D7494
TotalEcsSnapshotSize	integer	Ukuran rantai snapshot dari instance. Satuan: byte.	0
TotalRecordCount	string	Jumlah total catatan.	100

Contoh

Respons sukses

JSONformat

{
  "Items": {
    "Backup": [
      {
        "BackupDownloadLinkByDB": {
          "BackupDownloadLinkByDB": [
            {
              "DataBase": "dbs",
              "DownloadLink": "https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=****&dbList=tb1",
              "IntranetDownloadLink": "https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=****&dbList=tb1"
            }
          ]
        },
        "BackupDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/****",
        "BackupEndTime": "2019-02-13T12:20:00Z",
        "BackupId": "321020562",
        "BackupInitiator": "System",
        "BackupIntranetDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/****",
        "BackupMethod": "Physical",
        "BackupMode": "Automated",
        "BackupSize": 2167808,
        "BackupStartTime": "2019-02-03T12:20:00Z",
        "BackupStatus": "Success",
        "BackupType": "FullBackup",
        "Checksum": "1835830439****",
        "ConsistentTime": 1576506856,
        "CopyOnlyBackup": "0",
        "DBInstanceId": "rm-uf6wjk5****",
        "Encryption": "{}",
        "Engine": "MySQL",
        "EngineVersion": "8.0",
        "HostInstanceID": "5882781",
        "IsAvail": 1,
        "MetaStatus": "OK",
        "StorageClass": "0",
        "StoreStatus": "Disabled",
        "ExpectExpireTime": "2025-06-17T12:10:23Z"
      }
    ]
  },
  "PageNumber": "1",
  "PageRecordCount": "30",
  "RequestId": "1A6D328C-84B8-40DC-BF49-6C73984D7494",
  "TotalEcsSnapshotSize": 0,
  "TotalRecordCount": "100"
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidRestoreTime.Malformed	The requested restoreTime param is invalid, or the requested restoreTime is not within the scope of the instance backup.
400	InvalidPageNumbers.Malformed	Specified page number is not valid.
400	InvalidStartTime.Format	Specified start time is not valid.
400	InvalidEndTime.Format	Specified end time is not valid.
400	InvalidParameterCombination	The end time must be greater than the start time
400	InvalidDBinstanceClass.ValueNotSupported	The specified parameter DBinstanceClass is invalid.
400	InvalidBackupSetLocation.Format	Specified backup set location is not valid.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400	Price.CommoditySys	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.
400	KmsApiError	User secret key invalid.
400	System.SaleValidateFailed	Sales expression validation system error.
400	Abs.InvalidAccount.NotFound	account is not found.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400	InvalideStatus.Format	The instance status does not support this operation.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.
500	ExternalFailure	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.
403	InvalidMaxRecordsPerPage.Malformed	Specified record number is not valid.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	IncorrectMinorVersion	Current engine minor version does not support operations.
403	OperationDenied.ZoneResource	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.
404	InvalidDBInstanceName.NotFound	The database instance does not exist.
404	InvalidDBInstance.NotFound	The specified instance does not exist or is not supported.
404	Request.NotFound	The requested resource is not available.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.
404	HostInfo.NotFound	The specified host info is not found.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.