CheckCreateDdrDBInstance - ApsaraDB RDS - Alibaba Cloud Documentation Center

API ini digunakan untuk melakukan praperiksaan apakah suatu instans RDS dapat dipulihkan lintas wilayah menggunakan set cadangan lintas wilayah.

Deskripsi operasi

Mesin yang didukung

RDS MySQL
RDS PostgreSQL
RDS SQL Server

Dokumentasi fitur terkait

Penting Sebelum Anda menggunakan API ini, baca dokumentasi fitur dengan saksama untuk memastikan Anda sepenuhnya memahami prasyarat dan dampak penggunaan API sebelum melakukan operasi apa pun.

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

get

*DBInstance

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah instans tujuan. Anda dapat memanggil operasi DescribeRegions untuk meminta ID wilayah.	cn-hangzhou
Engine	string	Yes	Mesin database instans tujuan. Nilai yang valid: MySQL SQLServer PostgreSQL	MySQL
EngineVersion	string	Yes	Versi mesin database instans tujuan. Nilai yang valid untuk parameter ini bervariasi tergantung nilai parameter Engine: MySQL: 5.5/5.6/5.7/8.0 SQL Server: 2008r2 (SSD lokal berperforma tinggi, sudah tidak dijual)/08r2_ent_ha (edisi cloud disk, sudah tidak dijual)/2012/2012_ent_ha/2012_std_ha/2012_web/2014_std_ha/2016_ent_ha/2016_std_ha/2016_web/2017_std_ha/2017_ent/2019_std_ha/2019_ent PostgreSQL: 10.0/11.0/12.0/13.0/14.0/15.0 Catatan Untuk instans SQL Server, `_ent` menunjukkan Enterprise Cluster Edition, `_ent_ha` menunjukkan Enterprise Edition, `_std_ha` menunjukkan Standard Edition, dan `_web` menunjukkan Web Edition.	5.6
DBInstanceClass	string	Yes	Tipe instans tujuan. Untuk informasi lebih lanjut, lihat Tipe instans.	rds.mysql.s1.small
DBInstanceStorage	integer	Yes	Kapasitas penyimpanan instans tujuan. Nilai yang valid: 5 hingga 2000. Nilai harus kelipatan 5. Satuan: GB. Untuk informasi lebih lanjut, lihat Tipe instans.	20
RestoreType	string	Yes	Metode pemulihan. Nilai yang valid: 0 (default): Memulihkan data dari set cadangan. Jika Anda menentukan nilai ini, Anda juga harus menentukan parameter BackupSetId. 1: Memulihkan data ke titik waktu tertentu. Jika Anda menentukan nilai ini, Anda juga harus menentukan parameter RestoreTime, SourceRegion, dan SourceDBInstanceName.	0
BackupSetId	string	No	ID set cadangan yang digunakan untuk pemulihan. Anda dapat memanggil operasi DescribeCrossRegionBackups untuk meminta ID set cadangan. Catatan Parameter ini diperlukan ketika RestoreType disetel ke 0.	14358
RestoreTime	string	No	Titik waktu yang akan digunakan untuk memulihkan data. Titik waktu harus lebih awal dari waktu saat ini. Tentukan waktu dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu harus dalam UTC. Catatan Parameter ini diperlukan ketika RestoreType disetel ke 1.	2019-05-30T03:29:10Z
SourceRegion	string	No	ID wilayah instans sumber ketika Anda memulihkan data ke titik waktu tertentu. Catatan Parameter ini diperlukan ketika RestoreType disetel ke 1.	cn-hangzhou
SourceDBInstanceName	string	No	ID instans sumber ketika Anda memulihkan data ke titik waktu tertentu. Catatan Parameter ini diperlukan ketika RestoreType disetel ke 1.	rm-uf6wjk5****
ResourceGroupId	string	No	ID grup sumber daya. Anda dapat memanggil operasi DescribeDBInstanceAttribute untuk meminta ID grup sumber daya.	rg-acfmy****

