如何通过云控制API实现资源管理 - 云控制API

本文演示了如何通过OpenAPI门户在线调用云控制API以实现资源管理。以专有网络VPC为例，具体展示了创建专有网络资源、查询、更新和删除资源的操作流程。此外，还将介绍在云控制API中采用异步操作处理任务时，如何查询任务状态。

前提条件

为确保顺利操作，请完成以下前置准备：

由于阿里云账号（主账号）具有资源的所有权限，一旦发生泄露将面临重大风险。建议您使用RAM用户。具体操作方式，请参见创建RAM用户。
在调用云控制API之前，请首先为RAM用户授予相应资源的操作权限，并授予AliyunCloudControlAPIFullAccess权限，以确保具备管理云控制API的所有权限。有关具体操作方式，请参见为RAM用户授权。

本文教程以专有网络VPC为示例，其中专有网络VPC的产品code为VPC，资源类型code也为VPC。通过产品code和资源类型code，您可以查询资源类型的详细信息。通过在线调用云控制API，您可以实现对专有网络VPC的创建、获取、更新、列举和删除操作。

此接口的目的是创建一个专有网络VPC资源。

使用RAM用户登录OpenAPI门户，进入专有网络资源创建界面后，选择regionId，填写body资源属性的参数值，点击发起调用。右侧示例代码您可选择语言，系统会自动生成代码以供您参考。
发起调用后，查看调用结果。
若调用报错，请参考去诊断中的日志信息、API文档或公共错误码进行问题分析和解决，也可联系我们。
若调用成功，记录返回信息中的资源ID（resourceId），状态码是200表示为同步操作，即资源创建任务完成；状态码是202表示为异步操作，需要根据返回的taskId进一步查询任务的状态。
说明
同步操作与异步操作是程序处理任务执行的两种模式，区别在于，同步操作在任务执行完成后才返回，而异步操作则不等待任务执行完成就返回。
示例中调用结果返回的状态码是202，为异步操作，您需要通过taskId查询任务状态。记录taskId，点击查询任务，跳转到查询任务界面。
输入taskId，点击发起调用。查看调用结果，调用成功，任务status为Succeeded，VPC资源创建完成。
结果验证：在专有网络管理控制台中查看创建的VPC。

此接口的目的是获取一个专有网络VPC资源详细信息。进入专有网络资源获取界面后，输入资源ID，选择regionId，点击发起调用。查看调用结果，显示调用成功并返回了资源详细信息。

资源查询.png

此接口的目的是更新专有网络VPC资源信息。进入专有网络资源更新界面后，输入资源ID，选择regionId，输入需要更新的参数值，点击发起调用。查看调用结果，验证更新结果可通过专有网络管理控制台或云控制API查看资源信息。

资源更新.png

此接口的目的是列举所有专有网络VPC资源信息。进入专有网络资源列举界面后，选择regionId，点击发起调用。查看调用结果，可以看到资源信息。

资源列举.png

此接口目的是用于删除指定的专有网络VPC资源。

重要

删除操作为不可逆操作，务必谨慎处理。在执行删除VPC操作之前，建议首先在测试环境中对删除流程进行全面验证，确保无误后再进行生产资源的操作。

进入专有网络资源删除界面后，输入资源ID，选择regionId，点击发起调用，查看调用结果。
显示调用成功，返回码202，说明本次调用为异步操作。
进入查询任务界面后，输入taskId，点击发起调用。查看调用结果，任务status为Succeeded，即VPC资源已删除完成。

这个仓库提供了云控制API的代码示例，它将帮助您查询资源元数据和管理云资源。