ApsaraDB for HBaseとAlibaba Cloud CLIの統合 - ApsaraDB for HBase - Alibaba Cloud ドキュメントセンター

Alibaba Cloud CLIは、OpenAPI に基づいて開発された汎用コマンドラインツールです。 Alibaba Cloud CLIを使用して、ApsaraDB for Hbase の管理とメンテナンスを自動化できます。このトピックでは、Alibaba Cloud CLIを使用して ApsaraDB for Hbase APIオペレーションを呼び出す方法について説明します。

始める前に

Alibaba Cloud CLIの詳細については、「Alibaba Cloud CLIとは」をご参照ください。

Alibaba Cloud CLIのインストール

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

Alibaba Cloudによって提供される Cloud Shell を使用して、Alibaba Cloud CLIで実行するコマンドをデバッグすることもできます。 Cloud Shellの詳細については、「Cloud Shellとは」をご参照ください。

Alibaba Cloud CLIの構成

重要

Alibaba Cloudアカウントには、すべてのAlibaba CloudサービスのAPIオペレーションを管理およびアクセスするための権限があります。 Alibaba Cloudアカウントを使用してAPIオペレーションを呼び出すと、セキュリティリスクが発生する可能性があります。 RAMユーザーを使用してAPIオペレーションを呼び出したり、日常のO&Mを実行することをお勧めします。

Alibaba Cloud CLIを使用する前に、Alibaba Cloud CLIでIDクレデンシャルやリージョンIDなどの情報を構成する必要があります。 Alibaba Cloud CLIはさまざまなIDクレデンシャルをサポートしています。詳細については、「プロファイルの構成」トピックのクレデンシャルの種類セクションをご参照ください。この例では、AccessKeyクレデンシャルが使用されます。 AccessKeyクレデンシャルを使用するには、次の手順を実行します。

RAMユーザーを作成し、RAMユーザーに必要な権限を付与します。詳細については、「RAM ユーザーの作成」および「RAMユーザーへの権限の付与」をご参照ください。
重要
この例では、AliyunHBaseReadOnlyAccess ポリシーをRAMユーザーにアタッチします。 AliyunHBaseFullAccess ポリシーを選択して、ApsaraDB for HBaseインスタンスのクエリと変更を行うための完全な権限をRAMユーザーに付与するか、ビジネス要件に基づいてカスタムポリシーを選択することもできます。詳細については、「RAMポリシーのカスタマイズ」をご参照ください。
RAMユーザーのAccessKeyペアを作成し、後続のIDクレデンシャルの構成のために AccessKey ID と AccessKeyシークレット を記録します。詳細については、「AccessKeyの作成」をご参照ください。
後続のIDクレデンシャルの構成のために、使用可能なリージョンのIDを取得して記録します。 Alibaba Cloud CLIは、指定されたリージョンIDを使用してAPI呼び出しを開始します。使用可能なリージョンの詳細については、「リクエスト構造」をご参照ください。
説明
Alibaba Cloud CLIを使用する場合、--region オプションを指定して、特定のリージョンでコマンドを実行できます。このオプションを指定すると、Alibaba Cloud CLIはデフォルトのクレデンシャル構成および環境変数設定のリージョン情報を無視します。詳細については、「API呼び出しのコマンドラインオプション」をご参照ください。
RAMユーザーのAccessKeyペアを使用して、AkProfile という名前の構成ファイルでIDクレデンシャルを構成します。詳細については、「プロファイルの構成」トピックの構成例セクションをご参照ください。

CLIコマンドの生成

ApsaraDB for HBaseの APIデバッグページに移動します。
APIデバッグページの左側の検索ボックスで、呼び出すAPIオペレーションを検索します。 [パラメーター] タブで、APIオペレーションのAPIドキュメントに基づいてパラメーター値を入力します。次に、[パラメーター] タブの右側にある [CLIの例] タブをクリックして、構成されたパラメーターを含む例を生成します。
- アイコンをクリックして Cloud Shell を起動し、Cloud Shellでコマンドをデバッグします。
- アイコンをクリックして、サンプルコマンドをクリップボードにコピーします。次に、サンプルコマンドをローカルシェルに貼り付けて、サンプルコマンドを実行します。
  - CLIコマンドをローカルシェルにコピーして貼り付けるときは、パラメーターの形式に注意してください。 Alibaba Cloud CLIのパラメーター形式の詳細については、「パラメーター形式」をご参照ください。
  - デフォルトでは、OpenAPI Explorerは生成されたCLIコマンドに --region オプションを追加します。コマンドをローカルシェルにコピーすると、Alibaba Cloud CLIはデフォルトのクレデンシャル構成および環境変数設定のリージョン情報を無視し、優先的に指定されたリージョンでコマンドを実行します。ビジネス要件に基づいて、オプションを削除または保持できます。

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

