Manage resources by using Cloud Control API - Cloud Control API: Central de Documentação do Alibaba Cloud

Este guia demonstra como utilizar o OpenAPI Explorer para gerenciar recursos de cloud por meio da Cloud Control API. Com o Virtual Private Cloud (VPC) como exemplo, você aprenderá a executar o ciclo completo de operações em um recurso: criar, consultar, atualizar, listar e excluir.

Pré-requisitos

Usuário RAM: Por questões de segurança, recomendamos o uso de um usuário do Resource Access Management (RAM) em vez da sua conta Alibaba Cloud. Para mais informações, consulte Create a RAM user.
Permissões necessárias: Anexe as seguintes políticas ao seu usuário RAM:
- A política de sistema AliyunCloudControlAPIFullAccess para conceder acesso à Cloud Control API.
- Uma política específica do service, como AliyunVPCFullAccess, para os recursos que você pretende gerenciar. Para mais informações, consulte Manage RAM user permissions.

Entenda as operações da API

A Cloud Control API utiliza operações padronizadas para gerenciar recursos. Este tutorial aborda as seguintes operações principais para uma VPC, que possui o código de product VPC e tipo de recurso VPC:

CreateResource: Crie um novo recurso.
GetResource: Obtém os detalhes de um recurso específico.
UpdateResource: Atualize um recurso existente.
ListResources: Lista todos os recursos de um tipo específico em uma região.
DeleteResource: Exclua um recurso.

Operações síncronas e assíncronas

A Cloud Control API pode responder de duas formas:

Síncrona (Status 200): A operação é concluída imediatamente e o corpo da resposta contém o resultado.
Assíncrona (Status 202): A operação foi aceita e será executada em segundo plano. A resposta retorna um taskId, que deve ser usado para chamar a operação GetTask e verificar o status final da tarefa.

Procedimento

Etapa 1: Criar uma VPC

Faça login no OpenAPI Explorer com seu usuário RAM e acesse a página CreateResource para VPCs. Na seção de parâmetros, especifique o regionId e defina as propriedades do recurso no body. Em seguida, clique em Initiate Call.
Analise a resposta na aba Response.

Se a chamada falhar, clique em Diagnose ou utilize o common error codes para solucionar o problema. Você também pode contact us para obter suporte.

Uma chamada bem-sucedida retorna um código de status 200 (operação síncrona) ou 202 (operação assíncrona). No corpo da resposta, copie o taskId e o resourceId para as próximas etapas.
Neste exemplo, o código de status é 202, indicando uma operação assíncrona. Registre o taskId e clique em Query task para acessar a página de consulta de tarefas.

Etapa 2: Verificar o status da tarefa de criação

Acesse a página GetTask. Cole o taskId da etapa anterior no campo taskId e clique em Initiate Call. Verifique se o status da tarefa é Succeeded.
Também é possível confirmar a criação acessando o console VPC.

Etapa 3: Obter detalhes da VPC

Acesse a página GetResource. Insira o resourceId copiado na Etapa 1 e o regionId correto. Clique em Initiate Call para recuperar os detalhes da sua nova VPC.

资源查询.png

Etapa 4: Atualizar a VPC

Acesse a página UpdateResource. Forneça o resourceId e o regionId. No body, especifique as propriedades que deseja alterar (por exemplo, a Description). Clique em Initiate Call e verifique a atualização no console VPC.

资源更新.png

Etapa 5: Listar VPCs

Acesse a página GetResources. Selecione um regionId e clique em Initiate Call. A resposta incluirá a VPC criada na lista de recursos.

资源列举.png

Etapa 6: Excluir a VPC

Para limpar o recurso, acesse a página DeleteResource. Insira o resourceId e o regionId da VPC criada e clique em Initiate Call.
A chamada bem-sucedida retorna um código de status 202 e um novo taskId.

Utilize novamente a operação GetTask para verificar o status desta tarefa de exclusão. Um status Succeeded confirma que a VPC foi excluída.

Código de exemplo

Explore os exemplos oficiais de código no GitHub para saber mais sobre como usar a Cloud Control API programaticamente: Repositório de Demonstração da Cloud Control API.