# 启用 Amazon RDS 数据 API
<a name="data-api.enabling"></a>

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

**注意**  
 数据 API 是否适用于您的集群取决于您的 Aurora 版本、数据库引擎和 AWS 区域。对于较早的 Aurora 版本，数据 API 仅适用于 Aurora Serverless v1 集群。对于较新的 Aurora 版本，数据 API 适用于同时使用预调配和 Aurora Serverless v2 实例的集群。要检查您的集群是否可以使用数据 API，请参阅[支持 RDS 数据 API 的区域和 Aurora 数据库引擎](Concepts.Aurora_Fea_Regions_DB-eng.Feature.Data_API.md)。

**Topics**
+ [在创建数据库时启用 RDS 数据 API](#data-api.enabling.creating)
+ [在现有数据库上启用 RDS 数据 API](#data-api.enabling.modifying)

## 在创建数据库时启用 RDS 数据 API
<a name="data-api.enabling.creating"></a>

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

### 控制台
<a name="data-api.enabling.creating.console"></a>

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

![\[“创建数据库”页面上的“连接”部分，“启用 RDS 数据 API”复选框处于选中状态。\]](http://docs.aws.amazon.com/zh_cn/AmazonRDS/latest/AuroraUserGuide/images/data-api-enable-on-create.png)


有关如何创建可使用 RDS 数据 API 的 Aurora 数据库集群的说明，请参阅以下内容：
+ 对于 Aurora Serverless v2 和预调配集群：[创建 Amazon Aurora 数据库集群](Aurora.CreateInstance.md)
+ 对于 Aurora Serverless v1 – [创建 Aurora Serverless v1 数据库集群](aurora-serverless.create.md)

### AWS CLI
<a name="data-api.enabling.creating.cli"></a>

要在创建 Aurora 数据库集群时启用数据 API，请运行带 `--enable-http-endpoint` 选项的 [create-db-cluster](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-cluster.html) 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
```

### RDS API
<a name="data-api.enabling.creating.api"></a>

要在创建 Aurora 数据库集群时启用数据 API，请使用 [CreateDBCluster](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html) 操作，并将 `EnableHttpEndpoint` 参数的值设置为 `true`。

## 在现有数据库上启用 RDS 数据 API
<a name="data-api.enabling.modifying"></a>

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

**Topics**
+ [启用或禁用数据 API（Aurora Serverless v2 和预调配）](#data-api.enabling.modifying.all)
+ [启用或禁用数据 API（仅限 Aurora Serverless v1）](#data-api.enabling.modifying.sv1)

### 启用或禁用数据 API（Aurora Serverless v2 和预调配）
<a name="data-api.enabling.modifying.all"></a>

使用以下过程可在 Aurora Serverless v2 和预调配数据库上启用或禁用数据 API。要在 Aurora Serverless v1 数据库上启用或禁用数据 API，请使用[启用或禁用数据 API（仅限 Aurora Serverless v1）](#data-api.enabling.modifying.sv1)中的过程。

#### 控制台
<a name="data-api.enabling.modifying.all.console"></a>

您可以使用 RDS 控制台为支持此功能的数据库集群启用或禁用数据 API。为此，请打开要启用或禁用数据 API 的数据库的集群详细信息页面上，然后在**连接和安全**选项卡上，转到 **RDS 数据 API** 部分。此部分显示数据 API 的状态，并允许您启用或禁用它。

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

![\[数据库集群详细信息页面的“连接和安全”选项卡上的“RDS 数据 API”部分。数据 API 的状态显示为已禁用，并显示“启用 RDS 数据 API”按钮。\]](http://docs.aws.amazon.com/zh_cn/AmazonRDS/latest/AuroraUserGuide/images/data-api-enable-from-details.png)


#### AWS CLI
<a name="data-api.enabling.modifying.all.cli"></a>

要在现有数据库上启用或禁用数据 API，请运行 [enable-http-endpoint](https://docs.aws.amazon.com/cli/latest/reference/rds/enable-http-endpoint.html) 或 [disable-http-endpoint](https://docs.aws.amazon.com/cli/latest/reference/rds/disable-http-endpoint.html) 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
```

#### RDS API
<a name="data-api.enabling.modifying.all.api"></a>

要在现有数据库上启用或禁用数据 API，请使用 [EnableHttpEndpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_EnableHttpEndpoint.html) 和 [DisableHttpEndpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DisableHttpEndpoint.html) 操作。

### 启用或禁用数据 API（仅限 Aurora Serverless v1）
<a name="data-api.enabling.modifying.sv1"></a>

使用以下步骤在现有 Aurora Serverless v1 数据库上启用或禁用数据 API。要在 Aurora Serverless v2 和预调配数据库上启用或禁用数据 API，请使用[启用或禁用数据 API（Aurora Serverless v2 和预调配）](#data-api.enabling.modifying.all)中的过程。

#### 控制台
<a name="data-api.enabling.modifying.sv1.console"></a>

在修改 Aurora Serverless v1 数据库集群时，您可以在 RDS 控制台的**连接**部分中启用数据 API。

以下屏幕截图显示了在修改 Aurora 数据库集群时启用的**数据 API**。

![\[“修改数据库集群”页面上的“连接”部分，“数据 API”复选框处于选中状态。\]](http://docs.aws.amazon.com/zh_cn/AmazonRDS/latest/AuroraUserGuide/images/data-api-modify-serverlessv1.png)


有关如何修改 Aurora Serverless v1 数据库集群的说明，请参阅[修改 Aurora Serverless v1 数据库集群](aurora-serverless.modifying.md)。

#### AWS CLI
<a name="data-api.enabling.modifying.sv1.cli"></a>

要启用或禁用数据 API，请运行 [modify-db-cluster](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-cluster.html) AWS CLI 命令，并使用 `--enable-http-endpoint` 或 `--no-enable-http-endpoint`（如果适用）。

以下示例在 `sample-cluster` 上启用数据 API。

对于 Linux、macOS 或 Unix：

```
aws rds modify-db-cluster \
    --db-cluster-identifier sample-cluster \
    --enable-http-endpoint
```

对于：Windows

```
aws rds modify-db-cluster ^
    --db-cluster-identifier sample-cluster ^
    --enable-http-endpoint
```

#### RDS API
<a name="data-api.enabling.modifying.sv1.api"></a>

要启用数据 API，请使用 [ModifyDBCluster](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBCluster.html) 操作，并将 `EnableHttpEndpoint` 的值设置为 `true` 或 `false`（如果适用）。