L'interface CLI Alibaba Cloud est un outil en ligne de commande polyvalent développé à partir des API. Utilisez-le pour gérer vos instances RDS depuis votre shell plutôt que via la console.
Prérequis
Avant de commencer, assurez-vous de disposer des éléments suivants :
Un compte Alibaba Cloud avec accès à ApsaraDB RDS
-
Un utilisateur RAM auquel est attachée la stratégie AliyunRDSReadOnlyAccess ou AliyunRDSFullAccess
Une paire AccessKey (ID AccessKey et secret AccessKey) pour cet utilisateur RAM
L'ID de la région où réside votre instance RDS — consultez la page Endpoints
L'utilisation des identifiants du compte racine pour appeler des opérations API présente des risques de sécurité. Créez un utilisateur RAM dédié pour l'accès aux API. Consultez les rubriques Créer un utilisateur RAM et Accorder des autorisations à un utilisateur RAM .
Installer l'interface CLI Alibaba Cloud
Installez l'interface CLI Alibaba Cloud pour votre système d'exploitation :
Vous pouvez également utiliser Cloud Shell pour exécuter des commandes de l'interface CLI Alibaba Cloud directement dans votre navigateur, sans installation locale. Consultez la rubrique Qu'est-ce que Cloud Shell ?
Configurer l'interface CLI Alibaba Cloud
L'interface CLI Alibaba Cloud prend en charge plusieurs types d'identifiants. Pour la plupart des cas d'utilisation, commencez par les identifiants AccessKey.
| Type d'identifiant | Cas d'utilisation | Instructions |
|---|---|---|
| AccessKey (long terme) | Comptes de service et scripts d'automatisation | Étapes ci-dessous |
| Autres types d'identifiants | Accès temporaire ou fédéré | Types d'identifiants |
Pour configurer les identifiants AccessKey :
Créez une paire AccessKey pour votre utilisateur RAM et notez l'ID AccessKey ainsi que le secret AccessKey. Consultez la rubrique Créer une paire AccessKey pour un utilisateur RAM.
Utilisez la paire AccessKey pour configurer les identifiants dans le profil de configuration
AkProfile. Pour plus d'informations, consultez l'exemple de configuration.(Facultatif) Pour exécuter une commande dans une région spécifique sans modifier votre profil par défaut, ajoutez l'option
--region <region-id>à n'importe quelle commande. Cette option remplace la région définie dans le profil par défaut et dans les variables d'environnement. Consultez la rubrique Options de ligne de commande.
Générer une commande CLI
Utilisez OpenAPI Explorer pour créer des commandes CLI de manière interactive :
Accédez à la page Débogage de l'API ApsaraDB RDS.
Dans la zone de recherche de gauche, recherchez l'opération API que vous souhaitez appeler.
Sous l'onglet Parameters, saisissez les valeurs des paramètres.
-
Cliquez sur l'onglet CLI Example pour afficher la commande générée avec vos paramètres préremplis. Depuis l'onglet CLI Example :
Cliquez sur
pour copier la commande dans le presse-papiers.Cliquez sur
pour ouvrir Cloud Shell et exécuter la commande dans votre navigateur.
OpenAPI Explorer ajoute par défaut l'option --region aux commandes générées. Lorsqu'elle est présente, cette option remplace les paramètres de votre profil par défaut et de vos variables d'environnement. Supprimez-la ou conservez-la selon votre flux de travail. Pour connaître les exigences de formatage des paramètres, consultez la rubrique Formats de paramètres .
Appeler les opérations API ApsaraDB RDS
Syntaxe des commandes
Toutes les commandes de l'interface CLI Alibaba Cloud suivent cette structure. Consultez la rubrique Structure des commandes pour plus de détails.
aliyun <command> <subcommand> [options and parameters]Options de commande courantes
| Option | Description |
|---|---|
--profile <profileName> |
Utilise le profil de configuration spécifié. Remplace la configuration d'identifiants par défaut et les variables d'environnement. |
--region <regionId> |
Exécute la commande dans la région spécifiée. Remplace la configuration d'identifiants par défaut et les variables d'environnement. |
--help |
Affiche l'aide relative à une commande. Consultez la rubrique Utiliser la commande d'aide. |
Pour obtenir la liste complète des options disponibles, consultez la rubrique Options de ligne de commande.
Exemple 2 : Interroger les détails d'une instance
La commande suivante appelle l'opération DescribeDBInstanceAttribute pour récupérer la configuration complète d'une instance RDS :
aliyun rds DescribeDBInstanceAttribute --region cn-hangzhou --DBInstanceId 'pgm-bp16k272p478****'| Paramètre | Description | Exemple |
|---|---|---|
--region |
Région où réside l'instance | cn-hangzhou |
--DBInstanceId |
ID de l'instance RDS à interroger | pgm-bp16k272p478**** |
Sortie :
{
"Items": {
"DBInstanceAttribute": [
{
"AccountMaxQuantity": 99999,
"AccountType": "Mix",
"AdvancedFeatures": "LinkedServer,DistributeTransaction",
"AutoUpgradeMinorVersion": "Auto",
"AvailabilityValue": "100.0%",
"BabelfishConfig": {},
"CanTempUpgrade": false,
"Category": "HighAvailability",
"ColdDataEnabled": false,
"ConnectionMode": "Standard",
"ConnectionString": "pgm-bp16k272p478****.pg.rds.aliyuncs.com",
"ConsoleVersion": "2",
"CreationTime": "2024-08-06T06:18:48Z",
"CurrentKernelVersion": "rds_postgres_1400_20240530",
"DBClusterNodes": {
"DBClusterNode": []
},
"DBInstanceCPU": "2",
"DBInstanceClass": "pg.n4.2c.2m",
"DBInstanceClassType": "x",
"DBInstanceDescription": "DB-test",
"DBInstanceDiskUsed": 3520069632,
"DBInstanceId": "pgm-bp16k272p478****",
"DBInstanceMemory": 8192,
"DBInstanceNetType": "Intranet",
"DBInstanceStatus": "Running",
"DBInstanceStorage": 100,
"DBInstanceStorageType": "cloud_essd",
"DBInstanceType": "Primary",
"DBMaxQuantity": 99999,
"DedicatedHostGroupId": "",
"DeletionProtection": false,
"DispenseMode": "MultiAVZDispenseMode",
"Engine": "PostgreSQL",
"EngineVersion": "14.0",
"ExpireTime": "",
"Extra": {
"DBInstanceIds": {
"DBInstanceId": []
}
},
"IPType": "IPv4",
"InsId": 1,
"InstanceNetworkType": "VPC",
"InstructionSetArch": "x86",
"IoAccelerationEnabled": "0",
"LatestKernelVersion": "rds_postgres_1400_20240530",
"LockMode": "Unlock",
"MaintainTime": "18:00Z-22:00Z",
"MasterZone": "cn-hangzhou-j",
"MaxConnections": 800,
"MaxIOMBPS": 0,
"MaxIOPS": 6800,
"OriginConfiguration": "{\"KindCode\":\"18\"}",
"PayType": "Postpaid",
"Port": "5432",
"ProxyType": 2,
"ReadOnlyDBInstanceIds": {
"ReadOnlyDBInstanceId": []
},
"RegionId": "cn-hangzhou",
"ResourceGroupId": "rg-acfmz7u4zzrngoa",
"SecurityIPList": "0.0.0.0/0,172.16.0.0/12",
"SecurityIPMode": "normal",
"ServerlessConfig": {},
"SlaveZones": {
"SlaveZone": [
{
"ZoneId": "cn-hangzhou-k"
}
]
},
"SuperPermissionMode": "",
"SupportCreateSuperAccount": "Yes",
"SupportUpgradeAccountType": "Yes",
"Tips": "ok",
"TipsLevel": 1,
"VSwitchId": "vsw-bp1sxxsodv28ey5dl****",
"VpcCloudInstanceId": "pgm-bp16k272p478****-20240806141842",
"VpcId": "vpc-bp1ov7as4yvz4kxei****",
"ZoneId": "cn-hangzhou-j",
"kindCode": "18"
}
]
},
"RequestId": "14B99E32-4ECD-5B8E-A9C8-6738C8C95910"
}Dépannage
Si un appel API renvoie une erreur, vérifiez que les noms et les valeurs des paramètres correspondent à la référence API de cette opération.
Pour effectuer un diagnostic autonome, accédez à la Plateforme de diagnostic des API Alibaba Cloud et saisissez le RequestId figurant dans la réponse d'erreur.
Étapes suivantes
Qu'est-ce que l'interface CLI Alibaba Cloud ? — présentation complète des fonctionnalités
Formats de paramètres — comment transmettre des types de paramètres complexes (tableaux JSON, structures)
Options de ligne de commande — tous les indicateurs pris en charge et leurs règles de priorité