Manage resources by using Cloud Control API - Cloud Control API - Centro de documentación de Alibaba Cloud

Esta guía muestra cómo usar OpenAPI Explorer para gestionar recursos en la nube mediante Cloud Control API. Se toma Virtual Private Cloud (VPC) como ejemplo para aprender a completar el ciclo de vida de un recurso: crearlo, obtenerlo, actualizarlo, listar sus instancias y eliminarlo.

Requisitos previos

Usuario de RAM: por motivos de seguridad, se recomienda utilizar un usuario de Resource Access Management (RAM) en lugar de su cuenta de Alibaba Cloud. Para más información, consulte Create a RAM user.
Permisos obligatorios: asigne las siguientes políticas a su usuario de RAM:
- La política del sistema AliyunCloudControlAPIFullAccess, que otorga acceso a Cloud Control API.
- Una política específica del servicio, como AliyunVPCFullAccess, para los recursos que desea gestionar. Para más información, consulte Manage RAM user permissions.

Comprender las operaciones de la API

Cloud Control API utiliza operaciones estandarizadas para gestionar recursos. Este tutorial abarca las operaciones principales para una VPC, cuyo código de producto es VPC y su tipo de recurso es VPC:

CreateResource: crea un recurso nuevo.
GetResource: obtiene los detalles de un recurso específico.
UpdateResource: modifica un recurso existente.
ListResources: lista todos los recursos de un tipo específico en una región.
DeleteResource: elimina un recurso.

Operaciones síncronas y asíncronas

Cloud Control API responde de dos maneras:

Síncrona (Status 200): la operación finaliza de inmediato y el cuerpo de la respuesta contiene el resultado.
Asíncrona (Status 202): la operación se acepta y se ejecuta en segundo plano. La respuesta devuelve un taskId. Debe usar este identificador para llamar a la operación GetTask y comprobar el estado final de la tarea.

Procedimiento

Paso 1: Crear una VPC

Inicie sesión en OpenAPI Explorer con su usuario de RAM. Luego, vaya a la página CreateResource correspondiente a las VPC. En la sección de parámetros, especifique el valor de regionId y defina las propiedades del recurso en body. Por último, haga clic en Initiate Call.
Revise la respuesta en la pestaña Response.

Si la llamada falla, haga clic en Diagnose o utilice common error codes para solucionar el problema. También puede contact us para solicitar asistencia.

Una llamada exitosa devuelve el código de estado 200 (operación síncrona) o 202 (operación asíncrona). Copie los valores de taskId y resourceId del cuerpo de la respuesta; los necesitará en los pasos siguientes.
En este ejemplo, el código de estado es 202, lo cual indica una operación asíncrona. Anote el valor de taskId y haga clic en Query task para ir a la página de consulta de tareas.

Paso 2: Comprobar el estado de la tarea de creación

Vaya a la página GetTask. Pegue el valor de taskId obtenido en el paso anterior en el campo taskId y haga clic en Initiate Call. Compruebe que el status de la tarea sea Succeeded.
También puede verificar la creación desde la consola de VPC.

Paso 3: Obtener los detalles de la VPC

Vaya a la página GetResource. Introduzca el valor de resourceId que copió en el paso 1 y el regionId correcto. Haga clic en Initiate Call para obtener los detalles de la nueva VPC.

资源查询.png

Paso 4: Actualizar la VPC

Vaya a la página UpdateResource. Proporcione los valores de resourceId y regionId. En body, especifique las propiedades que desea modificar (por ejemplo, la Description). Haga clic en Initiate Call y compruebe la actualización en la consola de VPC.

资源更新.png

Paso 5: Listar las VPC

Vaya a la página GetResources. Seleccione un valor de regionId y haga clic en Initiate Call. La respuesta incluirá la VPC que creó dentro de la lista de recursos.

资源列举.png

Paso 6: Eliminar la VPC

Para limpiar el recurso, vaya a la página DeleteResource. Introduzca los valores de resourceId y regionId de la VPC que creó, y haga clic en Initiate Call.
La llamada exitosa devuelve el código de estado 202 y un nuevo taskId.

Utilice nuevamente la operación GetTask para comprobar el estado de esta tarea de eliminación. El estado Succeeded confirma que la VPC se eliminó correctamente.

Código de ejemplo

Explore los ejemplos de código oficiales en GitHub para conocer más sobre el uso programático de Cloud Control API: Repositorio de demostración de Cloud Control API.