Python 用データディザスタリカバリ SDK を使用して DescribeBackupPlanList オペレーションを呼び出し、バックアップスケジュールの詳細をクエリします。 - Data Management

このトピックでは、Python 用データディザスタリカバリ SDK を使用して DescribeBackupPlanList オペレーションを呼び出し、バックアップスケジュールの詳細をクエリする方法について説明します。

API ドキュメントの表示

DescribeBackupPlanList オペレーションを呼び出す前に、API オペレーションに関するドキュメントを読んで、API オペレーションの呼び出しに必要なパラメーターと権限について理解することをお勧めします。詳細については、「機能別の操作一覧」または「機能別の操作一覧」をご参照ください。

RAM ユーザーの作成と RAM ユーザーへの権限の付与

Resource Access Management (RAM) ユーザーを作成し、RAM ユーザーに権限を付与済みの場合は、この手順をスキップしてください。

RAM ユーザーを作成します。
1. RAM コンソールのユーザーページに移動し、[ユーザーの作成] をクリックします。
2. [ログオン名] を dbs-openapi-operator に設定し、[アクセスモード] を [永続 Accesskey を使用してアクセス] に設定します。
3. [OK] をクリックします。表示されるページで、作成した RAM ユーザーの AccessKey ID と AccessKey シークレットを保存します。
RAM ユーザーに権限を付与します。
1. ユーザーページで、RAM ユーザーを見つけ、[権限の追加] 列の [アクション] をクリックします。
2. 検索ボックスに AliyunDBS と入力し、[aliyundbsfullaccess] ポリシーを選択します。
  説明
  - [aliyundbsfullaccess] ポリシーには、データディザスタリカバリの読み取りと書き込みの権限が含まれています。このポリシーがアタッチされている RAM ユーザーは、データディザスタリカバリで複数の操作を実行できます。たとえば、RAM ユーザーはデータディザスタリカバリバックアップスケジュールを購入、構成、および管理できます。[aliyundbsreadonlyaccess] ポリシーには、データディザスタリカバリの読み取り権限が含まれています。このポリシーがアタッチされている RAM ユーザーは、タスクの詳細や構成を含め、Alibaba Cloud アカウント内のすべてのデータディザスタリカバリタスクに関する情報を表示できます。ただし、RAM ユーザーはタスクを変更することはできません。
  - ビジネス要件に基づいてカスタムポリシーを作成することもできます。詳細については、「データディザスタリカバリのカスタムポリシー」をご参照ください。
3. [権限の付与] をクリックして、承認を完了します。

API オペレーションの呼び出し

このセクションでは、Python 用データディザスタリカバリ SDK を使用して API オペレーションを呼び出す方法について説明します。他のプログラミング言語の SDK も同様の方法で使用できます。詳細については、データディザスタリカバリをご参照ください。

Python のインストール

Python 3 をダウンロードしてインストールします。Python をインストール済みの場合は、python --version コマンドを実行して Python のバージョンを表示できます。

環境変数の構成

このセクションでは、ALIBABA_CLOUD_ACCESS_KEY_ID および ALIBABA_CLOUD_ACCESS_KEY_SECRET 環境変数を構成する方法について説明します。

Linux または macOS オペレーティングシステムを使用している場合は、次のコマンドの <ACCESS_KEY_ID> および <ACCESS_KEY_SECRET> を AccessKey ID と AccessKey シークレットに置き換えます。次に、デバイスでコマンドを順番に実行します。
```
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 シークレットを指定します。次に、Windows オペレーティングシステムを再起動します。

依存関係のインストール

ターミナルデバイスで次のコマンドを実行して、依存関係をインストールします。

pip install alibabacloud_dbs20190306

サンプルコードのダウンロード

OpenAPI Explorer で DescribeBackupPlanList オペレーションのデバッグページに移動します。
左側の [パラメーター] タブで、リクエストパラメーターを構成します。この例では、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
    }
}