Exemplos de integração com CLI - ApsaraDB for HBase: Central de Documentação do Alibaba Cloud

O Alibaba Cloud CLI é uma ferramenta unificada de linha de comando baseada no OpenAPI Explorer. Use-a para gerenciar e manter o ApsaraDB for HBase diretamente pela linha de comando. Este tópico demonstra como chamar operações da API do ApsaraDB for HBase com o Alibaba Cloud CLI.

Pré-requisitos

Antes de começar, familiarize-se com o Alibaba Cloud CLI. Para mais informações, consulte O que é o Alibaba Cloud CLI?.

Instale o Alibaba Cloud CLI

Instale o Alibaba Cloud CLI no seu sistema operacional. Há instaladores disponíveis para Windows, Linux e macOS.

Windows: Instalar o Alibaba Cloud CLI no Windows.
Linux: Instalar, atualizar e desinstalar o Alibaba Cloud CLI.
macOS: Instalar o Alibaba Cloud CLI no macOS.

Alternativamente, use o Cloud Shell para depurar comandos do Alibaba Cloud CLI sem instalação local. Para mais informações, consulte O que é o Cloud Shell?.

Configure o Alibaba Cloud CLI

Importante

Uma conta Alibaba Cloud tem permissões totais sobre todas as operações de API, o que representa alto risco de segurança. Recomendamos usar um usuário RAM para chamadas de API e tarefas rotineiras de O&M.

Antes de usar o Alibaba Cloud CLI, configure suas credenciais de identidade e uma região padrão. O Alibaba Cloud CLI oferece suporte a vários tipos de credenciais. Para mais informações, consulte Configurar e gerenciar credenciais de identidade. Este exemplo utiliza um par de AccessKey.

Crie um usuário RAM e conceda as permissões necessárias. Para mais informações, consulte Criar um usuário RAM e Gerenciar permissões de usuário RAM.

Importante
Para este exemplo, anexe a política AliyunHBaseReadOnlyAccess ao usuário RAM. Também é possível usar a política AliyunHBaseFullAccess para obter permissões completas de consulta e modificação ou criar uma política personalizada. Para mais informações, consulte Criar políticas de autorização RAM personalizadas.
Crie um par de AccessKey para o usuário RAM e anote o AccessKey ID e o AccessKey Secret. Para mais informações, consulte Criar um par de AccessKey.
Obtenha um ID de região. O Alibaba Cloud CLI envia solicitações de API para a região especificada. Para ver a lista de regiões suportadas, consulte Estrutura da solicitação.

Nota
Adicione a opção --region a um comando para substituir a região definida no arquivo de configuração e nas variáveis de ambiente. Para mais informações, consulte Opções de linha de comando.
Configure um perfil com o par de AccessKey do usuário RAM. Este exemplo usa o nome de perfil AkProfile. Para mais informações, consulte Configurar e gerenciar credenciais de identidade.

Gerar um exemplo de comando CLI

Acesse a página de Depuração de API do ApsaraDB for HBase no OpenAPI Explorer.
Na página de depuração de API, pesquise a API desejada na caixa de pesquisa à esquerda. Em Parameter Configuration, especifique os parâmetros necessários e clique em na aba CLI Example para gerar um comando CLI com seus parâmetros.
- Clique em no ícone para abrir o Cloud Shell e depurar o comando.
- Clique em no ícone para copiar o exemplo de CLI para a área de transferência. Em seguida, cole-o no terminal local e execute-o.
  - Ao executar o exemplo de CLI no shell local, verifique o formato dos parâmetros. Para mais informações, consulte Formatos de parâmetros.
  - O OpenAPI Explorer adiciona a opção --region por padrão, substituindo a região configurada no perfil e nas variáveis de ambiente. Remova ou mantenha essa opção conforme necessário.

Chamar operações de API

Estrutura do comando

Os comandos do Alibaba Cloud CLI seguem a sintaxe abaixo. Para mais informações, consulte Gerar e executar comandos CLI.

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

Opções comuns de comando

Use opções de linha de comando para alterar o comportamento padrão ou adicionar funcionalidades. As opções mais comuns incluem:

--profile <profileName>: Executa o comando com o perfil especificado, substituindo o perfil padrão e as variáveis de ambiente.
--help: Exibe informações de ajuda para o comando. Para mais detalhes, consulte Obter informações de ajuda.

Para mais informações, consulte Opções de linha de comando.

Exemplo

O exemplo a seguir chama a operação DescribeInstance para consultar uma instância específica do ApsaraDB for HBase. Para mais informações, consulte DescribeInstance.

Execute o comando.

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

Resposta de exemplo:

{
        "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"
}