OpenAPI Explorer:Plugin Alibaba Cloud Developer Toolkit para IDE de JetBrains

Requisitos previos

• Tener instalado un IDE de JetBrains, como IntelliJ IDEA, PyCharm o GoLand.

• La versión del IDE debe ser 2022.2 o posterior.

Método 1: Instalación desde el marketplace

1. En la barra de menú superior de IntelliJ IDEA, seleccione > Plugins…, o bien File > > Plugins.

2. En la página Plugins, haga clic en la pestaña Marketplace.

3. Busque Alibaba Cloud Developer Toolkit y haga clic en Install.

4. Haga clic en Apply y luego en OK.

Método 2: Instalación desde un paquete descargado

1. Descargue el paquete del plugin desde JetBrains Marketplace.

2. En la barra de menú superior de IntelliJ IDEA, seleccione > Plugins…, o bien File > > Plugins.

3. En la página Plugins, haga clic en el icono de engranaje , seleccione Install Plugin from Disk... y elija el paquete descargado. No descomprima el paquete.

Comprobación de la instalación

Una vez completada la instalación, el árbol Alibaba Cloud API aparece en la barra lateral izquierda de herramientas de IntelliJ IDEA. Este árbol enumera categorías de servicios como Application Security, Big Data, Application Services, Cloud Communication, Networking, Storage and CDN, Video Services y Artificial Intelligence. El texto Alibaba Cloud: se muestra en el lado derecho de la barra de estado inferior, lo que indica que el plugin Alibaba Cloud Developer Toolkit está listo para usarse.

Método 1

1. En la barra de herramientas superior de IntelliJ IDEA, haga clic en el icono de usuario para abrir el panel Alibaba Cloud Developer Tools. A continuación, seleccione New Profile en la lista desplegable de la parte superior del panel izquierdo para crear un perfil. También puede hacer clic en el icono .

2. Introduzca el Profile Name, RegionId y Access Key ID, and Secret Access Key. Use an existing AccessKey pair or create one. View the AccessKey information of a RAM user. The Secret Access Key is displayed only once — store it securely.

   Importante

   Un AccessKey de cuenta raíz otorga permisos completos sobre todos los recursos y representa un riesgo de seguridad significativo si se ve comprometido. Se recomienda utilizar un AccessKey de usuario RAM en su lugar.

3. Haga clic en Add Configurations.

4. Aparecerá el mensaje Profile added.. Seleccione el nuevo perfil en la lista desplegable del panel izquierdo.

5. Haga clic en el nombre de un perfil para switch the active profile.

Método 2

1. Si Alibaba Cloud CLI está instalado y configurado, el plugin reutiliza su configuración de credenciales. Configure credentials for Alibaba Cloud CLI.

2. Utilice la lista desplegable del panel izquierdo o la barra de estado para cambiar entre perfiles.

3. Haga clic en el nombre de un perfil dentro de la lista desplegable para activarlo.

Búsqueda de servicios y API

El panel izquierdo muestra los servicios en una vista de árbol. Busque por nombre de servicio en inglés o chino y haga clic en un servicio para explorar sus API.

En el panel izquierdo del plugin Alibaba Cloud Developer Toolkit, use el selector Profile para cambiar la configuración de la cuenta. Introduzca una palabra clave de servicio como ecs en el cuadro de búsqueda y seleccione el servicio deseado, por ejemplo Elastic Compute Service (ECS), en el árbol de servicios. Tras seleccionar un servicio, el panel derecho muestra la lista de API correspondiente. Puede buscar API por palabra clave; por ejemplo, al introducir run se obtienen coincidencias como RunInstances y RunCommand. El catálogo completo de API se muestra a continuación, agrupado por categoría de función como Resource Assurance, Block Storage, Images, Security Groups y Cloud Assistant.

Consulta de la referencia de API

Haga clic en una API para consultar su referencia, que incluye descripción, parámetros de solicitud, parámetros de respuesta y códigos de error.

En el panel de navegación de API a la izquierda del plugin Alibaba Cloud Developer Toolkit, busque y seleccione el servicio deseado, como Elastic Compute Service (ECS). La página de la API correspondiente, por ejemplo DescribeRegions, se abre en el panel derecho. Dicha página ofrece tres pestañas: API reference, Sample Code y Debug. En la pestaña API reference puede consultar los parámetros de solicitud de la API, incluidos nombres, tipos y valores válidos. Puede seleccionar un endpoint en la lista desplegable de la parte inferior de la página o hacer clic en Debug en la esquina superior derecha para iniciar la depuración de la API.

Depuración de API

• La depuración de API requiere autenticación.

• Complete los parámetros de la API para ver los resultados en el IDE, o haga clic en Debug para abrir la API en OpenAPI Explorer.

