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

# 其他 Neptune API
<a name="api-other-apis"></a>

**操作：**
+ [AddTagsToResource（操作）](#AddTagsToResource)
+ [ListTagsForResource（操作）](#ListTagsForResource)
+ [RemoveTagsFromResource（操作）](#RemoveTagsFromResource)
+ [ApplyPendingMaintenanceAction（操作）](#ApplyPendingMaintenanceAction)
+ [DescribePendingMaintenanceActions（操作）](#DescribePendingMaintenanceActions)
+ [DescribeDBEngineVersions（操作）](#DescribeDBEngineVersions)

**结构：**
+ [DBEngineVersion（结构）](#DBEngineVersion)
+ [EngineDefaults（结构）](#EngineDefaults)
+ [PendingMaintenanceAction（结构）](#PendingMaintenanceAction)
+ [ResourcePendingMaintenanceActions（结构）](#ResourcePendingMaintenanceActions)
+ [UpgradeTarget（结构）](#UpgradeTarget)
+ [Tag（结构）](#Tag)

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

         此 API 的 AWS CLI 名称为：`add-tags-to-resource`。

向 Amazon Neptune 资源中添加元数据标签。这些标签还可以与成本分配报告一起使用，以跟踪与 Amazon Neptune 资源相关的成本，或者在 Amazon Neptune 的 IAM 策略中的条件语句内使用。

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

  将标签添加到的 Amazon Neptune 资源。此值是 Amazon 资源名称 (ARN)。有关创建 ARN 的信息，请参阅[构造 Amazon 资源名称 (ARN)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing)。
+ **Tags**（在 CLI 中：`--tags`）- *必需：*[标签](#Tag) 对象的数组。

  要分配给 Amazon Neptune 资源的标签。

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

**错误**
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)
+ [DBSnapshotNotFoundFault](api-faults.md#DBSnapshotNotFoundFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)

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

         此 API 的 AWS CLI 名称为：`list-tags-for-resource`。

列出 Amazon Neptune 资源上的所有标签。

**请求**
+ **Filters**：（在 CLI 中：`--filters`）[筛选条件](api-datatypes.md#Filter) 对象的数组。

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

  带有要列出的标签的 Amazon Neptune 资源。此值是 Amazon 资源名称 (ARN)。有关创建 ARN 的信息，请参阅[构造 Amazon 资源名称 (ARN)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing)。

**响应**
+ **TagList** – [标签](#Tag) 对象的数组。

  ListTagsForResource 操作返回的标签列表。

**错误**
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)
+ [DBSnapshotNotFoundFault](api-faults.md#DBSnapshotNotFoundFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)

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

         此 API 的 AWS CLI 名称为：`remove-tags-from-resource`。

从 Amazon Neptune 资源中删除元数据标签。

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

  从其中删除标签的 Amazon Neptune 资源。此值是 Amazon 资源名称 (ARN)。有关创建 ARN 的信息，请参阅[构造 Amazon 资源名称 (ARN)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing)。
+ **TagKeys**（在 CLI 中：`--tag-keys`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  要删除的标签的标签键（名称）。

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

**错误**
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)
+ [DBSnapshotNotFoundFault](api-faults.md#DBSnapshotNotFoundFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)

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

         此 API 的 AWS CLI 名称为：`apply-pending-maintenance-action`。

将待处理的维护操作应用于资源（例如，应用于数据库实例）。

**请求**
+ **ApplyAction**（在 CLI 中：`--apply-action`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  应用于此资源的待处理的维护操作。

  有效值：`system-update`、`db-upgrade`
+ **OptInType**（在 CLI 中：`--opt-in-type`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  用于指定加入请求类型或撤消加入请求的值。不能撤消 `immediate` 类型的加入请求。

  有效值：
  + `immediate` - 立即应用维护操作。
  + `next-maintenance` - 在资源的下一个维护时段内应用维护操作。
  + `undo-opt-in` - 取消任何现有的 `next-maintenance` 加入请求。
+ **ResourceIdentifier**（在 CLI 中：`--resource-identifier`）– *必需：*一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  待处理的维护操作应用于的资源的 Amazon 资源名称 (ARN)。有关创建 ARN 的信息，请参阅[构造 Amazon 资源名称 (ARN)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing)。

**响应**

描述资源的待处理维护操作。
+ **PendingMaintenanceActionDetails** – [PendingMaintenanceAction](#PendingMaintenanceAction) 对象的数组。

  一个列表，提供有关资源的待处理维护操作的详细信息。
+ **ResourceIdentifier** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  具有待处理维护操作的资源的 ARN。

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

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

         此 API 的 AWS CLI 名称为：`describe-pending-maintenance-actions`。

返回至少具有一个待处理的维护操作的资源（例如，数据库实例）的列表。

**请求**
+ **Filters**：（在 CLI 中：`--filters`）[筛选条件](api-datatypes.md#Filter) 对象的数组。

  一个筛选条件，用于指定一个或多个资源以返回其待处理的维护操作。

  支持的筛选条件：
  +  `db-cluster-id` - 接受数据库集群标识符和数据库集群 Amazon 资源名称 (ARN)。结果列表将仅包括由这些 ARN 标识的数据库集群的待处理维护操作。
  +  `db-instance-id` - 接受数据库实例标识符和数据库实例 ARN。结果列表将仅包括由这些 ARN 标识的数据库实例的待处理维护操作。
+ **Marker**（在 CLI 中：`--marker`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。

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

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

  默认值：100

  约束：最低为 20，最高为 100。
+ **ResourceIdentifier**（在 CLI 中：`--resource-identifier`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  用于返回其待处理维护操作的资源的 ARN。

**响应**
+ **Marker** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。

   由之前的 `DescribePendingMaintenanceActions` 请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数为 `MaxRecords` 指定的记录数。
+ **PendingMaintenanceActions** – [ResourcePendingMaintenanceActions](#ResourcePendingMaintenanceActions) 对象的数组。

  资源的待处理维护操作的列表。

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

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

         此 API 的 AWS CLI 名称为：`describe-db-engine-versions`。

返回可用数据库引擎的列表。

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

  要返回其详细信息的特定数据库参数组系列的名称。

  约束：
  + 如果提供，则必须匹配现有 DBParameterGroupFamily。
+ **DefaultOnly**（在 CLI 中：`--default-only`）– 一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。

  指示仅返回指定引擎的默认版本还是返回引擎与主要版本的组合。
+ **Engine**（在 CLI 中：`--engine`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  要返回的数据库引擎。
+ **EngineVersion**（在 CLI 中：`--engine-version`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  要返回的数据库引擎版本。

  示例：`5.1.49`
+ **Filters**：（在 CLI 中：`--filters`）[筛选条件](api-datatypes.md#Filter) 对象的数组。

  当前不支持。
+ **ListSupportedCharacterSets**（在 CLI 中：`--list-supported-character-sets`）– BooleanOptional，类型为：`boolean` [布尔值（true 或 false）]。

  如果指定了此参数且请求的引擎支持 `CharacterSetName` 的 `CreateDBInstance` 参数，则响应包括每个引擎版本支持的字符集列表。
+ **ListSupportedTimezones**（在 CLI 中：`--list-supported-timezones`）– BooleanOptional，类型为：`boolean` [布尔值（true 或 false）]。

  如果指定了此参数且请求的引擎支持 `TimeZone` 的 `CreateDBInstance` 参数，则响应包括每个引擎版本支持的时区列表。
+ **Marker**（在 CLI 中：`--marker`）– 一个字符串，类型为：`string`（UTF-8 编码的字符串）。

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

   包括在响应中的最大记录数。如果允许超过 `MaxRecords` 值，则在响应中包含称为标记的分页记号，以便检索以下结果。

  默认值：100

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

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

   `DBEngineVersion` 元素的列表。
+ **Marker** – 一个字符串，类型为：`string`（UTF-8 编码的字符串）。

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

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

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

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

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

  数据库引擎的描述。
+ **DBEngineVersionDescription** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  数据库引擎版本的描述。
+ **DBParameterGroupFamily** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  要用于数据库引擎的数据库参数组系列的名称。
+ **Engine** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。

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

  数据库引擎的版本号。
+ **ExportableLogTypes** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  数据库引擎可用于导出到 CloudWatch Logs 的日志的类型。
+ **SupportedTimezones** – 这是 [时区](api-datatypes.md#Timezone) 对象数组。

  用于 `Timezone` 操作的 `CreateDBInstance` 参数且受此引擎支持的时区列表。
+ **SupportsGlobalDatabases** - 这是一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。

  一个值，指示您是否可以将 Aurora 全球数据库与特定数据库引擎版本一起使用。
+ **SupportsLogExportsToCloudwatchLogs** - 这是一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。

  一个值，指示引擎版本是否支持将 ExportableLogTypes 指定的日志类型导出到 CloudWatch Logs。
+ **SupportsReadReplica** - 这是一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。

  指示数据库引擎版本是否支持只读副本。
+ **ValidUpgradeTarget** – 这是 [UpgradeTarget](#UpgradeTarget) 对象数组。

  此数据库引擎版本可以升级到的引擎版本列表。

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

 包含 [DescribeEngineDefaultParameters（操作）](api-parameters.md#DescribeEngineDefaultParameters) 操作的成功调用的结果。

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

  指定引擎默认参数应用到的数据库参数组系列的名称。
+ **Marker** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。

   由之前的 EngineDefaults 请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。
+ **Parameters** – 这是 [参数](api-parameters.md#Parameter) 对象数组。

  包含引擎默认参数的列表。

`EngineDefaults` 用作下列对象的响应元素：
+ [DescribeEngineDefaultParameters](api-parameters.md#DescribeEngineDefaultParameters)
+ [DescribeEngineDefaultClusterParameters](api-parameters.md#DescribeEngineDefaultClusterParameters)

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

提供有关资源的待处理维护操作的信息。

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

  可用于资源的待处理维护操作的类型。
+ **AutoAppliedAfterDate** – 这是 TStamp，类型为：`timestamp`（一个时间点，通常定义为与 1970 年 1 月 1 日午夜的偏移量）。

  应用操作时维护时段的日期。维护操作在此日期之后的第一个维护时段期间应用于资源。如果指定了此日期，则忽略任何 `next-maintenance` 加入请求。
+ **CurrentApplyDate** – 这是 TStamp，类型为：`timestamp`（一个时间点，通常定义为与 1970 年 1 月 1 日午夜的偏移量）。

  待处理维护操作应用于资源的生效日期。此日期考虑了从 [ApplyPendingMaintenanceAction（操作）](#ApplyPendingMaintenanceAction) API、`AutoAppliedAfterDate` 和 `ForcedApplyDate` 收到的加入请求。如果未收到加入请求且未将任何内容指定为 `AutoAppliedAfterDate` 或 `ForcedApplyDate`，则此值为空。
+ **Description** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  提供有关维护操作的更多详细信息的描述。
+ **ForcedApplyDate** – 这是 TStamp，类型为：`timestamp`（一个时间点，通常定义为与 1970 年 1 月 1 日午夜的偏移量）。

  自动应用维护操作时的日期。无论资源的维护时段如何，维护操作都将在此日期应用于资源。如果指定了此日期，则忽略任何 `immediate` 加入请求。
+ **OptInStatus** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  指示已为资源接收的加入请求的类型。

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

描述资源的待处理维护操作。

**Fields**
+ **PendingMaintenanceActionDetails** – 这是 [PendingMaintenanceAction](#PendingMaintenanceAction) 对象数组。

  一个列表，提供有关资源的待处理维护操作的详细信息。
+ **ResourceIdentifier** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  具有待处理维护操作的资源的 ARN。

`ResourcePendingMaintenanceActions` 用作下列对象的响应元素：
+ [ApplyPendingMaintenanceAction](#ApplyPendingMaintenanceAction)

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

数据库实例可以升级到的数据库引擎的版本。

**Fields**
+ **AutoUpgrade** - 这是一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。

  一个值，指示目标版本是否应用于 AutoMinorVersionUpgrade 设置为 true 的任何源数据库实例。
+ **Description** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  数据库实例可以升级到的数据库引擎的版本。
+ **Engine** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  升级目标数据库引擎的名称。
+ **EngineVersion** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  升级目标数据库引擎的版本号。
+ **IsMajorVersionUpgrade** - 这是一个布尔值，类型为：`boolean` [布尔值（true 或 false）]。

  一个值，用于指示数据库引擎是否已升级到主要版本。
+ **SupportsGlobalDatabases** – 这是 BooleanOptional，类型为：`boolean` [布尔值（true 或 false）]。

  一个值，用于指示是否可以将 Neptune 全球数据库与目标引擎版本一起使用。

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

分配给包含键值对的 Amazon Neptune 资源的元数据。

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

  键是标签必需的名称。该字符串值的长度可以在 1 到 128 个 Unicode 字符之间，并且不能带有前缀 `aws:` 或 `rds:`。该字符串只能包含 Unicode 字母、数字、空格、“\_”、“.”、“/”、“=”、“\+”、“-”的集合（Java 正则表达式：“^([\\\\p{L}\\\\p{Z}\\\\p{N}\_.:/=\+\\\\-]\*)$”)。
+ **Value** – 这是一个字符串，类型为：`string`（UTF-8 编码的字符串）。

  值是标签的可选内容。该字符串值的长度可以在 1 到 256 个 Unicode 字符之间，并且不能带有前缀 `aws:` 或 `rds:`。该字符串只能包含 Unicode 字母、数字、空格、“\_”、“.”、“/”、“=”、“\+”、“-”的集合（Java 正则表达式：“^([\\\\p{L}\\\\p{Z}\\\\p{N}\_.:/=\+\\\\-]\*)$”)。