All Products
Search

This Product

    Data Management:Contoh SDK Python untuk DBS

    Document Center

    Data Management:Contoh SDK Python untuk DBS

    Last Updated:Mar 29, 2026

    Panggil operasi API DescribeBackupPlanList untuk mengkueri detail backup plan menggunakan SDK Python Data Disaster Recovery.

    Prasyarat

    Sebelum memulai, pastikan Anda telah:

    • Menginstal Python 3. Jalankan python --version untuk memeriksa.

    • Membuat Pengguna Resource Access Management (RAM) dengan kredensial AccessKey dan kebijakan AliyunDBSFullAccess atau AliyunDBSReadOnlyAccess yang telah ditetapkan. Lihat Buat pengguna RAM dan berikan izin jika Anda belum melakukannya.

    Cara kerja

    Semua contoh dalam topik ini menggunakan paket SDK alibabacloud_dbs20190306 untuk mengirim permintaan API ke layanan Data Disaster Recovery. SDK membaca kredensial dari variabel lingkungan, mengirim permintaan DescribeBackupPlanList, dan mengembalikan respons JSON terpaginasi yang berisi detail backup plan Anda.

    Buat pengguna RAM dan berikan izin

    Lewati bagian ini jika Anda sudah memiliki pengguna RAM dengan AccessKey dan izin yang diperlukan.

    1. Buka halaman Users di Konsol RAM dan klik Create User.

    2. Atur Logon Name menjadi dbs-openapi-operator dan Access Mode menjadi Using permanent AccessKey to access.

    3. Klik OK. Pada halaman yang muncul, simpan ID AccessKey dan Rahasia AccessKey pengguna RAM tersebut.

    4. Di halaman Users, temukan pengguna RAM tersebut dan klik Add Permissions pada kolom Actions.

    5. Masukkan AliyunDBS di kotak pencarian, lalu pilih salah satu kebijakan berikut:

      PolicyPermissions
      AliyunDBSFullAccessAkses baca dan tulis. Mengizinkan pembelian, konfigurasi, dan pengelolaan backup plan.
      AliyunDBSReadOnlyAccessAkses hanya-baca. Mengizinkan melihat detail dan konfigurasi tugas, tetapi tidak mengizinkan perubahan.
      Untuk membuat kebijakan kustom sesuai kebutuhan bisnis Anda, lihat Kebijakan kustom untuk Data Disaster Recovery.

    6. Klik Grant permissions.

    Panggil API

    1. Instal paket SDK

    pip install alibabacloud_dbs20190306
    Tip: Jalankan perintah ini di dalam lingkungan virtual untuk menghindari konflik dependensi dengan paket lain yang terinstal di sistem Anda: 
    python -m venv .venv
source .venv/bin/activate   # Linux atau macOS
.venv\Scripts\activate      # Windows
pip install alibabacloud_dbs20190306

    2. Atur variabel lingkungan

    SDK membaca kredensial Anda dari variabel lingkungan ALIBABA_CLOUD_ACCESS_KEY_ID dan ALIBABA_CLOUD_ACCESS_KEY_SECRET.

    Linux atau macOS — Jalankan perintah berikut, ganti placeholder dengan ID AccessKey dan Rahasia AccessKey Anda:

    export ALIBABA_CLOUD_ACCESS_KEY_ID=<your-access-key-id>
export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<your-access-key-secret>

    Windows — Tambahkan ALIBABA_CLOUD_ACCESS_KEY_ID dan ALIBABA_CLOUD_ACCESS_KEY_SECRET ke variabel lingkungan sistem Anda, lalu restart sistem.

    3. Dapatkan kode contoh

    1. Buka halaman debugging DescribeBackupPlanList di OpenAPI Explorer.

    2. Di tab Parameters, atur Region menjadi cn-hangzhou (atau wilayah target Anda).

    3. Di tab SDK Sample Code, pilih Python dan klik Download Project.

    4. Ekstrak paket tersebut dan buka direktori alibabacloud_sample.

    4. Jalankan kode contoh

    python sample.py

    Respons yang berhasil akan tampak seperti berikut:

    {
    "headers": {
        "date": "Mon, 17 Jun 2024 07:22:04 GMT",
        "content-type": "application/json;charset=utf-8",
        "content-length": "1064",
        "connection": "keep-alive",
        "keep-alive": "timeout=25",
        "vary": "Accept-Encoding",
        "access-control-allow-origin": "*",
        "access-control-expose-headers": "*",
        "x-acs-request-id": "4C4073F2-35A9-5819-88F1-C018A871****",
        "x-acs-trace-id": "3c79c1be14f6f17be6aaa9af0f02****",
        "etag": "1Jukbw3tBgZiZxgb8TVR****"
    },
    "statusCode": 200,
    "body": {
        "HttpStatusCode": 200,
        "Items": {
            "BackupPlanDetail": [
                {
                    "BackupGatewayId": 16****,
                    "BackupMethod": "physical",
                    "BackupObjects": "[]",
                    "BackupPeriod": "SUNDAY,MONDAY,TUESDAY,WEDNESDAY,THURSDAY,FRIDAY,SATURDAY",
                    "BackupPlanCreateTime": 1718606018000,
                    "BackupPlanId": "dbsqe3w3vxq****",
                    "BackupPlanName": "DBS-csyl-L-3",
                    "BackupPlanStatus": "init",
                    "BackupRetentionPeriod": 730,
                    "BackupStartTime": "12:00",
                    "BackupStorageType": "system",
                    "DuplicationArchivePeriod": 0,
                    "DuplicationInfrequentAccessPeriod": 0,
                    "EnableBackupLog": true,
                    "InstanceClass": "medium",
                    "OSSBucketName": "dbs-backup-137383785969****-cn-hangzhou-qxl0qf4g****",
                    "OSSBucketRegion": "cn-hangzhou",
                    "OpenBackupSetAutoDownload": false,
                    "ResourceGroupId": "rg-acfmz7u4zzr****",
                    "SourceEndpointDatabaseName": "",
                    "SourceEndpointInstanceID": "",
                    "SourceEndpointInstanceType": "agent",
                    "SourceEndpointIpPort": "121.XX.XXX.171:3306",
                    "SourceEndpointRegion": "cn-hangzhou",
                    "SourceEndpointUserName": "root"
                }
            ]
        },
        "PageNum": 0,
        "PageSize": 30,
        "RequestId": "4C4073F2-35A9-5819-88F1-C018A871****",
        "Success": true,
        "TotalElements": 1,
        "TotalPages": 1
    }
}

    Bidang respons utama:

    FieldDescription
    BackupPlanStatusStatus saat ini dari backup plan. init berarti rencana telah dibuat tetapi belum dimulai.
    BackupRetentionPeriodDurasi penyimpanan backup, dalam satuan hari. Pada contoh ini, 730 hari (2 tahun).
    BackupMethodJenis backup. physical berarti backup fisik pada tingkat penyimpanan.
    BackupPeriodHari dalam seminggu saat backup dijalankan.
    BackupStartTimeWaktu dalam sehari saat backup dimulai.
    EnableBackupLogApakah cadangan log diaktifkan untuk pemulihan pada titik waktu.
    TotalElementsJumlah total backup plan dalam respons. Gunakan bersama PageNum dan PageSize untuk paginasi.

    Langkah selanjutnya