本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
Neptune 全球数据库 API
操作:
结构：
CreateGlobalCluster（操作）
此 API 的 Amazon CLI 名称为：create-global-cluster。
创建分布在多个 Amazon 区域中的 Neptune 全球数据库。全球数据库包含单个具有读写功能的主集群和若干只读辅助集群，这些辅助集群通过 Neptune 存储子系统执行的高速复制从主集群接收数据。
您可以创建最初为空的全球数据库，然后向其中添加主集群和辅助集群，也可以在创建操作期间指定现有 Neptune 集群以成为全球数据库的主集群。
请求
-
DatabaseName（在 CLI 中：
--database-name）– 一个字符串，类型为：string（UTF-8 编码的字符串）。新全球数据库的名称（最多 64 个字母数字字符）。
-
DeletionProtection（在 CLI 中：
--deletion-protection）– BooleanOptional，类型为：boolean[布尔值（true 或 false）]。新全局数据库的删除保护设置。在启用删除保护时，无法删除全局数据库。
-
Engine（在 CLI 中：
--engine）– 一个字符串，类型为：string（UTF-8 编码的字符串）。要用于全球数据库中的数据库引擎的名称。
有效值：
neptune -
EngineVersion（在 CLI 中：
--engine-version）– 一个字符串，类型为：string（UTF-8 编码的字符串）。全球数据库要使用的 Neptune 引擎版本。
有效值为：
1.2.0.0或更高版本。 -
GlobalClusterIdentifier（在 CLI 中：
--global-cluster-identifier）– 必需：GlobalClusterIdentifier，类型为：string（UTF-8 编码的字符串），不小于 1 或大于 255，与以下正则表达式匹配：[A-Za-z][0-9A-Za-z-:._]*。新全局数据库集群的集群标识符。
-
SourceDBClusterIdentifier（在 CLI 中：
--source-db-cluster-identifier）– 一个字符串，类型为：string（UTF-8 编码的字符串）。（可选）要用作新全球数据库的主集群的现有 Neptune 数据库集群的 Amazon 资源名称 (ARN)。
-
StorageEncrypted（在 CLI 中：
--storage-encrypted）– BooleanOptional，类型为：boolean[布尔值（true 或 false）]。新全球数据库集群的存储加密设置。
响应
包含 Amazon Neptune 全球数据库的详细信息。
此数据类型用作 CreateGlobalCluster（操作）、DescribeGlobalClusters（操作）、ModifyGlobalCluster（操作）、DeleteGlobalCluster（操作）、FailoverGlobalCluster（操作） 和 RemoveFromGlobalCluster（操作） 操作的响应元素。
-
DeletionProtection – BooleanOptional，类型为：
boolean[布尔值（true 或 false）]。全球数据库的删除保护设置。
-
Engine – 一个字符串，类型为：
string（UTF-8 编码的字符串）。全球数据库使用的 Neptune 数据库引擎（
"neptune"）。 -
EngineVersion – 一个字符串，类型为：
string（UTF-8 编码的字符串）。全球数据库使用的 Neptune 引擎版本。
-
GlobalClusterArn – 一个字符串，类型为：
string（UTF-8 编码的字符串）。全球数据库的 Amazon 资源名称 (ARN)。
-
GlobalClusterIdentifier – GlobalClusterIdentifier，类型为：
string（UTF-8 编码的字符串），不小于 1 或大于 255，与以下正则表达式匹配：[A-Za-z][0-9A-Za-z-:._]*。包含用户提供的全球数据库集群标识符。此标识符是标识全球数据库的唯一键。
-
GlobalClusterMembers – GlobalClusterMember 对象的数组。
属于全球数据库的所有数据库集群的集群 ARN 和实例 ARN 的列表。
-
GlobalClusterResourceId – 一个字符串，类型为：
string（UTF-8 编码的字符串）。全球数据库的不可变标识符，在所有区域内都是唯一的。只要访问了用户数据库集群的 KMS 密钥，就可在 CloudTrail 日志条目中找到此标识符。
-
Status – 一个字符串，类型为：
string（UTF-8 编码的字符串）。指定此全球数据库的当前状态。
-
StorageEncrypted – BooleanOptional，类型为：
boolean[布尔值（true 或 false）]。全球数据库的存储加密设置。
错误
DeleteGlobalCluster（操作）
此 API 的 Amazon CLI 名称为：delete-global-cluster。
删除全球数据库。必须首先已分离或删除主集群和所有辅助集群。
请求
-
GlobalClusterIdentifier（在 CLI 中：
--global-cluster-identifier）– 必需：GlobalClusterIdentifier，类型为：string（UTF-8 编码的字符串），不小于 1 或大于 255，与以下正则表达式匹配：[A-Za-z][0-9A-Za-z-:._]*。正删除的全球数据库集群的集群标识符。
响应
包含 Amazon Neptune 全球数据库的详细信息。
此数据类型用作 CreateGlobalCluster（操作）、DescribeGlobalClusters（操作）、ModifyGlobalCluster（操作）、DeleteGlobalCluster（操作）、FailoverGlobalCluster（操作） 和 RemoveFromGlobalCluster（操作） 操作的响应元素。
-
DeletionProtection – BooleanOptional，类型为：
boolean[布尔值（true 或 false）]。全球数据库的删除保护设置。
-
Engine – 一个字符串，类型为：
string（UTF-8 编码的字符串）。全球数据库使用的 Neptune 数据库引擎（
"neptune"）。 -
EngineVersion – 一个字符串，类型为：
string（UTF-8 编码的字符串）。全球数据库使用的 Neptune 引擎版本。
-
GlobalClusterArn – 一个字符串，类型为：
string（UTF-8 编码的字符串）。全球数据库的 Amazon 资源名称 (ARN)。
-
GlobalClusterIdentifier – GlobalClusterIdentifier，类型为：
string（UTF-8 编码的字符串），不小于 1 或大于 255，与以下正则表达式匹配：[A-Za-z][0-9A-Za-z-:._]*。包含用户提供的全球数据库集群标识符。此标识符是标识全球数据库的唯一键。
-
GlobalClusterMembers – GlobalClusterMember 对象的数组。
属于全球数据库的所有数据库集群的集群 ARN 和实例 ARN 的列表。
-
GlobalClusterResourceId – 一个字符串，类型为：
string（UTF-8 编码的字符串）。全球数据库的不可变标识符，在所有区域内都是唯一的。只要访问了用户数据库集群的 KMS 密钥，就可在 CloudTrail 日志条目中找到此标识符。
-
Status – 一个字符串，类型为：
string（UTF-8 编码的字符串）。指定此全球数据库的当前状态。
-
StorageEncrypted – BooleanOptional，类型为：
boolean[布尔值（true 或 false）]。全球数据库的存储加密设置。
ModifyGlobalCluster（操作）
此 API 的 Amazon CLI 名称为：modify-global-cluster。
修改 Amazon Neptune 全球集群的设置。您可通过在请求中指定这些参数及其新值，更改一个或多个数据库配置参数。
请求
-
AllowMajorVersionUpgrade（在 CLI 中：
--allow-major-version-upgrade）– BooleanOptional，类型为：boolean[布尔值（true 或 false）]。指示是否允许主要版本升级的值。
约束：如果为
EngineVersion参数指定的主要版本值与数据库集群的当前版本不同，则必须允许主要版本升级。如果您升级全球数据库的主要版本，则集群和数据库实例参数组将设置为新版本的默认参数组，因此您需要在完成升级后应用任何自定义参数组。
-
DeletionProtection（在 CLI 中：
--deletion-protection）– BooleanOptional，类型为：boolean[布尔值（true 或 false）]。指示全球数据库是否启用了删除保护。在启用删除保护时，无法删除全球数据库。
-
EngineVersion（在 CLI 中：
--engine-version）– 一个字符串，类型为：string（UTF-8 编码的字符串）。要升级到的数据库引擎的版本号。更改此参数将导致中断。除非启用
ApplyImmediately，否则会在下个维护时段内应用更改。要列出所有可用的 Neptune 引擎版本，请使用以下命令：
aws neptune describe-db-engine-versions \ --engine neptune \ --query '*[]|[?SupportsGlobalDatabases == 'true'].[EngineVersion]' -
GlobalClusterIdentifier（在 CLI 中：
--global-cluster-identifier）– 必需：GlobalClusterIdentifier，类型为：string（UTF-8 编码的字符串），不小于 1 或大于 255，与以下正则表达式匹配：[A-Za-z][0-9A-Za-z-:._]*。要修改的全球集群的数据库集群标识符。此参数不区分大小写。
约束：必须与现有全球数据库集群的标识符匹配。
-
NewGlobalClusterIdentifier（在 CLI 中：
--new-global-cluster-identifier）– GlobalClusterIdentifier，类型为：string（UTF-8 编码的字符串），不小于 1 或大于 255，与以下正则表达式匹配：[A-Za-z][0-9A-Za-z-:._]*。要分配给全球数据库的新集群标识符。此值以一个小写字符串存储。
约束：
-
必须包含 1 到 63 个字母、数字或连字符。
-
第一个字符必须是字母。
-
不能以连字符结尾，也不能包含两个连续连字符
示例：
my-cluster2 -
响应
包含 Amazon Neptune 全球数据库的详细信息。
此数据类型用作 CreateGlobalCluster（操作）、DescribeGlobalClusters（操作）、ModifyGlobalCluster（操作）、DeleteGlobalCluster（操作）、FailoverGlobalCluster（操作） 和 RemoveFromGlobalCluster（操作） 操作的响应元素。
-
DeletionProtection – BooleanOptional，类型为：
boolean[布尔值（true 或 false）]。全球数据库的删除保护设置。
-
Engine – 一个字符串，类型为：
string（UTF-8 编码的字符串）。全球数据库使用的 Neptune 数据库引擎（
"neptune"）。 -
EngineVersion – 一个字符串，类型为：
string（UTF-8 编码的字符串）。全球数据库使用的 Neptune 引擎版本。
-
GlobalClusterArn – 一个字符串，类型为：
string（UTF-8 编码的字符串）。全球数据库的 Amazon 资源名称 (ARN)。
-
GlobalClusterIdentifier – GlobalClusterIdentifier，类型为：
string（UTF-8 编码的字符串），不小于 1 或大于 255，与以下正则表达式匹配：[A-Za-z][0-9A-Za-z-:._]*。包含用户提供的全球数据库集群标识符。此标识符是标识全球数据库的唯一键。
-
GlobalClusterMembers – GlobalClusterMember 对象的数组。
属于全球数据库的所有数据库集群的集群 ARN 和实例 ARN 的列表。
-
GlobalClusterResourceId – 一个字符串，类型为：
string（UTF-8 编码的字符串）。全球数据库的不可变标识符，在所有区域内都是唯一的。只要访问了用户数据库集群的 KMS 密钥，就可在 CloudTrail 日志条目中找到此标识符。
-
Status – 一个字符串，类型为：
string（UTF-8 编码的字符串）。指定此全球数据库的当前状态。
-
StorageEncrypted – BooleanOptional，类型为：
boolean[布尔值（true 或 false）]。全球数据库的存储加密设置。
DescribeGlobalClusters（操作）
此 API 的 Amazon CLI 名称为：describe-global-clusters。
返回有关 Neptune 全球数据库集群的信息。此 API 支持分页。
请求
-
GlobalClusterIdentifier（在 CLI 中：
--global-cluster-identifier）– GlobalClusterIdentifier，类型为：string（UTF-8 编码的字符串），不小于 1 或大于 255，与以下正则表达式匹配：[A-Za-z][0-9A-Za-z-:._]*。用户提供的数据库集群标识符。如果指定了此参数，则只返回有关指定的数据库集群的信息。此参数不区分大小写。
约束：如果提供，则必须与现有的数据库集群标识符匹配。
-
Marker（在 CLI 中：
--marker）– 一个字符串，类型为：string（UTF-8 编码的字符串）。（可选）由上一次调用
DescribeGlobalClusters返回的分页令牌。如果指定此参数，则响应将仅包含标记之外的记录，直至MaxRecords指定的数量。 -
MaxRecords（在 CLI 中：
--max-records）– IntegerOptional，类型为：integer（带符号的 32 位整数）。包括在响应中的最大记录数。如果存在的记录数多于指定的
MaxRecords值，则响应中会包含一个分页标记令牌，您可以使用它来检索剩余的结果。默认值：
100约束：最低为 20，最高为 100。
响应
-
GlobalClusters – GlobalCluster 对象的数组。
此请求返回的全球集群和实例列表。
-
Marker – 一个字符串，类型为：
string（UTF-8 编码的字符串）。分页令牌。如果在响应中返回此参数，则会有更多记录可用，这些记录可通过对
DescribeGlobalClusters的一个或多个额外调用进行检索。
FailoverGlobalCluster（操作）
此 API 的 Amazon CLI 名称为：failover-global-cluster。
启动 Neptune 全球数据库的失效转移过程。
Neptune 全球数据库的失效转移会将一个辅助只读数据库集群提升为主数据库集群，并将主数据库集群降级为辅助（只读）数据库集群。换句话说，可以切换当前主数据库集群和选定的目标辅助数据库集群的角色。所选的辅助数据库集群假设 Neptune 全球数据库具有完全读/写能力。
注意
此操作仅适用于 Neptune 全球数据库。此操作仅适用于运行状况良好、Neptune 数据库集群正常运行且没有区域性中断的 Neptune 全球数据库，用于测试灾难恢复方案或重新配置全球数据库拓扑。
请求
-
GlobalClusterIdentifier（在 CLI 中：
--global-cluster-identifier）– 必需：GlobalClusterIdentifier，类型为：string（UTF-8 编码的字符串），不小于 1 或大于 255，与以下正则表达式匹配：[A-Za-z][0-9A-Za-z-:._]*。应进行失效转移的 Neptune 全球数据库的标识符。标识符是用户在创建 Neptune 全球数据库时分配的唯一密钥。换句话说，这是要进行失效转移的全球数据库的名称。
约束：必须与现有 Neptune 全球数据库的标识符匹配。
-
TargetDbClusterIdentifier（在 CLI 中：
--target-db-cluster-identifier）– 必需：一个字符串，类型为：string（UTF-8 编码的字符串）。要提升为全球数据库的主数据库集群的辅助 Neptune 数据库集群的 Amazon 资源名称 (ARN)。
响应
包含 Amazon Neptune 全球数据库的详细信息。
此数据类型用作 CreateGlobalCluster（操作）、DescribeGlobalClusters（操作）、ModifyGlobalCluster（操作）、DeleteGlobalCluster（操作）、FailoverGlobalCluster（操作） 和 RemoveFromGlobalCluster（操作） 操作的响应元素。
-
DeletionProtection – BooleanOptional，类型为：
boolean[布尔值（true 或 false）]。全球数据库的删除保护设置。
-
Engine – 一个字符串，类型为：
string（UTF-8 编码的字符串）。全球数据库使用的 Neptune 数据库引擎（
"neptune"）。 -
EngineVersion – 一个字符串，类型为：
string（UTF-8 编码的字符串）。全球数据库使用的 Neptune 引擎版本。
-
GlobalClusterArn – 一个字符串，类型为：
string（UTF-8 编码的字符串）。全球数据库的 Amazon 资源名称 (ARN)。
-
GlobalClusterIdentifier – GlobalClusterIdentifier，类型为：
string（UTF-8 编码的字符串），不小于 1 或大于 255，与以下正则表达式匹配：[A-Za-z][0-9A-Za-z-:._]*。包含用户提供的全球数据库集群标识符。此标识符是标识全球数据库的唯一键。
-
GlobalClusterMembers – GlobalClusterMember 对象的数组。
属于全球数据库的所有数据库集群的集群 ARN 和实例 ARN 的列表。
-
GlobalClusterResourceId – 一个字符串，类型为：
string（UTF-8 编码的字符串）。全球数据库的不可变标识符，在所有区域内都是唯一的。只要访问了用户数据库集群的 KMS 密钥，就可在 CloudTrail 日志条目中找到此标识符。
-
Status – 一个字符串，类型为：
string（UTF-8 编码的字符串）。指定此全球数据库的当前状态。
-
StorageEncrypted – BooleanOptional，类型为：
boolean[布尔值（true 或 false）]。全球数据库的存储加密设置。
错误
RemoveFromGlobalCluster（操作）
此 API 的 Amazon CLI 名称为：remove-from-global-cluster。
将 Neptune 数据库集群与 Neptune 全球数据库分离。辅助集群变成具有读写功能而不是只读的普通独立集群，并且不再接收来自主集群的数据。
请求
-
DbClusterIdentifier（在 CLI 中：
--db-cluster-identifier）– 必需：一个字符串，类型为：string（UTF-8 编码的字符串）。标识要与 Neptune 全球数据库集群分离的集群的 Amazon 资源名称 (ARN)。
-
GlobalClusterIdentifier（在 CLI 中：
--global-cluster-identifier）– 必需：GlobalClusterIdentifier，类型为：string（UTF-8 编码的字符串），不小于 1 或大于 255，与以下正则表达式匹配：[A-Za-z][0-9A-Za-z-:._]*。要从中分离指定的 Neptune 数据库集群的 Neptune 全球数据库的标识符。
响应
包含 Amazon Neptune 全球数据库的详细信息。
此数据类型用作 CreateGlobalCluster（操作）、DescribeGlobalClusters（操作）、ModifyGlobalCluster（操作）、DeleteGlobalCluster（操作）、FailoverGlobalCluster（操作） 和 RemoveFromGlobalCluster（操作） 操作的响应元素。
-
DeletionProtection – BooleanOptional，类型为：
boolean[布尔值（true 或 false）]。全球数据库的删除保护设置。
-
Engine – 一个字符串，类型为：
string（UTF-8 编码的字符串）。全球数据库使用的 Neptune 数据库引擎（
"neptune"）。 -
EngineVersion – 一个字符串，类型为：
string（UTF-8 编码的字符串）。全球数据库使用的 Neptune 引擎版本。
-
GlobalClusterArn – 一个字符串，类型为：
string（UTF-8 编码的字符串）。全球数据库的 Amazon 资源名称 (ARN)。
-
GlobalClusterIdentifier – GlobalClusterIdentifier，类型为：
string（UTF-8 编码的字符串），不小于 1 或大于 255，与以下正则表达式匹配：[A-Za-z][0-9A-Za-z-:._]*。包含用户提供的全球数据库集群标识符。此标识符是标识全球数据库的唯一键。
-
GlobalClusterMembers – GlobalClusterMember 对象的数组。
属于全球数据库的所有数据库集群的集群 ARN 和实例 ARN 的列表。
-
GlobalClusterResourceId – 一个字符串，类型为：
string（UTF-8 编码的字符串）。全球数据库的不可变标识符，在所有区域内都是唯一的。只要访问了用户数据库集群的 KMS 密钥，就可在 CloudTrail 日志条目中找到此标识符。
-
Status – 一个字符串，类型为：
string（UTF-8 编码的字符串）。指定此全球数据库的当前状态。
-
StorageEncrypted – BooleanOptional，类型为：
boolean[布尔值（true 或 false）]。全球数据库的存储加密设置。
结构：
GlobalCluster（结构）
包含 Amazon Neptune 全球数据库的详细信息。
此数据类型用作 CreateGlobalCluster（操作）、DescribeGlobalClusters（操作）、ModifyGlobalCluster（操作）、DeleteGlobalCluster（操作）、FailoverGlobalCluster（操作） 和 RemoveFromGlobalCluster（操作） 操作的响应元素。
字段
-
DeletionProtection – 这是 BooleanOptional，类型为：
boolean[布尔值（true 或 false）]。全球数据库的删除保护设置。
-
Engine – 这是一个字符串，类型为：
string（UTF-8 编码的字符串）。全球数据库使用的 Neptune 数据库引擎（
"neptune"）。 -
EngineVersion – 这是一个字符串，类型为：
string（UTF-8 编码的字符串）。全球数据库使用的 Neptune 引擎版本。
-
GlobalClusterArn – 这是一个字符串，类型为：
string（UTF-8 编码的字符串）。全球数据库的 Amazon 资源名称 (ARN)。
-
GlobalClusterIdentifier – 这是 GlobalClusterIdentifier，类型为：
string（UTF-8 编码的字符串），不小于 1 或大于 255，与以下正则表达式匹配：[A-Za-z][0-9A-Za-z-:._]*。包含用户提供的全球数据库集群标识符。此标识符是标识全球数据库的唯一键。
-
GlobalClusterMembers – 这是 GlobalClusterMember 对象数组。
属于全球数据库的所有数据库集群的集群 ARN 和实例 ARN 的列表。
-
GlobalClusterResourceId – 这是一个字符串，类型为：
string（UTF-8 编码的字符串）。全球数据库的不可变标识符，在所有区域内都是唯一的。只要访问了用户数据库集群的 KMS 密钥，就可在 CloudTrail 日志条目中找到此标识符。
-
Status – 这是一个字符串，类型为：
string（UTF-8 编码的字符串）。指定此全球数据库的当前状态。
-
StorageEncrypted – 这是 BooleanOptional，类型为：
boolean[布尔值（true 或 false）]。全球数据库的存储加密设置。
GlobalCluster 用作下列对象的响应元素：
GlobalClusterMember（结构）
一种数据结构，其中包含与 Neptune 全球数据库关联的任何主集群和辅助集群的相关信息。
字段
-
DBClusterArn – 这是一个字符串，类型为：
string（UTF-8 编码的字符串）。每个 Neptune 集群的 Amazon 资源名称 (ARN)。
-
IsWriter - 这是一个布尔值，类型为：
boolean[布尔值（true 或 false）]。指定 Neptune 集群是否为与其关联的 Neptune 全球数据库的主集群（即具有读写功能）。
-
Readers – 这是一个字符串，类型为：
string（UTF-8 编码的字符串）。与 Neptune 全球数据库关联的每个只读辅助集群的 Amazon 资源名称 (ARN)。