集成概览

OpenAPI介绍

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

版本说明

阿里云OpenAPI通过版本号管控各时期云产品大版本的API。例如：RDS目前支持2014-08-15版本的API，2014-08-15代表的是API版本号而非时间概念，所展示的都是最新的API公开数据，并非自2014-08-15之后就未更新。

在线调试

RDS在OpenAPI门户提供API调试等功能。在调用前，您需要了解RDS提供的版本、接入点说明、集成方式等信息。

调试入口

调试API入口为：调试入口

接入点说明

根据实例所在的地域，选择对应的服务接入点地址，以获得最低延迟。例如华北3（张家口），公网接入地址为rds.cn-zhangjiakou.aliyuncs.com，VPC接入地址为rds-vpc.cn-zhangjiakou.aliyuncs.com。

• 公网接入地址全球都可访问。

• VPC（Virtual Private Cloud）隔离了虚拟网络，每个VPC对应一个虚拟化网络。VPC地址的优势：

  • 高安全性：VPC接入地址只能在VPC内部访问，提供更高的安全性和隐私性。

  • 更快的响应速度：由于VPC接入地址在VPC内部网络中运行，其响应速度通常比公网接入地址更快，并且可以避免公网延迟和带宽限制等问题。

  • 更低的成本：VPC接入地址可以使用内部网络通信。

更多信息请参见服务接入点。

支持的用户身份

您阿里云账号登录OpenAPI网站后，默认使用您的阿里云账号进行在线OpenAPI调试。阿里云账号拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。请根据业务的实际情况按需分配权限后进行接口调用。RAM用户需具备操作RDS资源的权限。具体操作，请参见RAM授权访问RDS实例。

更多信息

• 身份、凭据与授权

• 流量控制与配额管理

集成方式

RDS提供阿里云SDK、Terraform、资源编排和自定义封装这几种集成方式，您可以根据业务的实际需要进行选择。

• 阿里云 SDK

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

  • 支持通过阿里云SDK调用RDS的OpenAPI。支持语言及依赖安装方法请参见云数据库RDS SDK。

• 阿里云CLI

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

  • 支持通过阿里云CLI调用RDS的OpenAPI。使用方法请参见生成命令。

• Terraform

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

  • 支持通过Terraform调用RDS的OpenAPI。支持的资源和数据清单请参见Terraform支持的RDS资源。

• 资源编排ROS

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

  • 支持通过资源编排ROS调用RDS的OpenAPI。支持的资源和数据清单请参见ROS支持的RDS资源。

• 自定义封装API调用

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

注意事项

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

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