集成概览

OpenAPI介绍

为了能够让开发者快速高效的学习和使用云产品OpenAPI，阿里云为用户提供OpenAPI网站。它是一款集OpenAPI智能搜索、文档、在线调试、SDK获取、CodeSample、调用出错诊断、调用统计为一体的产品。您可以在OpenAPI门户中调用阿里云各云产品开放的OpenAPI，查看OpenAPI请求和返回结果。此外，OpenAPI门户会自动生成相应的SDK调用示例，帮助您快速使用阿里云产品。更多信息，请参见什么是OpenAPI。

集成方式

• 阿里云 SDK

  • 阿里云为开发者提供了多种编程语言（Java、C#、Go、Python、Node.js/TypeScript、PHP、C++ 等）的SDK。开发者只需要集成SDK，通过SDK暴露的方法直接调用OpenAPI 。SDK统一封装了签名逻辑、超时机制、重试机制，并根据文档返回结构化Response对象，易于开发。更多关于阿里云SDK的介绍，请参见阿里云SDK。

  • 支持在OpenAPI通过阿里云SDK调用云备份。支持语言及依赖安装方法请参见云备份服务SDK。

• 阿里云CLI

  • 阿里云命令行工具可以帮您在使用命令行终端时，使用aliyun命令与阿里云服务进行交互，管理云服务资源。有关阿里云CLI的更多详细信息，请参见什么是阿里云CLI。

  • 暂不支持使用阿里云CLI调用云备份。

• Terraform

  • Terraform 是一种开源工具，用于安全高效地预览，配置和管理云基础架构和资源。它与阿里云的资源编排服务的运行机制类似，通过将模板转化为内部数据后完成 OpenAPI 调用。更多详情，请参见什么是 Terraform。

  • 支持Terraform编排和使用云备份，支持部分普通资源和数据资源清单，请参见云备份Terraform资源和数据源。

  • 快速使用Terraform编排云备份，请参见Terraform集成示例。

• 资源编排ROS

  • 资源编排服务ROS（Resource Orchestration Service）是阿里云提供的一项简化云计算资源管理的服务。开发者和管理员可以编写模板，在模板中定义所需的阿里云资源（例如：ECS 实例、OSS、NAS）、资源间的依赖关系等。ROS 的编排引擎将根据模板自动完成所有资源的创建和配置，实现自动化部署及运维。更多详情，请参见什么是资源编排服务。

  • 支持使用资源编排服务ROS调用云备份。编排的部分资源包括普通资源（备份客户端、恢复任务、备份计划、备份仓库等）和数据资源（例如备份库）。

    • 普通资源：

      • ALIYUN::HBR::BackupClients：为ECS实例安装备份客户端

      • ALIYUN::HBR::RestoreJob：创建恢复任务

      • ALIYUN::HBR::DbAgent安装数据库备份客户端

      • ALIYUN::HBR::DbPlan：创建备份计划

      • ALIYUN::HBR::DbVault：创建镜像备份仓库

      • ALIYUN::HBR::Vault：创建一个备份仓库

    • 数据资源：

      • DATASOURCE::HBR::Vaults：查询备份仓库基础信息

  • 快速使用资源编排ROS编排云备份，请参见资源编排ROS集成示例。

• 自定义封装API调用

  原生HTTP调用需要您自己实现签名算法，并构建自定义请求，发起HTTP调用。有关签名机制的更多详细信息，请参见云备份API参考指南和V3版本请求体&签名机制。

注意事项

如果调用云备份API后返回错误，您需要根据返回的错误码提示检查传入的请求参数及其取值是否正确。更多信息，请参见公共错误码。

您也可以记录下调用返回的RequestID或SDK报错信息，通过阿里云OpenAPI诊断平台进行自助诊断。

常见问题

• 如果您想了解云备份产品，请参见什么是云备份。

• 云备份可以为阿里云ECS整机、ECS数据库（MySQL/SQL Server/Oracle）、文件系统、NAS、OSS以及自建机房内的文件、数据库、虚拟机、大规模NAS等提供备份、容灾保护的混合云产品。了解更多产品支持的特性，请参见云备份支持的功能特性清单。

• 除了Java SDK，还支持C#、Go、Python、Node.js/TypeScript、PHP、C++等，更多信息，请参见SDK参考。