Exemples d'intégration de l'interface CLI - ApsaraDB for HBase

Alibaba Cloud CLI est un outil de ligne de commande unifié basé sur OpenAPI Explorer. Vous pouvez l'utiliser pour gérer et maintenir ApsaraDB for HBase directement depuis la ligne de commande. Cette rubrique vous guide dans l'appel des opérations API ApsaraDB for HBase à l'aide d'Alibaba Cloud CLI.

Prérequis

Avant de commencer, familiarisez-vous avec Alibaba Cloud CLI. Pour plus d'informations, consultez la rubrique Présentation d'Alibaba Cloud CLI.

Installation d'Alibaba Cloud CLI

Installez Alibaba Cloud CLI sur votre système d'exploitation. Des programmes d'installation sont disponibles pour Windows, Linux et macOS.

Windows : Installation d'Alibaba Cloud CLI sous Windows.
Linux : Installation, mise à jour et désinstallation d'Alibaba Cloud CLI.
macOS : Installation d'Alibaba Cloud CLI sous macOS.

Vous pouvez également utiliser Cloud Shell pour déboguer les commandes Alibaba Cloud CLI sans installation locale. Pour plus d'informations, consultez la rubrique Présentation de Cloud Shell.

Configuration d'Alibaba Cloud CLI

Important

Un compte Alibaba Cloud dispose de toutes les autorisations sur l'ensemble des opérations API, ce qui représente un risque de sécurité élevé. Nous vous recommandons d'utiliser un utilisateur RAM pour les appels API et les opérations d'exploitation et de maintenance courantes.

Avant d'utiliser Alibaba Cloud CLI, configurez vos identifiants et une région par défaut. Alibaba Cloud CLI prend en charge plusieurs types d'identifiants. Pour plus d'informations, consultez la rubrique Configuration et gestion des identifiants. Cet exemple utilise une paire AccessKey.

Créez un utilisateur RAM et accordez-lui les autorisations requises. Pour plus d'informations, consultez les rubriques Création d'un utilisateur RAM et Gestion des autorisations des utilisateurs RAM.

Important
Pour cet exemple, attachez la stratégie AliyunHBaseReadOnlyAccess à l'utilisateur RAM. Vous pouvez également utiliser la stratégie AliyunHBaseFullAccess pour disposer de toutes les autorisations de requête et de modification, ou créer une stratégie personnalisée. Pour plus d'informations, consultez la rubrique Création de stratégies d'autorisation RAM personnalisées.
Créez une paire AccessKey pour l'utilisateur RAM et notez l'AccessKey ID et l'AccessKey Secret. Pour plus d'informations, consultez la rubrique Création d'une paire AccessKey.
Obtenez un ID de région. Alibaba Cloud CLI envoie les requêtes API vers la région spécifiée. Pour la liste des régions prises en charge, consultez la rubrique Structure de la requête.

Remarque
Vous pouvez ajouter l'option --region à une commande pour remplacer la région définie dans votre fichier de configuration et vos variables d'environnement. Pour plus d'informations, consultez la rubrique Options de ligne de commande.
Configurez un profil avec la paire AccessKey de l'utilisateur RAM. Cet exemple utilise le nom de profil AkProfile. Pour plus d'informations, consultez la rubrique Configuration et gestion des identifiants.

Génération d'un exemple de commande CLI

Accédez à la page Débogage des API pour ApsaraDB for HBase dans OpenAPI Explorer.
Sur la page Débogage des API, recherchez l'API cible dans la zone de recherche de gauche. Dans Parameter Configuration, spécifiez les paramètres requis, puis cliquez sur l'onglet CLI Example pour générer une commande CLI avec vos paramètres.
- Cliquez sur l'icône pour ouvrir Cloud Shell et déboguer la commande.
- Cliquez sur l'icône pour copier l'exemple CLI dans le presse-papiers. Vous pouvez ensuite le coller dans votre terminal local et l'exécuter.
  - Lorsque vous exécutez l'exemple CLI dans votre shell local, vérifiez le format des paramètres. Pour plus d'informations, consultez la rubrique Formats des paramètres.
  - OpenAPI Explorer ajoute l'option --region par défaut, ce qui remplace la région définie dans votre profil et vos variables d'environnement. Supprimez ou conservez cette option selon vos besoins.

Appel des opérations API

Structure de la commande

Les commandes Alibaba Cloud CLI utilisent la syntaxe suivante. Pour plus d'informations, consultez la rubrique Génération et exécution de commandes CLI.

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

Options de commande courantes

Utilisez les options de ligne de commande pour modifier le comportement par défaut ou ajouter des fonctionnalités. Les options courantes incluent :

--profile <profileName> : exécute la commande avec le profil spécifié, en remplaçant le profil par défaut et les variables d'environnement.
--help : affiche les informations d'aide pour la commande. Pour plus d'informations, consultez la rubrique Obtention des informations d'aide.

Pour plus d'informations, consultez la rubrique Options de ligne de commande.

Exemple

L'exemple suivant appelle l'opération DescribeInstance pour interroger une instance ApsaraDB for HBase spécifique. Pour plus d'informations, consultez la rubrique DescribeInstance.

Exécutez la commande.

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

Exemple de réponse :

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