本文介紹如何使用阿里云Python語言SDK開發包,調用數據災備(DBS)的DescribeBackupPlanList接口(查看備份計劃)。
查看OpenAPI文檔
在調用OpenAPI前,建議您先閱讀對應接口文檔(DescribeBackupPlanList),了解、學習調用該接口所需要的參數及權限等。更多信息,請參見2019-03-06 API概覽或2021-01-01 API概覽。
創建RAM用戶并完成授權
如您已創建RAM用戶且已完成授權,可跳過此步驟。
創建RAM用戶。
訪問RAM用戶列表,單擊創建用戶。
設置登錄名稱為dbs-openapi-operator,選擇訪問方式為使用永久 AccessKey 訪問。
單擊確定,創建RAM用戶并保存AccessKey ID與AccessKey Secret信息。
完成授權。
訪問RAM用戶列表,單擊目標RAM用戶操作列的添加權限。
在文本框中搜索
AliyunDBS
,選擇AliyunDBSFullAccess策略。說明AliyunDBSFullAccess策略擁有DBS所有讀寫權限,授權該策略的子賬號可以進行DBS實例的購買、配置、管理等操作。AliyunDBSReadOnlyAccess策略擁有DBS所有讀權限,授權該權限的子賬號可以查看主賬號下所有DBS任務的任務詳情、任務配置等信息,但不能進行變更操作。
您也可以按需進行自定義策略。更多信息,請參見數據災備(DBS)自定義權限策略參考。
單擊確認新增授權,完成授權操作。
調用OpenAPI
本文介紹阿里云Python語言SDK方式調用OpenAPI,其他語言SDK的用法也類似。更多信息,請參見數據庫備份DBS 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
}
}