All Products
Search

This Product

    ApsaraDB RDS:DescribeCrossRegionBackups

    Document Center

    ApsaraDB RDS:DescribeCrossRegionBackups

    Last Updated:Jun 12, 2026

    API ini digunakan untuk menanyakan daftar file pencadangan data lintas wilayah dari instance RDS tertentu.

    Deskripsi operasi

    Mesin yang berlaku

    • RDS MySQL (tipe penyimpanan harus SSD lokal berkinerja tinggi; cloud disk tidak didukung)

    • RDS PostgreSQL

    • RDS SQL Server

    Dokumen fitur terkait

    Penting Sebelum menggunakan API ini, baca dengan cermat dokumen fitur untuk memahami sepenuhnya prasyarat penggunaan API dan dampak setelah digunakan, lalu lakukan operasi.
    Catatan

    Untuk menanyakan file pencadangan log lintas wilayah, lihat DescribeCrossRegionLogBackupFiles.

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

    get

    *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 instance.

    rm-uf6wjk5****
    RegionId

    string

    Yes

    ID wilayah instance.

    cn-hangzhou
    CrossBackupRegion

    string

    No

    ID wilayah tujuan untuk pencadangan lintas wilayah.

    cn-shanghai
    CrossBackupId

    integer

    No

    ID file pencadangan lintas wilayah.

    Catatan

    Anda harus menentukan CrossBackupId atau kedua parameter rentang waktu (StartTime dan EndTime).

    14562
    StartTime

    string

    No

    Waktu mulai kueri. Format: yyyy-MM-ddTHH:mm:ssZ (GMT).

    Catatan

    Untuk zona waktu non-UTC, kurangi 8 jam dari waktu sebenarnya saat memasukkan nilai.

    2024-03-05T02:21:00Z
    EndTime

    string

    No

    Waktu akhir kueri. Format: yyyy-MM-ddTHH:mm:ssZ (GMT).

    Catatan

    Untuk zona waktu non-UTC, kurangi 8 jam dari waktu sebenarnya saat memasukkan nilai.

    2024-03-05T02:24:37Z
    PageSize

    integer

    No

    Jumlah catatan per halaman. Nilai yang valid:

    • 30

    • 50

    • 100

    Nilai default: 30.

    30
    PageNumber

    integer

    No

    Nomor halaman. Nilai yang valid: nilai apa pun yang lebih besar dari 0 dan tidak melebihi nilai maksimum Integer.

    Nilai default: 1.

    1
    BackupId

    integer

    No

    ID pencadangan pengguna.

    603524****
    ResourceGroupId

    string

    No

    ID grup sumber daya.

    rg-acfmy****

    Contoh penggunaan SQL Server

    Contoh permintaan

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

    Contoh respons

    Dalam daftar yang dikembalikan, temukan set pencadangan penuh yang BackupType-nya F dan CrossBackupSetFile-nya berakhiran .zip, lalu dapatkan nilai field CrossBackupId. Dalam contoh ini, CrossBackupId adalah 18371944. Anda kemudian dapat menggunakannya untuk memanggil CheckCreateDdrDBInstance untuk menentukan apakah pemulihan lintas wilayah dapat dilakukan.

    {
  "TotalRecordCount": 100,
  "PageRecordCount": 30,
  "RequestId": "7960B6AD-715E-5F0C-AB09-F59B6E76450B",
  "PageNumber": 1,
  "Items": {
    "Item": [
      {
        "BackupMethod": "P",    // Metode pencadangan lintas wilayah. L: pencadangan logis; P: pencadangan 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",    // Lokasi penyimpanan file pencadangan
        "DBInstanceStorageType": "ecs",
        "BackupSetScale": 0,    // Kebijakan pencadangan. 0: pencadangan instance; 1: pencadangan database tunggal
        "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 pencadangan lintas wilayah. F: pencadangan penuh; I: pencadangan inkremental
        "CrossBackupId": 18371944,    // ID file pencadangan lintas wilayah
        "Engine": "mssql"
      }
    ]
  },
  "RegionId": "cn-beijing"
}

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Detail parameter yang dikembalikan.

    EndTime

    string

    Waktu akhir kueri.

    2019-06-15T12:10:00Z
    Items

    object

    Item

    array<object>

    Daftar pencadangan lintas wilayah.

    array<object>

    Detail pencadangan lintas wilayah.

    BackupEndTime

    string

    The time when the cross-region data backup file was generated.

    2024-03-05T02:23:37Z
    BackupMethod

    string

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

    • L: logical backup

    • P: physical backup

    P
    BackupSetScale

    integer

    The level at which the cross-region data backup file is generated.

    • 0: instance-level backup

    • 1: database-level backup

    0
    BackupSetStatus

    integer

    The status of the cross-region data backup. Valid values:

    • 0: The cross-region data backup is successful.

    • 1: The cross-region data backup failed.

    0
    BackupStartTime

    string

    The time when the cross-region data backup started.

    2024-03-05T02:22:45Z
    BackupType

    string

    The type of the cross-region data backup. Valid values:

    • F: full data backup

    • I: incremental data backup

    F
    Category

    string

    The RDS edition of the instance. Valid values:

    • Basic: RDS Basic Edition.

    • HighAvailability: RDS High-availability Edition.

    • Finance: RDS Enterprise Edition. This edition is available only for the China site (aliyun.com).

    HighAvailability
    ConsistentTime

    string

    The point in time that is indicated by the data in the cross-region data backup file.

    2024-03-05T02:22:54Z
    CrossBackupId

    integer

    The ID of the cross-region data backup file.

    1249****
    CrossBackupRegion

    string

    The ID of the region in which the cross-region backup files of the instance are stored.

    cn-shanghai
    CrossBackupSetFile

    string

    The name of the compressed package that contains the cross-region data backup file.

    cn-hangzhou_rm-****_hins81xxx_data_20190612134426_qp.xb
    CrossBackupSetLocation

    string

    The location where the cross-region data backup file is stored.

    oss
    CrossBackupSetSize

    integer

    The size of the cross-region data backup file. Unit: bytes.

    5312836
    DBInstanceStorageType

    string

    The storage type. Valid values:

    • local_ssd: local SSDs. This is the recommended storage type.

    • cloud_ssd: standard SSD.

    • cloud_essd: enhanced SSD (ESSD).

    ssd
    Engine

    string

    The database engine of the instance.

    mysql
    EngineVersion

    string

    The database engine version.

    5.6
    InstanceId

    integer

    The instance ID. This parameter is used to determine whether the instance that generates the cross-region data backup file is a primary or secondary instance.

    8161***
    RestoreRegions

    object

    RestoreRegion

    array

    The regions to which the cross-region data backup file can be restored.

    string

    The region to which the cross-region data backup file can be restored.

    "cn-hangzhou", "cn-shanghai"
    PageNumber

    integer

    Nomor halaman. Nilai yang valid: nilai apa pun yang lebih besar dari 0 dan tidak melebihi nilai maksimum Integer.

    Nilai default: 1.

    1
    PageRecordCount

    integer

    Jumlah file pencadangan di halaman saat ini.

    30
    RegionId

    string

    ID wilayah instance.

    cn-hangzhou
    RequestId

    string

    ID permintaan.

    60912B41-7579-4B5D-B289-8856030F0A6A
    StartTime

    string

    Waktu mulai kueri.

    2019-05-30T12:10:00Z
    TotalRecordCount

    integer

    Jumlah total catatan.

    100

    Contoh

    Respons sukses

    JSONformat

    {
  "EndTime": "2019-06-15T12:10:00Z",
  "Items": {
    "Item": [
      {
        "BackupEndTime": "2024-03-05T02:23:37Z",
        "BackupMethod": "P",
        "BackupSetScale": 0,
        "BackupSetStatus": 0,
        "BackupStartTime": "2024-03-05T02:22:45Z",
        "BackupType": "F",
        "Category": "HighAvailability",
        "ConsistentTime": "2024-03-05T02:22:54Z",
        "CrossBackupDownloadLink": "http://rdsddrbak-shanghai.oss-cn-shanghai.aliyuncs.com/****",
        "CrossBackupId": 0,
        "CrossBackupRegion": "cn-shanghai",
        "CrossBackupSetFile": "cn-hangzhou_rm-****_hins81xxx_data_20190612134426_qp.xb",
        "CrossBackupSetLocation": "oss",
        "CrossBackupSetSize": 5312836,
        "DBInstanceStorageType": "ssd",
        "Engine": "mysql",
        "EngineVersion": "5.6",
        "InstanceId": 0,
        "RestoreRegions": {
          "RestoreRegion": [
            "\"cn-hangzhou\", \"cn-shanghai\""
          ]
        }
      }
    ]
  },
  "PageNumber": 1,
  "PageRecordCount": 30,
  "RegionId": "cn-hangzhou",
  "RequestId": "60912B41-7579-4B5D-B289-8856030F0A6A",
  "StartTime": "2019-05-30T12:10:00Z",
  "TotalRecordCount": 100
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 ParameterAbsence Necessary param is absence.
    400 InvalidParameters.Format Specified parameter is not valid.
    400 InvalidRegion.Format Specified Region is not valid.
    400 InvalidStartTime.Format Specified start time is not valid.
    400 InvalidEndTime.Format Specified end time is not valid.
    400 InvalidTime.Format Specified time 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 CrossBackupNotSupport Specified region not support cross region backup.
    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 InvalidPage.notFound Page not found.
    404 InvalidDBInstance.NotFound Specified instance does not exist or not support.
    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.