Contoh penggunaan SQL Server

Metode 1: Praperiksaan berdasarkan set cadangan

1. Pertama, panggil operasi DescribeCrossRegionBackups untuk mendapatkan ID set cadangan penuh

Contoh permintaan

{
  "DBInstanceId": "rm-2ze07tklq********",  // ID instans
  "RegionId": "cn-beijing",                // ID wilayah tempat instans berada
  "CrossBackupRegion": "cn-shenzhen",      // ID wilayah tempat set cadangan lintas wilayah berada
  "StartTime": "2025-04-18T02:47:00Z",     // Waktu mulai kueri
  "EndTime": "2025-04-25T02:47:00Z",       // Waktu akhir kueri
  "PageSize": 30,                          // Jumlah record per halaman
  "PageNumber": 1                          // Nomor halaman
}

Contoh respons

Dalam daftar yang dikembalikan, temukan set cadangan penuh yang BackupType-nya F dan CrossBackupSetFile-nya berakhir dengan .zip, lalu dapatkan nilai field CrossBackupId. Dalam contoh ini, CrossBackupId adalah 18371944.

{
  "TotalRecordCount": 100,
  "PageRecordCount": 30,
  "RequestId": "7960B6AD-715E-5F0C-AB09-F59B6E76450B",
  "PageNumber": 1,
  "Items": {
    "Item": [
      {
        "BackupMethod": "P",    // Metode cadangan dari cadangan lintas wilayah. L: cadangan logis; P: cadangan fisik.
        "Category": "Basic",
        "EngineVersion": "2022_web",
        "InstanceId": 35449901,
        "CrossBackupDownloadLink": "https://rdsddrbak-st.oss-cn-shenzhen.aliyuncs.com/cn-beijing_rm-***********",
        "CrossBackupRegion": "cn-shenzhen",
        "CrossBackupSetLocation": "oss",
        "DBInstanceStorageType": "ecs",
        "BackupSetScale": 0,
        "CrossBackupSetFile": "cn-beijing_rm-*******_hins35449901_2025042310032419855966.zip",
        "CrossBackupSetSize": 9179823,
        "HasBackupTableMeta": "1",
        "RestoreRegions": {
          "RestoreRegion": [
            "cn-shenzhen"
          ]
        },
        "BackupEndTime": "2025-04-23T02:03:36Z",
        "BackupStartTime": "2025-04-23T02:03:24Z",
        "BackupType": "F",    // Tipe cadangan lintas wilayah. F: cadangan penuh; I: cadangan inkremental.
        "CrossBackupId": 18371944,    // ID file cadangan lintas wilayah
        "Engine": "mssql"
      }
    ]
  },
  "RegionId": "cn-beijing"
}

2. Kemudian, panggil CheckCreateDdrDBInstance untuk menentukan apakah pemulihan lintas wilayah dapat dilakukan

Contoh permintaan

{
  "RegionId": "cn-shenzhen",      // ID wilayah instans tujuan
  "Engine": "SQLServer",          // Mesin database instans tujuan
  "EngineVersion": "2022_web",    // Versi mesin database instans tujuan, harus sama dengan instans sumber
  "DBInstanceClass": "mssql.x2.medium.w1", // Tipe instans tujuan
  "DBInstanceStorage": 100,       // Kapasitas penyimpanan instans tujuan (satuan: GB)
  "RestoreType": "0",             // Metode pemulihan. 0: pulihkan dari set cadangan; 1: pulihkan ke titik waktu.
  "BackupSetId": "18371944"       // ID cadangan penuh lintas wilayah yang diperoleh dengan memanggil operasi DescribeCrossRegionBackups
}

Contoh respons

Ketika IsValid adalah true, hal ini menunjukkan bahwa instans cadangan lintas wilayah dapat dibuat.

{
  "RequestId": "D55083BF-5328-50CA-8D85-40C8815D56AA",
  "IsValid": "true"
}

