View a markdown version of this page

启用 Amazon RDS 数据 API - Amazon Aurora
在创建数据库时启用 RDS 数据 API在现有数据库上启用或禁用 RDS 数据 API

启用 Amazon RDS 数据 API

要使用 Amazon RDS 数据 API（数据 API），请为 Aurora 数据库集群启用它。您可以在创建或修改数据库集群时启用数据 API。

注意

数据 API 是否适用于您的集群取决于您的 Aurora 版本、数据库引擎和 AWS 区域。对于 Aurora，数据 API 适用于同时使用预调配实例和 Aurora Serverless v2 实例的集群。要检查您的集群是否可以使用数据 API，请参阅支持 RDS 数据 API 的区域和 Aurora 数据库引擎。

在创建数据库时启用 RDS 数据 API

在创建支持 RDS 数据 API（数据 API）的数据库时，您可以启用此功能。以下过程描述了在使用 AWS 管理控制台、AWS CLI 或 RDS API 时如何执行此操作。

要在创建数据库集群时启用数据 API，请在创建数据库页面的连接部分中选中启用 RDS 数据 API 复选框，如以下屏幕截图所示。

“创建数据库”页面上的“连接”部分，“启用 RDS 数据 API”复选框处于选中状态。

有关如何创建可使用 RDS 数据 API 的 Aurora 数据库集群的说明，请参阅以下内容：

要在创建 Aurora 数据库集群时启用数据 API，请运行带 --enable-http-endpoint 选项的 create-db-cluster AWS CLI 命令。

以下示例创建一个启用了数据 API 的 Aurora PostgreSQL 数据库集群。

对于 Linux、macOS 或 Unix：

aws rds create-db-cluster \
	    --db-cluster-identifier my_pg_cluster \
	    --engine aurora-postgresql \
	    --enable-http-endpoint

对于：Windows

aws rds create-db-cluster ^
	    --db-cluster-identifier my_pg_cluster ^
	    --engine aurora-postgresql ^
	    --enable-http-endpoint

要在创建 Aurora 数据库集群时启用数据 API，请使用 CreateDBCluster 操作，并将 EnableHttpEndpoint 参数的值设置为 true。

在现有数据库上启用或禁用 RDS 数据 API

您可以修改支持 RDS 数据 API（数据 API）的数据库集群以启用或禁用此功能。

启用或禁用数据 API（Aurora Serverless v2 和预调配）

使用以下过程可在 Aurora Serverless v2 和预调配数据库上启用或禁用数据 API。

您可以使用 RDS 控制台为支持此功能的数据库集群启用或禁用数据 API。为此，请打开要为其启用或禁用数据 API 的数据库的集群详细信息页面，然后从操作下拉菜单中选择启用 RDS 数据 API 或禁用 RDS 数据 API。这可让您为集群启用或禁用 RDS 数据 API。

以下屏幕截图显示 RDS 数据 API 未启用。

数据库集群详细信息页面的“连接和安全”选项卡上的“RDS 数据 API”部分。数据 API 的状态显示为已禁用，并显示“启用 RDS 数据 API”按钮。

要在现有数据库上启用或禁用数据 API，请运行 enable-http-endpoint 或 disable-http-endpoint AWS CLI 命令，然后指定数据库集群的 ARN。

以下示例启用数据 API。

对于 Linux、macOS 或 Unix：

aws rds enable-http-endpoint \
	    --resource-arn cluster_arn

对于：Windows

aws rds enable-http-endpoint ^
	    --resource-arn cluster_arn

要在现有数据库上启用或禁用数据 API，请使用 EnableHttpEndpoint 和 DisableHttpEndpoint 操作。