文档

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

更新时间:

本文以专有网络资源为例,演示如何通过OpenAPI门户调用云控制API的方式,管理专有网络VPC资源的全生命周期。

前提条件

您需要登录OpenAPI门户,建议使用RAM用户,RAM用户需要以下权限:

1.管理云控制API的权限,请参见为RAM用户授权

2.管理专有网络VPC服务的权限,请参见使用RAM对VPC进行权限管理

操作步骤

在线调用云控制API,实现专有网络VPC的创建、获取、更新、列举和删除操作。若需集成云控制API,请参考在线调试API门户生成的示例代码。

1.创建专有网络资源

  1. 使用RAM用户登录OpenAPI门户,进入专有网络资源创建界面后,选择regionId,填写body资源属性的参数值,点击发起调用。右侧示例代码您可选择语言,系统会自动生成代码以供您参考。

    创建vpc.png

  2. 发起调用后,查看调用结果。

    若调用报错,请参考去诊断中的日志信息、API文档或公共错误码进行问题分析和解决,也可联系我们

    若调用成功,记录返回信息中的资源ID(resourceId),状态码是200表示为同步操作,即资源创建任务完成;状态码是202表示为异步操作,需要根据返回的taskId进一步查询任务的状态。

    说明

    同步操作与异步操作是程序处理任务执行的两种模式,区别在于,同步操作在任务执行完成后才返回,而异步操作则不等待任务执行完成就返回。

    创建vpc返回.png

  3. 示例中调用结果返回的状态码是202,为异步操作,您需要通过taskId查询任务状态。记录taskId,点击查询任务,跳转到查询任务界面。

    点击查询任务.png

  4. 输入taskId,点击发起调用。查看调用结果,调用成功,任务status为Succeeded,VPC资源创建完成。

    任务查询.png

  5. 阿里云控制台中查看创建的VPC。

    控制台查看.png

2.获取专有网络资源

进入专有网络资源获取界面后,输入资源ID,选择regionId,点击发起调用。查看调用结果,显示调用成功并返回了资源信息。

资源查询.png

3.更新专有网络资源

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

资源更新.png

4.列举专有网络资源

进入专有网络资源列举界面后,选择regionId,点击发起调用。查看调用结果,可以看到资源信息。

资源列举.png

5.删除专有网络资源

  1. 进入专有网络资源删除界面后,输入资源ID,选择regionId,点击发起调用,查看调用结果。

    资源删除.png

  2. 显示调用成功,返回码202,说明本次调用为异步操作。

    进入查询任务界面后,输入taskId,点击发起调用。查看调用结果,任务status为Succeeded,即VPC资源已删除完成。

    删除任务查询.png

示例代码

代码地址:https://github.com/aliyun/cloud-control-api-demo

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