構文

Alibaba Cloud CLIでは、次の構文を使用してコマンドを実行できます。詳細については、「CLIコマンドの生成と実行」トピックのCLIコマンドの生成と実行セクションをご参照ください。

aliyun <command> <subcommand> [options and parameters]

コマンドオプション

Alibaba Cloud CLIを使用する場合、コマンドオプションを指定して、コマンドのデフォルトの動作を変更したり、コマンドの拡張機能を実装したりできます。以下のコマンドオプションがよく使用されます。

--profile <profileName>: --profile オプションと profileName パラメーターを使用して、構成プロファイルを指定できます。有効な構成プロファイルを指定すると、Alibaba Cloud CLIはデフォルトのクレデンシャル構成および環境変数設定の情報を無視し、優先的に指定した構成を使用してコマンドを実行します。
--help: --help オプションを指定して、コマンドのヘルプ情報を取得できます。詳細については、「helpコマンドの使用」をご参照ください。

詳細については、「API呼び出しのコマンドラインオプション」をご参照ください。

例

次の例では、Alibaba Cloud CLIを使用してApsaraDB for HBaseの DescribeInstance オペレーションを呼び出し、ApsaraDB for HBaseインスタンスに関する情報をクエリする方法について説明します。 DescribeInstance の詳細については、「DescribeInstance」をご参照ください。

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

aliyun hbase DescribeInstance --region cn-hangzhou --ClusterId 'ld-bp142678b0894****'

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

{
        "BackupStatus": "open",
        "ClusterId": "ld-bp142678b0894****",
        "ClusterName": "hbaseue_test",
        "ClusterType": "cluster",
        "ColdStorageSize": 0,
        "ColdStorageStatus": "open",
        "ConfirmMaintainTime": false,
        "CoreDiskCount": 4,
        "CoreDiskSize": 100,
        "CoreDiskType": "cloud_ssd",
        "CoreInstanceType": "hbase.sn2.2xlarge",
        "CoreNodeCount": 4,
        "CreatedTime": "2024-08-06T11:20:36",
        "CreatedTimeUTC": "2024-08-06T03:20:36Z",
        "EnableHbaseProxy": false,
        "EncryptionType": "NoEncryption",
        "Engine": "hbaseue",
        "InstanceId": "ld-bp142678b0894****",
        "InstanceName": "hbaseue_test",
        "IsDeletionProtection": false,
        "IsHa": true,
        "IsLatestVersion": false,
        "IsMultiModel": true,
        "MaintainEndTime": "06:00:00",
        "MaintainStartTime": "02:00:00",
        "MajorVersion": "2.0",
        "MasterDiskSize": 0,
        "MasterDiskType": "",
        "MasterInstanceType": "hbase.sn1.large",
        "MasterNodeCount": 2,
        "ModuleId": 0,
        "ModuleStackVersion": "2.0",
        "NeedUpgrade": false,
        "NeedUpgradeComps": {
                "Comps": []
        },
        "NetworkType": "VPC",
        "PayType": "Postpaid",
        "RegionId": "cn-hangzhou",
        "RequestId": "FBEE6642-D79E-5***-****-C4AF1******",
        "ResourceGroupId": "rg-acfmz7u4zzr****",
        "Status": "ACTIVATION",
        "Tags": {
                "Tag": []
        },
        "TaskProgress": "0",
        "TaskStatus": "running",
        "VpcId": "vpc-bp1ov7as4yvz4kxei****",
        "VswitchId": "vsw-bp1wh6lp1abs3fi0h****",
        "ZoneId": "cn-hangzhou-b"
}