Alibaba Cloud CLI を使用すると、コマンドラインからデータディザスタリカバリの管理およびメンテナンスを自動化できます。このチュートリアルを完了すると、以下の操作が可能になります。
RAM ユーザーの認証情報を使用して Alibaba Cloud CLI をインストールおよび構成する
利用可能なデータディザスタリカバリ API オペレーションを確認する
API オペレーションを呼び出して応答を解釈する
このチュートリアルでは、作業例として DescribeBackupPlanBilling を使用します。
前提条件
開始する前に、以下の要件を満たしていることを確認してください。
Alibaba Cloud アカウント
AliyunDMSFullAccessポリシーがアタッチされた RAM ユーザー — 「RAM ユーザーへの権限付与」をご参照ください。RAM ユーザーの AccessKey ペア — 「AccessKey ペアの作成」をご参照ください。
Alibaba Cloud アカウントは、すべての Alibaba Cloud サービスへのフルアクセス権を持ちます。最小権限の原則に従い、必要な権限のみを付与した Resource Access Management (RAM) ユーザーを作成してください。データディザスタリカバリでサポートされている権限ポリシーについては、「定義済みシステムポリシー」および「カスタムポリシー」をご参照ください。
ステップ 1：Alibaba Cloud CLI のインストール
ご利用の環境に合った方法を選択してください。
オプション A：Cloud Shell を使用（インストール不要）
Alibaba Cloud CLI は Cloud Shell にプリインストール済みです。また、Cloud Shell では ID 認証情報が自動的に構成されるため、ステップ 2 をスキップしてステップ 3 に進むことができます。「Cloud Shell とは」をご参照ください。
オプション B：ローカルにインストール
Alibaba Cloud CLI は Windows、Linux、macOS をサポートしています。ご利用のオペレーティングシステムに応じて、以下のガイドに従ってください。
Alibaba Cloud CLI の概要については、「Alibaba Cloud CLI とは」をご参照ください。
ステップ 2：認証情報の構成
Cloud Shell を使用している場合は、このステップをスキップしてください。認証情報は自動的に構成されます。
AkProfile 構成を使用して、Alibaba Cloud CLI に AccessKey 認証情報を構成します。
「RAM ユーザーの作成」および「AccessKey ペアの作成」を行います。
AliyunDMSFullAccessポリシーを RAM ユーザーにアタッチします。詳細については、「RAM ユーザーへの権限付与」をご参照ください。使用するリージョンのリージョン ID を確認してください。Alibaba Cloud CLI は、指定したリージョンに API リクエストを送信します。データディザスタリカバリがサポートするリージョンについては、エンドポイントをご参照ください。
AkProfile構成ファイルに AccessKey 認証情報を構成します。手順付きの例については、「認証情報の構成」の「構成例」セクションをご参照ください。
Alibaba Cloud CLI は複数の認証情報タイプをサポートしています。詳細な一覧については、「認証情報の構成」の「認証情報タイプ」セクションをご参照ください。
任意のコマンドに対して特定のリージョンを指定するには、--region オプションを使用します。これにより、認証情報構成および環境変数で設定されたリージョンがオーバーライドされます。「API 呼び出しのコマンドラインオプション」をご参照ください。
ステップ 3：CLI コマンドの生成
OpenAPI Explorer は、すべてのデータディザスタリカバリ API オペレーションについて、すぐに使用できる CLI コマンドを生成します。
OpenAPI Explorer で「DescribeBackupPlanBilling」ページを開きます。
パラメーター タブで、リクエストパラメーターを入力します。
CLI 例 タブをクリックして、生成されたコマンドを表示します。
コマンドをコピーまたは実行します。
をクリックして、コマンドを Cloud Shell で直接実行します。
をクリックして、コマンドをクリップボードにコピーし、ローカルシェルに貼り付けます。
OpenAPI Explorer は、デフォルトで生成されたコマンドに --region を追加します。ローカルでコマンドを実行する際、Alibaba Cloud CLI は認証情報構成に設定されたリージョンではなく、このオプションで指定されたリージョンを使用します。必要に応じて、このオプションを削除または保持してください。パラメーターフォーマットの詳細については、「パラメーターフォーマット」をご参照ください。
ステップ 4：API オペレーションの呼び出し
Alibaba Cloud CLI は、デフォルトでバージョン 2019-03-06 のデータディザスタリカバリ API オペレーションを統合しています。バージョン 2021-01-01 のオペレーションを呼び出すには、--force オプションおよび --version オプションを使用します。OpenAPI Explorer は、2021-01-01 API のコマンドを生成する際に、これらのオプションを自動的に追加します。
複数のコマンドを連携させる複雑なワークフローについては、効率を向上させるためにシェルスクリプトにまとめてください。
オペレーションの完全な一覧については、以下をご参照ください。
利用可能な API オペレーションの一覧表示
--help オプションを使用して、Alibaba Cloud CLI で利用可能なすべての 2019-03-06 API オペレーションを確認します。
aliyun dbs --help期待される出力：
バックアップスケジュールの課金情報の照会
以下の例では、DescribeBackupPlanBilling を呼び出して、バックアップスケジュールの請求情報を照会します。詳細については、「DescribeBackupPlanBilling」のパラメーターのリファレンスをご参照ください。
aliyun dbs DescribeBackupPlanBilling --BackupPlanId 'dbstooi01ex****' --ShowStorageType true期待される出力：
{
"HttpStatusCode": 200,
"RequestId": "DD7BC7F5-4E3A-5DF3-BFF9-831503C4D9E3",
"Success": true,
"Item": {
"BuyCreateTimestamp": 1658372830000,
"FullStorageSize": 151,
"BuyExpiredTimestamp": 1661097600000,
"BuySpec": "micro",
"QuotaEndTimestamp": 1659283200000,
"IsExpired": true,
"QuotaStartTimestamp": 1656604800000,
"TotalFreeBytes": 858993459200,
"PaiedBytes": 0,
"UsedFullBytes": 0,
"IsFreeBytesUnlimited": true,
"ContStorageSize": 10437039,
"BuyChargeType": "PREPAY",
"UsedIncrementBytes": 9406734
}
}エラーのトラブルシューティング
API 呼び出しがエラーを返した場合、エラーコードを確認し、リクエストパラメーターとその値が有効であることを検証してください。
セルフサービスによる診断を行うには、「OpenAPI Troubleshoot」にアクセスし、応答に含まれるリクエスト ID または SDK エラー情報を入力してください。
次のステップ
利用可能なすべての操作を、API リファレンス (2019-03-06) および API リファレンス (2021-01-01) で参照できます。
--forceおよび--versionを使用して2021-01-01オペレーションを呼び出します — 「API オペレーションの強制呼び出し」をご参照ください。