3. Panggil operasi CreateDdrInstance untuk memulihkan data dari set cadangan ke instans baru

Metode 2: Praperiksaan berdasarkan titik waktu

1. Panggil CheckCreateDdrDBInstance untuk menentukan apakah pemulihan lintas wilayah dapat dilakukan

Contoh permintaan

{
  "RegionId": "cn-shenzhen",      // ID wilayah instans tujuan
  "Engine": "SQLServer",          // Mesin database instans tujuan
  "EngineVersion": "2022_web",    // Versi mesin database instans tujuan, harus sama dengan instans sumber
  "DBInstanceClass": "mssql.x2.medium.w1", // Tipe instans tujuan
  "DBInstanceStorage": 100,       // Kapasitas penyimpanan instans tujuan (satuan: GB)
  "RestoreType": "1",             // Metode pemulihan. 0: pulihkan dari set cadangan; 1: pulihkan ke titik waktu.
  "RestoreTime": "2025-04-26T06:40:00Z", // Titik waktu untuk pemulihan
  "SourceRegion": "cn-beijing",   // ID wilayah instans sumber
  "SourceDBInstanceName": "rm-2ze07tklq********" // ID instans sumber
}

Contoh respons

Ketika IsValid adalah true, hal ini menunjukkan bahwa instans cadangan lintas wilayah dapat dibuat.

{
  "RequestId": "A1A20D0D-4113-56DC-838A-E211B45D6F36",
  "IsValid": "true"
}

2. Panggil operasi CreateDdrInstance untuk memulihkan data ke instans baru berdasarkan titik waktu

Elemen respons

Element	Type	Description	Example
	object	Detail parameter respons.
IsValid	string	Menunjukkan apakah instans pemulihan bencana dapat dibuat. Nilai yang valid: true false	true
RequestId	string	ID permintaan.	1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC

Contoh

Respons sukses

JSONformat

{
  "IsValid": "true",
  "RequestId": "1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC"
}

Kode kesalahan

HTTP status code	Error code	Error message
400	IncorrectDBInstanceType	Current DB instance engine and type does not support operations.
400	InvalidRestoreType.Format	Specified restore type is not valid.
400	NoBackupSetRegion	BackupSetRegion is absence.
400	IncorrectBackupSetType	Backup set type should be ddr.
400	NoSourceInstanceName	No SourceDBInstanceName.
400	NoAvailableDisasterRestoreBakset	No available disaster restore bakset.
400	IncorrectBackupSetMethod	Current backup set method does not support operations.
400	InvalidBackupType.Format	Specified backup type is not valid.
400	IncorrectEngineVersion	Current engine version does not support operations.
400	IncorrectBaksetVersion	Current bakset version does not support operations.
400	CrossRegionUnsupportTDE	Cross-region disaster restore not support TDE bakset.
400	DisasterRestoreRegionNotMatched	Disaster restore should be operated in the ddr region or source region.
400	InvalidMinorVersion.NotFound	Specified minor version does not exists.
400	InvalidDBInstanceId.MalFormed	The specified parameter DBInstanceId is not valid.
400	InvalidEngine.Malformed	Specified engine is not valid.
400	InvalidEngineVersion.Malformed	Specified engine version is not valid.
400	MissingUserID	The request is missing a user_id parameter.
400	MissingUID	The request is missing a uid parameter.
400	UserPermissionFailure	The request processing has failed due to user permission.
400	InvalidServiceType.Format	Specified service type is not valid.
400	InvalidStorage.Format	Specified Storage 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	IncorrectDBType	The current DB type does not support this operation.
403	IncorrectDBInstance	The current DB instance does not support this operation.
403	ResourceConfigError	The request processing has failed due to resource config error.
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	RestoreType.NotFound	RestoreType is not found.
404	InvalidBackupSetID.NotFound	Specified backup set ID does not exist.
404	InvalidDBInstance.NotFound	The specified instance does not exist or is not supported.
404	InvalidDBInstanceClass.NotFound	Specified DB instance class is not found.
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.