CreateBackup - ApsaraDB RDS - Alibaba Cloud Documentation Center

Membuat set cadangan untuk instans RDS.

Deskripsi operasi

Mesin yang didukung

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB.

Deskripsi

API ini memanggil fitur cadangan yang disediakan oleh RDS. Anda juga dapat menggunakan DBS. Untuk informasi selengkapnya, lihat Ikhtisar API DBS.

Perhatian

Saat Anda memanggil API ini, instans harus memenuhi kondisi berikut; jika tidak, operasi akan gagal:

Instans berada dalam status Berjalan.
Tidak ada tugas cadangan yang sedang berjalan.
Satu instans dapat membuat maksimal 20 set cadangan per hari.

Dokumen terkait

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:CreateBackup

create

*DBInstance

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

rds:ResourceTag
rds:ResourceTag
rds:ResourceTag

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	ID instans. Anda dapat memanggil operasi DescribeDBInstances untuk mengkueri ID instans.	rm-uf6wjk5****
DBName	string	No	Nama database. Pisahkan beberapa nama database dengan koma (,). Catatan Parameter ini berlaku ketika kondisi berikut terpenuhi: Parameter BackupStrategy ditentukan dan diatur ke db.	rds_mysql
BackupStrategy	string	No	Strategi cadangan. Nilai valid: db: cadangan database tunggal. instance: cadangan tingkat instans. Catatan Parameter ini berlaku ketika kondisi berikut terpenuhi: MySQL: Parameter BackupMethod ditentukan dan diatur ke Logical. SQL Server: Parameter BackupType ditentukan dan diatur ke FullBackup.	db
BackupMethod	string	No	Tipe cadangan. Nilai valid: Logical: cadangan logis (hanya didukung oleh instans MySQL dengan disk lokal). Physical: cadangan fisik (didukung oleh instans MySQL dengan disk lokal, SQL Server, dan PostgreSQL). Snapshot: cadangan snapshot (didukung oleh instans MySQL dengan cloud disk, SQL Server, PostgreSQL, dan MariaDB). Nilai default: Physical. Catatan Saat Anda menggunakan cadangan logis, database harus berisi data tersimpan (data tidak boleh kosong). Instans MariaDB hanya mendukung cadangan snapshot, tetapi nilai parameter harus diatur ke Physical.	Physical
BackupType	string	No	Metode cadangan untuk instans SQL Server. Nilai valid: Auto (default): Sistem secara otomatis memilih cadangan penuh atau cadangan inkremental. FullBackup: cadangan penuh. Catatan Nilai ini hanya berlaku ketika parameter BackupMethod diatur ke Physical.	Auto
BackupRetentionPeriod	integer	No	SQL Server: Ketika parameter BackupStrategy diatur ke db, parameter BackupMethod diatur ke Physical, dan parameter BackupType diatur ke FullBackup, Anda dapat menetapkan periode retensi set cadangan. Nilai valid: 7 hingga 730 hari, atau -1 (retensi jangka panjang). MySQL: Anda dapat menetapkan periode retensi set cadangan. Nilai valid: 7 hingga 730 hari, atau -1 (retensi jangka panjang).	7

Cara mengisi parameter opsional

API ini memiliki empat parameter opsional: BackupMethod, BackupStrategy, BackupType, dan DBName. Parameter opsional yang berbeda perlu dikombinasikan untuk mesin dan kasus penggunaan yang berbeda.

MySQL

Cadangan fisik, cadangan snapshot: Hanya BackupMethod yang perlu ditentukan. Semua database dicadangkan secara default. Cadangan database tunggal tidak didukung.
Cadangan logis:
- Database tunggal: BackupMethod, BackupStrategy, dan DBName harus ditentukan.
- Seluruh instans: BackupMethod dan BackupStrategy harus ditentukan.

SQL Server

Cadangan snapshot: Hanya BackupMethod yang perlu ditetapkan. Semua database dicadangkan secara default. Cadangan database tunggal tidak didukung.
Cadangan fisik:
- Cadangan penuh database tunggal: Keempat parameter opsional harus ditetapkan.
- Cadangan penuh seluruh instans: BackupMethod, BackupType, dan BackupStrategy harus ditetapkan.
- Sistem secara otomatis menentukan cadangan inkremental atau penuh: BackupMethod dan BackupType harus ditetapkan.
Cadangan logis: Tidak didukung.

PostgreSQL

Cadangan fisik, cadangan snapshot: Hanya BackupMethod yang perlu ditentukan. Semua database dicadangkan secara default. Cadangan database tunggal tidak didukung.
Cadangan logis: Tidak didukung.

MariaDB

Cadangan snapshot: Hanya BackupMethod yang perlu ditentukan. Semua database dicadangkan secara default. Cadangan database tunggal tidak didukung.
Cadangan fisik, cadangan logis: Tidak didukung.

Elemen respons

Element	Type	Description	Example
	object	Detail parameter tanggapan.
BackupJobId	string	ID tugas cadangan.	507****
RequestId	string	ID permintaan.	2C125605-266F-41CA-8AC5-3A643D4F42C5

Contoh

Respons sukses

JSONformat

{
  "BackupJobId": "507****",
  "RequestId": "2C125605-266F-41CA-8AC5-3A643D4F42C5"
}

Kode kesalahan

HTTP status code	Error code	Error message
400	BackupType.NotSupport	the specified backup type not support
400	InvalidBackupMethod.ValueNotSupport	The specified parameter "BackupMethod" is not valid.
400	ReadDBInstanceNotSupport	The operation is not permitted due to type of the instance.
400	IncorrectDBInstanceLockMode.ValueNotSupported	The Current DB instance lock mode does not support this operation.
400	BackupJobExists	A backup job already exists in the specified DB instance.
400	InvalidPreferredBackupTime.Format	Specified preferred backup time is not valid.
400	InvalidDBName.Format	Specified DB name 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	OperationDenied.ApiForbidden	operation not permitted.
403	IncorrectDBInstanceEngine	Current DB Instance engine does not support this operation.
403	IncorrectDBInstanceType	Current DB instance engine and type does not support operations.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.
403	IncorrectDBInstanceCharacterType	Current DB Instance character_type does not support this operation.
403	Exceeded.BackupTimes	The backup times exceeds.
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	InvalidDB.NotFound	Specified db does not exist or DB status does not support this operation.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.
404	Request.NotFound	The requested resource is not available.
404	HostInfo.NotFound	The specified host info is not found.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.