Use Alibaba Cloud CLI to call the OOS API - CloudOps Orchestration Service

Alibaba Cloud CLI es una herramienta de línea de comandos de uso general desarrollada con base en OpenAPI Explorer. Con esta herramienta se automatizan las tareas de gestión y mantenimiento en CloudOps Orchestration Service. Este tema describe cómo usar Alibaba Cloud CLI para llamar a la API de CloudOps Orchestration Service mediante diversos ejemplos.

Antes de comenzar

Para obtener más información sobre Alibaba Cloud CLI, consulte What is Alibaba Cloud CLI

Instalación de Alibaba Cloud CLI

Debe instalar Alibaba Cloud CLI antes de usarlo. La instalación se realiza en los sistemas operativos Windows, Linux y macOS. Elija el paquete de instalación de Alibaba Cloud CLI según el sistema operativo de su dispositivo. Para obtener más información, consulte los siguientes temas:

Sistema operativo Windows: Install Alibaba Cloud CLI on Windows
Sistema operativo Linux: Install, update, and uninstall Alibaba Cloud CLI
Sistema operativo macOS: Install Alibaba Cloud CLI on macOS

También puede usar Cloud Shell, proporcionado por Alibaba Cloud, para depurar los comandos que desea ejecutar en Alibaba Cloud CLI. Para obtener más información sobre Cloud Shell, consulte What is Cloud Shell

Configuración de Alibaba Cloud CLI

Importante

Una cuenta de Alibaba Cloud tiene permisos para gestionar y acceder a las API de todos los servicios de Alibaba Cloud. Si usa una cuenta de Alibaba Cloud para llamar a las operaciones de la API, pueden surgir riesgos de seguridad. Se recomienda crear un usuario de Resource Access Management (RAM) y utilizarlo para llamar a las operaciones de la API o ejecutar las tareas habituales de operación y mantenimiento.

Antes de usar Alibaba Cloud CLI, configure la información correspondiente, como las credenciales de identidad y el identificador de región. Alibaba Cloud CLI es compatible con diversos tipos de credenciales de identidad. Para obtener más información, consulte la sección «Tipos de credenciales de identidad» del tema Configure identity credentials. En este ejemplo se usan credenciales de AccessKey. Siga estos pasos:

Cree un usuario de RAM y otórguele los permisos necesarios para gestionar los servicios de Alibaba Cloud según sus requisitos de negocio. Para obtener más información, consulte Create a RAM user y Use RAM for access control.
Cree un par de AccessKey para el usuario de RAM. Anote el valor de AccessKey ID y de AccessKey secret para configurar las credenciales de identidad más adelante. Para obtener más información, consulte Create an AccessKey.
Especifique un identificador de región. Alibaba Cloud CLI llama a las operaciones de la API en la región indicada. Para conocer las regiones disponibles, consulte Endpoints.

Nota
Cuando use Alibaba Cloud CLI, especifique la opción --region para ejecutar un comando en una región específica. Si indica esta opción, Alibaba Cloud CLI omite la información de región de la configuración de credenciales predeterminada y de las variables de entorno. Para obtener más información, consulte Command-line options.
Use el par de AccessKey del usuario de RAM para configurar las credenciales de AccessKey en el archivo de configuración denominado AkProfile. Para obtener más información, consulte la sección «Ejemplos de configuración» del tema Configure identity credentials.

Generación de un comando de CLI

Vaya a la página Depuración de API de OOS.
En el cuadro de búsqueda del lado izquierdo de la página de depuración de la API, busque la operación a la que desea llamar. En la pestaña Parameters de dicha operación, especifique los parámetros según la referencia de la API. Haga clic en la pestaña CLI Example, ubicada a la derecha, para consultar el comando de ejemplo generado con los parámetros indicados.
- Haga clic en el icono para iniciar Cloud Shell y depurar el comando en Cloud Shell.
- Haga clic en el icono para copiar el comando de ejemplo al portapapeles. Después, péguelo en su shell local para ejecutarlo.
  - Preste atención al formato de los parámetros cuando pegue el comando de ejemplo en su shell local para depurarlo. Para obtener más información sobre el formato de los parámetros en los comandos de Alibaba Cloud CLI, consulte Understand command parameters.
  - De forma predeterminada, la opción --region se añade al comando de ejemplo generado en OpenAPI Explorer. Al copiar el comando en su shell local, Alibaba Cloud CLI omite la información de región de la configuración de credenciales predeterminada y de las variables de entorno. En su lugar, ejecuta el comando de manera prioritaria en la región especificada. Elimine o conserve esta opción según sus necesidades de negocio.