En el cuadro de búsqueda del árbol de navegación izquierdo, introduzca una palabra clave como ecs y seleccione el servicio deseado, por ejemplo Elastic Compute Service (ECS). El panel derecho muestra los detalles de la API seleccionada en tres pestañas: API reference, Sample Code y Debug. Introduzca los parámetros de solicitud en el formulario correspondiente, tales como RegionId, ImageId e InstanceType, seleccione un endpoint y haga clic en Debug en la parte inferior para comenzar la depuración en el IDE. También puede hacer clic en Clear Parameters o Generate Sample para facilitar la operación.

Visualización de código de ejemplo de SDK

El plugin genera código de ejemplo de SDKSDK.

• El plugin genera código de ejemplo basado en sus parámetros. Abra y edite el código directamente en el IDE.

• La importación automática de dependencias solo es compatible con Maven.

• Utilice los botones Installation Method y View Source Code para gestionar dependencias y consultar el código fuente.

Seleccione un lenguaje como Java en el panel del plugin y haga clic en Generate Sample. El plugin genera el código de ejemplo de SDK para RunInstances y lo importa al editor. El código de ejemplo generado es el siguiente:

// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * Initialize the account Client with an AccessKey pair
     * @param accessKeyId
     * @param accessKeySecret
     * @return Client
     * @throws Exception
     */
    public static com.aliyun.ecs20140526.Client createClient() throws xxx {
        // Leaked project code may expose your AccessKey pair and threaten all resources under the account xxx
        // We recommend the more secure STS method. For more authentication methods, see: https://hexxx
        com.aliyun.teaopenapi.models.Config config = new com.aliyuxxx
        // Required. Make sure that the ALIBABA_CLOUD_xxx environment variable is set in the code runtime environment
            .setAccessKeyId(System.getenv("ALIBABA_CLOUDxxx
        // Required. Make sure that the ALIBABA_CLOUD_Axxx environment variable is set in the code runtime environment
            .setAccessKeySecret(System.getenv("ALIBABA_Cxxx
        // For the endpoint, see https://api.alibabacloud.com/product/Ecs
        config.endpoint = "ecs-cn-hangzhou.aliyuncs.com";
        return new com.aliyun.ecs20140526.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_xxx
        com.aliyun.ecs20140526.Client client = Sample.createClientxxx
        com.aliyun.ecs20140526.models.RunInstancesRequest runInstaxxx

Inserción de fragmentos de código

Inserte código de ejemplo de SDK para Java o Java asíncrono con un solo clic. El plugin agrega automáticamente la dependencia Maven a su archivo pom.xml. Active o desactive esta función haciendo clic derecho y seleccionando Alibaba Cloud Developer Toolkit > Disable/Enable Alibaba Cloud SDK auto-completion, o presione ctrl+cmd+p.

public class Test1 {
    public static void main(String[] args) {
        run

Al introducir run en el editor, el plugin muestra una lista de finalización de código con sugerencias de API de Alibaba Cloud, como RunInstances::Ecs::2014-05-26 (crea instancias ECS) y RunCommand::cloudphone::2020-12-30 (ejecuta un comando en un cloud phone).

Busque ecs en el panel de Alibaba Cloud Developer Toolkit, expanda la categoría Elastic Computing y seleccione Elastic Compute Service (ECS). El editor genera automáticamente el siguiente código de SDK. Aparece un cuadro de diálogo en la esquina inferior derecha que pregunta si desea importar automáticamente la dependencia ecs20140526. Haga clic en Yes para importarla.

public class Test1 {
    public static void main(String[] args) {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
            // Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables are set in the code runtime environment
            .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
            .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"))
            // For the endpoint, see https://api.alibabacloud.com/product/Ecs
            .setEndpoint("ecs.cn-qingdao.aliyuncs.com");
        com.aliyun.ecs20140526.Client client = new com.aliyun.ecs20140526.Client(config);
        com.aliyun.ecs20140526.models.RunInstancesRequest runInstancesRequest = new com.aliyun.ecs20140526.models.RunInstancesRequest();
        com.aliyun.ecs20140526.models.RunInstancesResponse runInstancesResponse = client.runInstances(runInstancesRequest);
    }
}

public class Test1 {
    public static void main(String[] args) throws Exception {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
            // Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables are set in the code runtime environment
            .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
            .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"))
            // For the endpoint, see https://api.alibabacloud.com/product/Ecs
            .setEndpoint("ecs.cn-qingdao.aliyuncs.com");
        com.aliyun.ecs20140526.Client client = new com.aliyun.ecs20140526.Client(config);
        com.aliyun.ecs20140526.models.RunInstancesRequest runInstancesRequest = new com.aliyun.ecs20140526.models.RunInstancesRequest();
        com.aliyun.ecs20140526.models.RunInstancesResponse runInstancesResponse = client.runInstances(runInstancesRequest);
    }
}