文档

OpenAPI集成示例(SDK)

更新时间:

使用OpenAPI自动化集成云备份,可以提升您使用云备份的开发效率。本文介绍如何使用OpenAPI调用云备份DescribeBackupPlans接口查询ECS文件备份计划。

步骤一:查看OpenAPI文档

在调用OpenAPI前,建议您先阅读对应接口文档,了解、学习调用该接口所需要的参数及权限等。更多信息,请参见API概览

步骤二:创建RAM用户并完成授权

重要

阿里云账号拥有所有API的访问权限,建议您创建并使用RAM用户进行API访问或日常运维。

本步骤主要用于创建一个具有只读云备份资源权限的RAM用户。

如果您已创建RAM用户且已完成授权,可跳过此步骤。

  1. 使用阿里云账号登录RAM控制台

  2. 创建RAM用户。

    1. 在左侧导航栏,选择身份管理 > 用户

    2. 用户页面,单击创建用户

    3. 创建用户页面,设置登录名称显示名称均为config-openapi-operator-hbr,设置访问方式控制台访问,并设置密码。

    4. 单击确定

      创建RAM用户成功后,请记录用户登录名称和密码,您在调用OpenAPI时,需要使用该RAM用户登录阿里云OpenAPI开发者门户。

  3. 为RAM用户授权。

    说明

    创建RAM用户后,该RAM用户无任何操作云备份的权限。您需要为该RAM用户授予系统策略(AliyunHBRFullAccess、AliyunHBRReadOnlyAccess)或自定义策略。本案例以授予RAM用户AliyunHBRReadOnlyAccess策略为例,AliyunHBRReadOnlyAccess策略具备云备份资源的只读权限。

    1. 用户页面,单击目标RAM用户(config-openapi-operator-hbr)对应的添加权限

    2. 添加权限面板,在系统策略中搜索选中AliyunHBRReadOnlyAccess,然后单击确定

    3. 确认授权结果,单击完成

步骤三:调用OpenAPI

  1. 使用RAM用户登录阿里云OpenAPI门户

  2. 选择云产品为云备份

  3. 在顶部菜单栏,单击API调试

  4. 在左侧导航栏,找到并单击DescribeBackupPlans接口,服务地址选择华东1(杭州)SourceType参数输入ECS_FILE,表示查询ECS类型的备份计划。image.png

  5. 单击发起调用

    调用结果区域,您可以看到查询结果、Request Header、Response Header等信息。至此,调用完成。image.png

常见问题

  • 本页导读 (1)
文档反馈