Alibaba Cloud CLI es una herramienta de línea de comandos de propósito general basada en OpenAPI Explorer. Esta herramienta le permite automatizar la gestión y el mantenimiento de los recursos de ENS, incluida la invocación de operaciones de la API de ENS.
Antes de empezar
Familiarícese con Alibaba Cloud CLI. Para obtener más información, consulte What is Alibaba Cloud CLI?.
Instalación de Alibaba Cloud CLI
Alibaba Cloud CLI está disponible para Windows, Linux y macOS. Seleccione el paquete de instalación correspondiente a su sistema operativo:
También puede utilizar Cloud Shell para depurar comandos de Alibaba Cloud CLI. Para obtener más información, consulte What is Cloud Shell?.
Configuración de Alibaba Cloud CLI
Una cuenta de Alibaba Cloud tiene permisos para gestionar y acceder a las API de todos los servicios de Alibaba Cloud. Si utiliza una cuenta de Alibaba Cloud para invocar operaciones de la API, pueden surgir riesgos de seguridad. Se recomienda crear y utilizar un usuario de Resource Access Management (RAM) para invocar operaciones de la API o realizar tareas habituales de operación y mantenimiento.
Antes de usar Alibaba Cloud CLI, configure sus credenciales de identidad y el ID de región. Alibaba Cloud CLI admite diversos tipos de credenciales. Para obtener más información, consulte Credential types. Este ejemplo utiliza credenciales de AccessKey.
-
Cree un usuario de RAM y otórguele los permisos necesarios. Para obtener más información, consulte Create a RAM user y Grant permissions to a RAM user.
ImportantePara este ejemplo, debe otorgar la directiva
AliyunENSFullAccessal usuario de RAM. Esta directiva concede control total para consultar y modificar instancias de ENS. También puede otorgar la directivaAliyunENSReadOnlyAccesso una directiva personalizada según sea necesario. Para obtener más información, consulte Reference for custom policies of ENS. Después de crear y autorizar al usuario de RAM, genere un par de AccessKey para dicho usuario. Registre el
AccessKey IDy elAccessKey Secretpara la configuración de credenciales. Para obtener más información, consulte Create an AccessKey pair.-
Obtenga y registre el ID de una región disponible. Alibaba Cloud CLI utiliza el ID de región especificado para iniciar las llamadas a la API. Para obtener más información sobre las regiones disponibles, consulte Endpoints.
NotaCuando utilice Alibaba Cloud CLI, puede usar la opción
--regionpara especificar una región para un solo comando. Esta opción anula la configuración de región definida en sus credenciales predeterminadas y en las variables de entorno. Para obtener más información, consulte Command options. Utilice el par de AccessKey del usuario de RAM para configurar credenciales basadas en AccessKey. Asigne al perfil de configuración el nombre
AkProfile. Para obtener más información, consulte Configure and manage identity credentials.
Generación de un comando de CLI
Inicie sesión en la página de depuración de API para ENS.
-
En la página de depuración de API, utilice el cuadro de búsqueda izquierdo para encontrar la API que desea usar. En la sección Parameter Configuration, complete los parámetros obligatorios. A continuación, haga clic en la pestaña CLI Example junto a la sección Parameter Configuration para generar un ejemplo de comando.
Haga clic en el icono
. Será redirigido a Cloud Shell, donde podrá depurar el comando.-
Haga clic en el icono
para copiar el comando de CLI al portapapeles y péguelo en su shell local.Al pegar el comando de ejemplo en su shell para depurarlo, preste atención a los formatos de los parámetros. Para obtener más información sobre los formatos de parámetros de Alibaba Cloud CLI, consulte Parameter formats.
El ejemplo generado por OpenAPI Explorer incluye la opción
--regionde forma predeterminada. Cuando ejecute el comando localmente, Alibaba Cloud CLI dará prioridad a esta opción e ignorará la configuración de región de sus credenciales predeterminadas y variables de entorno. Puede eliminar o conservar esta opción según sus necesidades.
Invocación de una operación de API
Sintaxis
Alibaba Cloud CLI utiliza la siguiente sintaxis de comandos. Para obtener más información, consulte Syntax.
aliyun <command> <subcommand> [options and parameters]
Opciones de comando
Puede especificar opciones de comando para modificar su comportamiento o habilitar funciones extendidas. Las opciones comunes incluyen:
--profile <profileName>: Cuando utiliza la opción--profiley especifica un nombre de configuración válidoprofileName, Alibaba Cloud CLI ignora la configuración de credenciales de identidad predeterminada y las variables de entorno, y prioriza la configuración especificada para ejecutar el comando.--help: En cualquier nivel de comando, utilice la opción--helppara obtener ayuda sobre dicho comando. Para obtener más información, consulte Get help information.
Para obtener más información, consulte Command line options for API calls.
Ejemplo de invocación
El siguiente ejemplo invoca el comando RebootInstance en ENS para reiniciar una instancia. Para obtener más información sobre el comando RebootInstance, consulte RebootInstance.
-
Ejecute el siguiente comando:
aliyun ens RebootInstance --InstanceId i-5xxx8d3x --endpoint ens.aliyuncs.com -
Consulte la salida del comando.
{ "Code": "0", "RequestId": "845748BB-9E66-52DB-B4F5-4305601AD2CF" }
Si se devuelve un error tras invocar una operación de la API de ENS, compruebe si los parámetros de entrada y sus valores son válidos basándose en el código de error.
También puede registrar el ID de solicitud de la respuesta o del mensaje de error del SDK y utilizar Alibaba Cloud OpenAPI Diagnostics para diagnosticar el problema.