CLI整合樣本 - ApsaraDB for HBase

阿里雲CLI（Alibaba Cloud Command Line Interface）是基於OpenAPI構建的通用命令列工具，您可以通過阿里雲CLI實現自動化管理和維護ApsaraDB for Hbase。本文將為您介紹使用阿里雲CLI調用ApsaraDB for Hbase的操作步驟和樣本。

前置概念

閱讀本文前，若您還不瞭解阿里雲CLI，請參見什麼是阿里雲CLI。

安裝阿里雲CLI

使用阿里雲CLI前，您需要先安裝阿里雲CLI。阿里雲CLI為使用者提供了Windows、Linux和macOS三種作業系統下的安裝服務，請根據您使用裝置的作業系統選擇對應的安裝服務。

您也可使用阿里雲提供的雲命令列Cloud Shell調試阿里雲CLI命令。關於雲命令列的更多資訊，請參閱什麼是雲命令列。

配置阿里雲CLI

重要

阿里雲帳號（主帳號）擁有所有產品API的管理和存取權限，風險很高。強烈建議您建立並使用RAM使用者進行API訪問或日常營運。

使用阿里雲CLI之前，您需要在阿里雲CLI中配置身份憑證、地區ID等資訊。阿里雲CLI支援多種身份憑證，詳情請參見身份憑證類型。本文操作以AK類型憑證為例，具體操作步驟如下：

您需要建立一個RAM使用者並授予相應操作許可權。具體操作，請參見建立RAM使用者及為RAM使用者授權。
重要
本樣本需要您為RAM使用者授予AliyunHBaseReadOnlyAccess權限原則。您也可以按需選擇AliyunHBaseFullAccess許可權（具有查詢、修改HBase執行個體的完全控制許可權）或進行自訂策略，更多資訊請參見自訂RAM授權策略。
建立RAM使用者並授權後，您需要建立RAM使用者對應的AccessKey，並記錄AccessKey ID和AccessKey Secret，以便後續配置身份憑證使用。具體操作，請參見建立AccessKey。
您需要擷取並記錄可用的地區ID，以便後續配置身份憑證使用。阿里雲CLI將使用您指定的地區發起API調用，可用地區請參見請求結構。
說明
使用阿里雲CLI過程中您可使用--region選項指定地區發起命令調用，該選項在使用時將忽略預設身份憑證配置及環境變數設定中的地區資訊。詳情請參見API命令可用選項。
使用RAM使用者的AccessKey配置AK類型憑證，設定檔命名為AkProfile。具體操作，請參見配置樣本。

產生CLI命令樣本

登入HBase API調試列表。
在API調試介面左側搜尋方塊中可搜尋您需要使用的API。在參數配置中根據API文檔資訊填寫參數，單擊參數配置右側的CLI樣本頁簽即可產生攜帶參數的命令樣本。
- 單擊按鈕，可喚出雲命令列Cloud Shell並在其中快速完成命令調試。
- 單擊按鈕，將CLI樣本複製到剪貼簿中，可粘貼至本地Shell工具中運行。
  - 複製CLI樣本到本地Shell工具中進行調試時請注意參數格式。關於阿里雲CLI命令參數使用格式的詳細資料，請參見參數格式說明。
  - OpenAPI門戶產生樣本中會預設添加--region選項，複製命令到本地調用時阿里雲CLI將忽略預設身份憑證配置及環境變數設定中的地區資訊，優先使用指定的地區調用命令，您可根據需要對該選項進行刪除或保留。

調用API

命令結構

阿里雲CLI的通用命令列結構如下。更多詳情，請參見命令結構。

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

常用命令選項

在阿里雲CLI中，您可根據需要使用命令列選項，用來修改命令的預設行為或為命令提供額外功能。常用命令列選項如下：

--profile <profileName>：使用--profile選項並指定有效配置名稱profileName後，阿里雲CLI將忽略預設身份憑證配置及環境變數設定，優先使用指定的配置進行命令調用。
--help：在需要擷取協助的命令層級處鍵入--help選項，即可擷取該命令的協助資訊。更多詳情，請參見擷取協助資訊。

更多詳細資料，請參見API命令可用選項。

調用樣本

以下樣本將為您展示如何使用阿里雲CLI調用HBase中的DescribeInstance命令，查詢指定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"
}