All Products
Search

This Product

    Cloud Backup:DescribeHanaRetentionSetting

    Document Center

    Cloud Backup:DescribeHanaRetentionSetting

    Last Updated:Jun 11, 2026

    Mengkueri periode retensi cadangan database SAP HANA.

    Deskripsi operasi

    • If you want to query the backup parameters of a database, you can call the DescribeHanaBackupSetting operation.

    • Cloud Backup deletes the expired catalogs and data that are related to Backint and file backup. The deleted catalogs and data cannot be restored. We recommend that you set the retention period based on your business requirements.

    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

    hbr:DescribeHanaRetentionSetting

    get

    *All Resource

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    VaultId

    string

    Yes

    ID penyimpanan cadangan.

    v-000ii8t******ntrt2
    ClusterId

    string

    Yes

    ID instans SAP HANA.

    cl-0002ys1i******wwtf
    DatabaseName

    string

    No

    Nama database.

    C4P

    Elemen respons

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    280DD872-EE25-52E8-9CB4-491067173DD0
    VaultId

    string

    The ID of the backup vault.

    v-0006wkn7******zkn
    Schedule

    string

    The policy to update the retention period. Format: I|{startTime}|{interval}, which indicates that the retention period is updated at an interval of {interval} starting from {startTime}.

    • startTime: the time at which the system starts to run a backup job. The time follows the UNIX time format. Unit: seconds.

    • interval: the interval at which the system runs a backup job. The interval follows the ISO 8601 standard. For example, PT1H indicates an interval of 1 hour. P1D indicates an interval of one day.

    I|0|P1D
    Success

    boolean

    Indicates whether the request was successful. Valid values:

    • true

    • false

    true
    DatabaseName

    string

    The database name.

    Q01
    Disabled

    boolean

    Indicates whether the backup is permanently retained. Valid values:

    • true: The backup is permanently retained.

    • false: The backup is retained for the specified number of days.

    false
    Code

    string

    The response code. The status code 200 indicates that the request was successful.

    200
    RetentionDays

    integer

    The number of days for which the backup is retained. If the value of the Disabled parameter is false, the backup is retained for the number of days specified by this parameter.

    3650
    Message

    string

    The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.

    successful
    ClusterId

    string

    The ID of the SAP HANA instance.

    cl-0003jyv******fsku5m

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "280DD872-EE25-52E8-9CB4-491067173DD0",
  "VaultId": "v-0006wkn7******zkn",
  "Schedule": "I|0|P1D",
  "Success": true,
  "DatabaseName": "Q01",
  "Disabled": false,
  "Code": "200",
  "RetentionDays": 3650,
  "Message": "successful",
  "ClusterId": "cl-0003jyv******fsku5m"
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.