Llamada a operaciones de la API

Sintaxis

En Alibaba Cloud CLI, utilice la siguiente sintaxis para ejecutar comandos. Para obtener más información, consulte la sección «Sintaxis» del tema Generate and run CLI commands.

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

Opciones de comando comunes

Cuando use Alibaba Cloud CLI, especifique opciones de comando para modificar su comportamiento o habilitar funciones adicionales. A continuación se describen las opciones más comunes:

--profile <profileName>: use la opción --profile junto con el parámetro profileName para indicar un perfil de configuración. Cuando especifica un perfil válido, Alibaba Cloud CLI omite la información de la configuración de credenciales predeterminada y de las variables de entorno. De este modo, utiliza de manera prioritaria la configuración indicada para ejecutar los comandos.
--help: use la opción --help para obtener la información de ayuda de un comando. Para obtener más información, consulte Use the help command.

Para obtener más información, consulte Command-line options.

Código de ejemplo

Ejemplo 1: el siguiente código muestra cómo usar la opción --help para obtener la lista de operaciones de la API de CloudOps Orchestration Service compatibles con Alibaba Cloud CLI. También puede consultar las operaciones disponibles en API overview.

Ejecute el siguiente comando:
```
aliyun oos --help
```
Consulte el resultado.

Ejemplo 2: el siguiente código muestra cómo usar Alibaba Cloud CLI para llamar a la operación CreateTemplate de OOS y crear una plantilla llamada CLI_Template.

Ejecute el siguiente comando:

Nota

El formato de entrada de los parámetros de tipo lista de matrices JSON varía según el sistema operativo. Elija y ejecute el comando correspondiente a su sistema. Para obtener más información, consulte Understand command parameters.

Linux/macOS

aliyun oos CreateTemplate --RegionId 'cn-hangzhou' --TemplateName CLI_Template --Content '{"FormatVersion": "OOS-2019-06-01", "Description": "Describe instances of given status", "Parameters": {"Status": {"Type": "String", "Description": "(Required) The status of the Ecs instance."}}, "Tasks": [{"Properties": {"Parameters": {"Status": "{{ Status }}"}, "API": "DescribeInstances", "Service": "Ecs"}, "Name": "foo", "Action": "ACS::ExecuteApi"}]}'

Windows

aliyun oos CreateTemplate --RegionId 'cn-hangzhou' --TemplateName CLI_Template --Content "{'FormatVersion': 'OOS-2019-06-01', 'Description': 'Describe instances of given status', 'Parameters': {'Status': {'Type': 'String', 'Description': '(Required) The status of the Ecs instance.'}}, 'Tasks': [{'Properties': {'Parameters': {'Status': '{{ Status }}'}, 'API': 'DescribeInstances', 'Service': 'Ecs'}, 'Name': 'foo', 'Action': 'ACS::ExecuteApi'}]}"

Consulte el resultado.

{
  "RequestId": "989F0944-E653-5826-9FA7-8ADE6E66F485",
  "Template": {
    "Description": "Describe instances of given status",
    "CreatedBy": "test(2039927162697*****)",
    "TemplateFormat": "JSON",
    "ResourceGroupId": "rg-acfmykd6*****",
    "UpdatedDate": "2024-08-05T10:28:24Z",
    "TemplateVersion": "v1",
    "Hash": "8abc5921b5a05051992*****",
    "UpdatedBy": "test(2039927162697*****)",
    "HasTrigger": false,
    "CreatedDate": "2024-08-05T10:28:24Z",
    "TemplateName": "CLI_Template",
    "Tags": {},
    "TemplateId": "t-9246d5246f*****",
    "ShareType": "Private"
  }
}

Nota

Si se devuelve un error después de llamar a una operación de la API de CloudOps Orchestration Service, compruebe si los parámetros de entrada y sus valores son válidos con base en el código de error.

También puede usar Diagnóstico de OpenAPI de Alibaba Cloud para ejecutar diagnósticos de autoservicio a partir del identificador de solicitud o de la información de error devuelta.