Alibaba Cloud CLI を使用した DBS OpenAPI の呼び出し - Data Management

Alibaba Cloud CLI を使用すると、コマンドラインからデータディザスタリカバリの管理とメンテナンスを自動化できます。このチュートリアルを完了すると、次のことができるようになります。

RAM ユーザーの認証情報で Alibaba Cloud CLI をインストールおよび設定する
利用可能なデータディザスタリカバリの API オペレーションを確認する
API オペレーションを呼び出し、レスポンスを解釈する

このチュートリアルでは、DescribeBackupPlanBilling を実例として使用します。

前提条件

開始する前に、以下が揃っていることを確認してください。

Alibaba Cloud アカウント
AliyunDBSFullAccess ポリシーがアタッチされた 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 は認証情報も自動的に設定するため、ステップ 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 ペアを作成します。
AliyunDBSFullAccess ポリシーを RAM ユーザーにアタッチします。詳細については、「RAM ユーザーへの権限付与」をご参照ください。
使用するリージョンのリージョン ID を確認します。Alibaba Cloud CLI は、指定したリージョンに API リクエストを送信します。データディザスタリカバリがサポートするリージョンについては、「エンドポイント」をご参照ください。
AkProfile 設定ファイルで AccessKey 認証情報を設定します。ステップバイステップの例については、「認証情報の設定」の「設定例」セクションをご参照ください。

Alibaba Cloud CLI は複数の認証情報タイプをサポートしています。完全なリストについては、「認証情報の設定」の「認証情報タイプ」セクションをご参照ください。

説明

--region オプションを使用すると、任意のコマンドで特定のリージョンを指定できます。これは、認証情報の設定や環境変数で設定されたリージョンを上書きします。詳細については、「API呼び出しのコマンドラインオプション」をご参照ください。

ステップ 3: CLI コマンドの生成

OpenAPI Explorer は、データディザスタリカバリのすべての API オペレーションに対して、すぐに使用できる CLI コマンドを生成します。

OpenAPI Explorer でDescribeBackupPlanBilling のページを開きます。
[Parameters] タブで、リクエストパラメーターを入力します。
[CLI Example] タブをクリックして、生成されたコマンドを表示します。
コマンドをコピーまたは実行します。
- をクリックすると、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 オペレーションの強制呼び出し」をご参照ください。