Data Management:データディザスタリカバリの API 操作を呼び出すための Alibaba Cloud CLI の使用

使用する前に Alibaba Cloud CLI をインストールする必要があります。Alibaba Cloud CLI は、Windows、Linux、および macOS をサポートしています。Alibaba Cloud CLI をインストールする際は、デバイスのオペレーティングシステムに基づいてインストールパッケージを選択してください。詳細については、以下のトピックをご参照ください。

• Windows: Windows に Alibaba Cloud CLI をインストールする

• Linux: Linux に Alibaba Cloud CLI をインストールする

• macOS: macOS に Alibaba Cloud CLI をインストールする

Alibaba Cloud CLI は Cloud Shell にプリインストールされています。Cloud Shell は ID 資格情報を自動的に構成します。Alibaba Cloud CLI で実行するコマンドをデバッグするために Cloud Shell を使用できます。詳細については、「Cloud Shell とは」をご参照ください。

Alibaba Cloud CLI を使用する前に、Alibaba Cloud CLI で ID 資格情報やリージョン ID などの情報を指定する必要があります。Alibaba Cloud CLI はさまざまな種類の ID 資格情報をサポートしています。詳細については、「資格情報を構成する」トピックの「資格情報の種類」セクションをご参照ください。Alibaba Cloud CLI では、RAM ユーザーの Accesskey ペアを使用して ID 資格情報を構成できます。RAM ユーザーの AccessKey ペアを使用する場合は、次の手順を実行します。

1. RAM ユーザーを作成し、RAM ユーザーの AccessKey ペアを作成して ID 資格情報を構成します。詳細については、「RAM ユーザーの作成」および「AccessKey ペアを作成する」トピックの「RAM ユーザーの AccessKey ペアを作成する」セクションをご参照ください。

2. RAM ユーザーに必要な権限を付与します。この例では、AliyunDMSFullAccess ポリシーが RAM ユーザーにアタッチされています。このポリシーは、データディザスタリカバリを管理するための権限を付与します。詳細については、「RAM ユーザーに権限を付与する」をご参照ください。

3. ID 資格情報を構成するために使用するリージョンの ID を取得します。Alibaba Cloud CLI は、指定したリージョン ID を使用して API 操作を開始します。データディザスタリカバリ でサポートされているリージョンの詳細については、「エンドポイント」をご参照ください。

   説明

   Alibaba Cloud CLI を使用する場合、--region オプションを使用して特定のリージョンでコマンドを実行できます。このオプションを使用すると、Alibaba Cloud CLI はデフォルトの資格情報構成および環境変数設定のリージョン情報を無視します。詳細については、「API 呼び出しのコマンドラインオプション」をご参照ください。

4. RAM ユーザーの AccessKey ペアを使用して、AkProfile という名前の構成ファイルに AccessKey 認証情報を構成します。詳細については、「認証情報を構成する」トピックの「構成例」セクションをご参照ください。

例 1：API 操作をクエリする

次のコードは、--help オプションを使用して、Alibaba Cloud CLI で呼び出すことができるバージョン 2019-03-06 の データディザスタリカバリ API 操作をクエリする方法の例を示しています。

1. 次のコマンドを実行します。

   aliyun dbs --help

2. コマンド出力を表示します。

   

例 2: バックアップスケジュールの課金情報を照会する

次の例は、Alibaba Cloud CLI を使用して データディザスタリカバリ の DescribeBackupPlanBilling 操作を呼び出し、バックアップスケジュールの課金情報をクエリする方法を示しています。詳細については、「DescribeBackupPlanBilling」をご参照ください。

1. 次のコマンドを実行します。

   aliyun dbs DescribeBackupPlanBilling --BackupPlanId 'dbstooi01ex****' --ShowStorageType true

2. コマンド出力を表示します。

   {
     "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 トラブルシューティング ページで、返されたリクエスト ID または SDK エラー情報に基づいてセルフサービス診断を実行することもできます。