使用PythonSDK調用DescribeBackupPlanList查看備份計劃詳情 - Database Backup

本文介紹如何使用阿里雲Python語言SDK開發包，調用Database BackupDBS的DescribeBackupPlanList介面（查看備份計劃）。

查看OpenAPI文檔

在調用OpenAPI前，建議您先閱讀對應介面文檔（DescribeBackupPlanList），瞭解、學習調用該介面所需要的參數及許可權等。更多資訊，請參見2019-03-06 API概覽或2021-01-01 API概覽。

建立RAM使用者並完成授權

如您已建立RAM使用者且已完成授權，可跳過此步驟。

建立RAM使用者。
1. 訪問RAM使用者列表，單擊建立使用者。
2. 設定登入名稱稱為dbs-openapi-operator，選擇訪問方式為OpenAPI 呼叫訪問。
3. 單擊確定，建立RAM使用者並儲存AccessKey ID與AccessKey Secret資訊。
完成授權。
1. 訪問RAM使用者列表，單擊目標RAM使用者操作列的添加許可權。
2. 在文字框中搜尋AliyunDBS，選擇AliyunDBSFullAccess策略。
  說明
  - AliyunDBSFullAccess策略擁有DBS所有讀寫權限，授權該策略的子帳號可以進行DBS執行個體的購買、配置、管理等操作。AliyunDBSReadOnlyAccess策略擁有DBS所有讀許可權，授權該許可權的子帳號可以查看主帳號下所有DBS任務的任務詳情、任務配置等資訊，但不能進行變更操作。
  - 您也可以按需進行自訂策略。更多資訊，請參見Database Backup自訂權限原則參考。
3. 單擊確認新增授權，完成授權操作。

調用OpenAPI

本文介紹阿里雲Python語言SDK方式調用OpenAPI，其他語言SDK的用法也類似。更多資訊，請參見Database BackupDBS SDK。

準備Python環境

下載並安裝Python 3。如您已安裝Python，查看Python版本的命令樣本：python --version。

配置環境變數

配置環境變數ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET。

Linux和macOS系統：將以下命令中的<ACCESS_KEY_ID>和<ACCESS_KEY_SECRET>替換為您自己的AccessKey ID和AccessKey Secret，然後在終端裝置中逐條運行。
```
export ALIBABA_CLOUD_ACCESS_KEY_ID=<ACCESS_KEY_ID>
export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<ACCESS_KEY_SECRET>
```
Windows系統：建立環境變數檔案，添加環境變數ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET，並寫入已準備好的AccessKey ID和AccessKey Secret。然後重啟Windows系統。

安裝依賴

在終端裝置中，逐條運行如下命令，安裝環境依賴。

pip install alibabacloud_dbs20190306

下載範例程式碼

訪問DescribeBackupPlanList，進入該介面在OpenAPI門戶的調試地址。
在左側的參數配置頁簽，填寫需要的參數資訊，本樣本需要在Region參數中輸入cn-hangzhou。
在右側的SDK樣本頁簽，選擇Python語言，單擊下載完整工程按鈕，下載範例程式碼包。
本地解壓並進入alibabacloud_sample目錄。

運行代碼

執行以下命令。

python sample.py

返回樣本如下。

{
    "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
    }
}