本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# Neptune 子网 API
<a name="api-subnets"></a>

**操作：**
+ [CreateDBSubnetGroup（操作）](#CreateDBSubnetGroup)
+ [DeleteDBSubnetGroup（操作）](#DeleteDBSubnetGroup)
+ [ModifyDBSubnetGroup（操作）](#ModifyDBSubnetGroup)
+ [DescribeDBSubnetGroups（操作）](#DescribeDBSubnetGroups)

**结构：**
+ [子网（结构）](#Subnet)
+ [DBSubnetGroup（结构）](#DBSubnetGroup)

## CreateDBSubnetGroup（操作）
<a name="CreateDBSubnetGroup"></a>

         此 API 的 AWS CLI 名称为：`create-db-subnet-group`。

创建新的数据库子网组。数据库子网组必须在 Amazon 区域的至少两个可用区中包含至少一个子网。

**请求**
+ **DBSubnetGroupDescription**（在 CLI 中：`--db-subnet-group-description`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  数据库子网组的描述。
+ **DBSubnetGroupName**（在 CLI 中：`--db-subnet-group-name`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  数据库子网组的名称。此值以一个小写字符串存储。

  约束：必须包含不超过 255 个字母、数字、句点、下划线、空格或连字符。不能是默认值。

  示例：`mySubnetgroup`
+ **SubnetIds**（在 CLI 中：`--subnet-ids`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  数据库子网组的 EC2 子网 ID。
+ **Tags**：（在 CLI 中：`--tags`）[标签](api-other-apis.md#Tag) 对象的数组。

  要分配给新数据库子网组的标签。

**响应**

包含 Amazon Neptune 数据库子网组的详细信息。

此数据类型用作 [DescribeDBSubnetGroups（操作）](#DescribeDBSubnetGroups) 操作中的响应元素。
+ **DBSubnetGroupArn** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  数据库子网组的 Amazon 资源名称 (ARN)。
+ **DBSubnetGroupDescription** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  提供数据库子网组的描述。
+ **DBSubnetGroupName** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  数据库子网组的名称。
+ **SubnetGroupStatus** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  提供数据库子网组的状态。
+ **Subnets** – [子网](#Subnet) 对象的数组。

   包含 [子网（结构）](#Subnet) 元素的列表。
+ **VpcId** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  提供数据库子网组的 VpcId。

**错误**
+ [DBSubnetGroupAlreadyExistsFault](api-faults.md#DBSubnetGroupAlreadyExistsFault)
+ [DBSubnetGroupQuotaExceededFault](api-faults.md#DBSubnetGroupQuotaExceededFault)
+ [DBSubnetQuotaExceededFault](api-faults.md#DBSubnetQuotaExceededFault)
+ [DBSubnetGroupDoesNotCoverEnoughAZs](api-faults.md#DBSubnetGroupDoesNotCoverEnoughAZs)
+ [InvalidSubnet](api-faults.md#InvalidSubnet)

## DeleteDBSubnetGroup（操作）
<a name="DeleteDBSubnetGroup"></a>

         此 API 的 AWS CLI 名称为：`delete-db-subnet-group`。

删除数据库子网组。

**注意**  
指定的数据库子网组不得与任何数据库实例关联。

**请求**
+ **DBSubnetGroupName**（在 CLI 中：`--db-subnet-group-name`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  要删除的数据库子网组的名称。
**注意**  
您不能删除默认子网组。

  约束：

  约束：必须与现有 DBSubnetGroup 的名称匹配。不能是默认值。

  示例：`mySubnetgroup`

**响应**
+ *无响应参数。*

**错误**
+ [InvalidDBSubnetGroupStateFault](api-faults.md#InvalidDBSubnetGroupStateFault)
+ [InvalidDBSubnetStateFault](api-faults.md#InvalidDBSubnetStateFault)
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)

## ModifyDBSubnetGroup（操作）
<a name="ModifyDBSubnetGroup"></a>

         此 API 的 AWS CLI 名称为：`modify-db-subnet-group`。

修改现有的数据库子网组。数据库子网组必须在 Amazon 区域的至少两个可用区中包含至少一个子网。

**请求**
+ **DBSubnetGroupDescription**（在 CLI 中：`--db-subnet-group-description`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  数据库子网组的描述。
+ **DBSubnetGroupName**（在 CLI 中：`--db-subnet-group-name`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  数据库子网组的名称。此值以一个小写字符串存储。您不能修改默认子网组。

  约束：必须与现有 DBSubnetGroup 的名称匹配。不能是默认值。

  示例：`mySubnetgroup`
+ **SubnetIds**（在 CLI 中：`--subnet-ids`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  数据库子网组的 EC2 子网 ID。

**响应**

包含 Amazon Neptune 数据库子网组的详细信息。

此数据类型用作 [DescribeDBSubnetGroups（操作）](#DescribeDBSubnetGroups) 操作中的响应元素。
+ **DBSubnetGroupArn** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  数据库子网组的 Amazon 资源名称 (ARN)。
+ **DBSubnetGroupDescription** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  提供数据库子网组的描述。
+ **DBSubnetGroupName** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  数据库子网组的名称。
+ **SubnetGroupStatus** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  提供数据库子网组的状态。
+ **Subnets** – [子网](#Subnet) 对象的数组。

   包含 [子网（结构）](#Subnet) 元素的列表。
+ **VpcId** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  提供数据库子网组的 VpcId。

**错误**
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)
+ [DBSubnetQuotaExceededFault](api-faults.md#DBSubnetQuotaExceededFault)
+ [SubnetAlreadyInUse](api-faults.md#SubnetAlreadyInUse)
+ [DBSubnetGroupDoesNotCoverEnoughAZs](api-faults.md#DBSubnetGroupDoesNotCoverEnoughAZs)
+ [InvalidSubnet](api-faults.md#InvalidSubnet)

## DescribeDBSubnetGroups（操作）
<a name="DescribeDBSubnetGroups"></a>

         此 API 的 AWS CLI 名称为：`describe-db-subnet-groups`。

返回 DBSubnetGroup 描述的列表。如果指定了 DBSubnetGroupName，则列表中只包含指定 DBSubnetGroup 的描述。

要查看 CIDR 范围概览，请访问 [Wikipedia Tutorial](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)。

**请求**
+ **DBSubnetGroupName**（在 CLI 中：`--db-subnet-group-name`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  要为其返回详细信息的数据库子网组的名称。
+ **Filters**：（在 CLI 中：`--filters`）[筛选条件](api-datatypes.md#Filter) 对象的数组。

  当前不支持此参数。
+ **Marker**（在 CLI 中：`--marker`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。

   由之前的 DescribeDBSubnetGroups 请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。
+ **MaxRecords**（在 CLI 中：`--max-records`）– IntegerOptional，类型为：`integer`（带符号的 32 位整数）。

   包括在响应中的最大记录数。如果存在的记录数超过了指定的`MaxRecords` 值，则在响应中包含称为标记的分页记号，以便检索剩余的结果。

  默认值：100

  约束：最低为 20，最高为 100。

**响应**
+ **DBSubnetGroups** – [DBSubnetGroup](#DBSubnetGroup) 对象的数组。

   [DBSubnetGroup（结构）](#DBSubnetGroup) 实例的列表。
+ **Marker** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。

   由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。

**错误**
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)

## *结构：*
<a name="api-subnets-structures-spacer"></a>

## 子网（结构）
<a name="Subnet"></a>

指定一个子网。

 此数据类型用作 [DescribeDBSubnetGroups（操作）](#DescribeDBSubnetGroups) 操作中的响应元素。

**Fields**
+ **SubnetAvailabilityZone** –这是一个 [AvailabilityZone](api-datatypes.md#AvailabilityZone) 对象。

  指定子网所在的 EC2 可用区。
+ **SubnetIdentifier** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  指定子网的标识符。
+ **SubnetStatus** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  指定子网的状态。

## DBSubnetGroup（结构）
<a name="DBSubnetGroup"></a>

包含 Amazon Neptune 数据库子网组的详细信息。

此数据类型用作 [DescribeDBSubnetGroups（操作）](#DescribeDBSubnetGroups) 操作中的响应元素。

**Fields**
+ **DBSubnetGroupArn** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  数据库子网组的 Amazon 资源名称 (ARN)。
+ **DBSubnetGroupDescription** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  提供数据库子网组的描述。
+ **DBSubnetGroupName** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  数据库子网组的名称。
+ **SubnetGroupStatus** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  提供数据库子网组的状态。
+ **Subnets** – 这是 [子网](#Subnet) 对象数组。

   包含 [子网（结构）](#Subnet) 元素的列表。
+ **VpcId** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  提供数据库子网组的 VpcId。

`DBSubnetGroup` 用作下列对象的响应元素：
+ [CreateDBSubnetGroup](#CreateDBSubnetGroup)
+ [ModifyDBSubnetGroup](#ModifyDBSubnetGroup)