本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。 # Amazon DocumentDB 集群、实例和资源管理 API 参考 本节介绍可通过 HTTP、AWS Command Line Interface (AWS CLI) 或 AWS SDK 访问的 Amazon DocumentDB（与 MongoDB 兼容）的集群、实例和资源管理操作。您可以使用这些 API 来创建、删除和修改集群和实例。 **重要** 这些 API 仅用于管理集群、实例和相关资源。有关如何连接到正在运行的 Amazon DocumentDB 集群的信息，请参阅[入门指南](get-started-guide.md)。 **Topics** + [操作](API_Operations.md) + [数据类型](API_Types.md) + [常见错误](CommonErrors.md) + [常见参数](CommonParameters.md) # 操作 Amazon DocumentDB (with MongoDB compatibility) 支持以下操作： + [AddSourceIdentifierToSubscription](API_AddSourceIdentifierToSubscription.md) + [AddTagsToResource](API_AddTagsToResource.md) + [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md) + [CopyDBClusterParameterGroup](API_CopyDBClusterParameterGroup.md) + [CopyDBClusterSnapshot](API_CopyDBClusterSnapshot.md) + [CreateDBCluster](API_CreateDBCluster.md) + [CreateDBClusterParameterGroup](API_CreateDBClusterParameterGroup.md) + [CreateDBClusterSnapshot](API_CreateDBClusterSnapshot.md) + [CreateDBInstance](API_CreateDBInstance.md) + [CreateDBSubnetGroup](API_CreateDBSubnetGroup.md) + [CreateEventSubscription](API_CreateEventSubscription.md) + [CreateGlobalCluster](API_CreateGlobalCluster.md) + [DeleteDBCluster](API_DeleteDBCluster.md) + [DeleteDBClusterParameterGroup](API_DeleteDBClusterParameterGroup.md) + [DeleteDBClusterSnapshot](API_DeleteDBClusterSnapshot.md) + [DeleteDBInstance](API_DeleteDBInstance.md) + [DeleteDBSubnetGroup](API_DeleteDBSubnetGroup.md) + [DeleteEventSubscription](API_DeleteEventSubscription.md) + [DeleteGlobalCluster](API_DeleteGlobalCluster.md) + [DescribeCertificates](API_DescribeCertificates.md) + [DescribeDBClusterParameterGroups](API_DescribeDBClusterParameterGroups.md) + [DescribeDBClusterParameters](API_DescribeDBClusterParameters.md) + [DescribeDBClusters](API_DescribeDBClusters.md) + [DescribeDBClusterSnapshotAttributes](API_DescribeDBClusterSnapshotAttributes.md) + [DescribeDBClusterSnapshots](API_DescribeDBClusterSnapshots.md) + [DescribeDBEngineVersions](API_DescribeDBEngineVersions.md) + [DescribeDBInstances](API_DescribeDBInstances.md) + [DescribeDBSubnetGroups](API_DescribeDBSubnetGroups.md) + [DescribeEngineDefaultClusterParameters](API_DescribeEngineDefaultClusterParameters.md) + [DescribeEventCategories](API_DescribeEventCategories.md) + [DescribeEvents](API_DescribeEvents.md) + [DescribeEventSubscriptions](API_DescribeEventSubscriptions.md) + [DescribeGlobalClusters](API_DescribeGlobalClusters.md) + [DescribeOrderableDBInstanceOptions](API_DescribeOrderableDBInstanceOptions.md) + [DescribePendingMaintenanceActions](API_DescribePendingMaintenanceActions.md) + [FailoverDBCluster](API_FailoverDBCluster.md) + [FailoverGlobalCluster](API_FailoverGlobalCluster.md) + [ListTagsForResource](API_ListTagsForResource.md) + [ModifyDBCluster](API_ModifyDBCluster.md) + [ModifyDBClusterParameterGroup](API_ModifyDBClusterParameterGroup.md) + [ModifyDBClusterSnapshotAttribute](API_ModifyDBClusterSnapshotAttribute.md) + [ModifyDBInstance](API_ModifyDBInstance.md) + [ModifyDBSubnetGroup](API_ModifyDBSubnetGroup.md) + [ModifyEventSubscription](API_ModifyEventSubscription.md) + [ModifyGlobalCluster](API_ModifyGlobalCluster.md) + [RebootDBInstance](API_RebootDBInstance.md) + [RemoveFromGlobalCluster](API_RemoveFromGlobalCluster.md) + [RemoveSourceIdentifierFromSubscription](API_RemoveSourceIdentifierFromSubscription.md) + [RemoveTagsFromResource](API_RemoveTagsFromResource.md) + [ResetDBClusterParameterGroup](API_ResetDBClusterParameterGroup.md) + [RestoreDBClusterFromSnapshot](API_RestoreDBClusterFromSnapshot.md) + [RestoreDBClusterToPointInTime](API_RestoreDBClusterToPointInTime.md) + [StartDBCluster](API_StartDBCluster.md) + [StopDBCluster](API_StopDBCluster.md) + [SwitchoverGlobalCluster](API_SwitchoverGlobalCluster.md) Amazon DocumentDB 弹性集群支持以下操作： + [ApplyPendingMaintenanceAction](API_elastic_ApplyPendingMaintenanceAction.md) + [CopyClusterSnapshot](API_elastic_CopyClusterSnapshot.md) + [CreateCluster](API_elastic_CreateCluster.md) + [CreateClusterSnapshot](API_elastic_CreateClusterSnapshot.md) + [DeleteCluster](API_elastic_DeleteCluster.md) + [DeleteClusterSnapshot](API_elastic_DeleteClusterSnapshot.md) + [GetCluster](API_elastic_GetCluster.md) + [GetClusterSnapshot](API_elastic_GetClusterSnapshot.md) + [GetPendingMaintenanceAction](API_elastic_GetPendingMaintenanceAction.md) + [ListClusters](API_elastic_ListClusters.md) + [ListClusterSnapshots](API_elastic_ListClusterSnapshots.md) + [ListPendingMaintenanceActions](API_elastic_ListPendingMaintenanceActions.md) + [ListTagsForResource](API_elastic_ListTagsForResource.md) + [RestoreClusterFromSnapshot](API_elastic_RestoreClusterFromSnapshot.md) + [StartCluster](API_elastic_StartCluster.md) + [StopCluster](API_elastic_StopCluster.md) + [TagResource](API_elastic_TagResource.md) + [UntagResource](API_elastic_UntagResource.md) + [UpdateCluster](API_elastic_UpdateCluster.md) # Amazon DocumentDB (with MongoDB compatibility) Amazon DocumentDB (with MongoDB compatibility) 支持以下操作： + [AddSourceIdentifierToSubscription](API_AddSourceIdentifierToSubscription.md) + [AddTagsToResource](API_AddTagsToResource.md) + [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md) + [CopyDBClusterParameterGroup](API_CopyDBClusterParameterGroup.md) + [CopyDBClusterSnapshot](API_CopyDBClusterSnapshot.md) + [CreateDBCluster](API_CreateDBCluster.md) + [CreateDBClusterParameterGroup](API_CreateDBClusterParameterGroup.md) + [CreateDBClusterSnapshot](API_CreateDBClusterSnapshot.md) + [CreateDBInstance](API_CreateDBInstance.md) + [CreateDBSubnetGroup](API_CreateDBSubnetGroup.md) + [CreateEventSubscription](API_CreateEventSubscription.md) + [CreateGlobalCluster](API_CreateGlobalCluster.md) + [DeleteDBCluster](API_DeleteDBCluster.md) + [DeleteDBClusterParameterGroup](API_DeleteDBClusterParameterGroup.md) + [DeleteDBClusterSnapshot](API_DeleteDBClusterSnapshot.md) + [DeleteDBInstance](API_DeleteDBInstance.md) + [DeleteDBSubnetGroup](API_DeleteDBSubnetGroup.md) + [DeleteEventSubscription](API_DeleteEventSubscription.md) + [DeleteGlobalCluster](API_DeleteGlobalCluster.md) + [DescribeCertificates](API_DescribeCertificates.md) + [DescribeDBClusterParameterGroups](API_DescribeDBClusterParameterGroups.md) + [DescribeDBClusterParameters](API_DescribeDBClusterParameters.md) + [DescribeDBClusters](API_DescribeDBClusters.md) + [DescribeDBClusterSnapshotAttributes](API_DescribeDBClusterSnapshotAttributes.md) + [DescribeDBClusterSnapshots](API_DescribeDBClusterSnapshots.md) + [DescribeDBEngineVersions](API_DescribeDBEngineVersions.md) + [DescribeDBInstances](API_DescribeDBInstances.md) + [DescribeDBSubnetGroups](API_DescribeDBSubnetGroups.md) + [DescribeEngineDefaultClusterParameters](API_DescribeEngineDefaultClusterParameters.md) + [DescribeEventCategories](API_DescribeEventCategories.md) + [DescribeEvents](API_DescribeEvents.md) + [DescribeEventSubscriptions](API_DescribeEventSubscriptions.md) + [DescribeGlobalClusters](API_DescribeGlobalClusters.md) + [DescribeOrderableDBInstanceOptions](API_DescribeOrderableDBInstanceOptions.md) + [DescribePendingMaintenanceActions](API_DescribePendingMaintenanceActions.md) + [FailoverDBCluster](API_FailoverDBCluster.md) + [FailoverGlobalCluster](API_FailoverGlobalCluster.md) + [ListTagsForResource](API_ListTagsForResource.md) + [ModifyDBCluster](API_ModifyDBCluster.md) + [ModifyDBClusterParameterGroup](API_ModifyDBClusterParameterGroup.md) + [ModifyDBClusterSnapshotAttribute](API_ModifyDBClusterSnapshotAttribute.md) + [ModifyDBInstance](API_ModifyDBInstance.md) + [ModifyDBSubnetGroup](API_ModifyDBSubnetGroup.md) + [ModifyEventSubscription](API_ModifyEventSubscription.md) + [ModifyGlobalCluster](API_ModifyGlobalCluster.md) + [RebootDBInstance](API_RebootDBInstance.md) + [RemoveFromGlobalCluster](API_RemoveFromGlobalCluster.md) + [RemoveSourceIdentifierFromSubscription](API_RemoveSourceIdentifierFromSubscription.md) + [RemoveTagsFromResource](API_RemoveTagsFromResource.md) + [ResetDBClusterParameterGroup](API_ResetDBClusterParameterGroup.md) + [RestoreDBClusterFromSnapshot](API_RestoreDBClusterFromSnapshot.md) + [RestoreDBClusterToPointInTime](API_RestoreDBClusterToPointInTime.md) + [StartDBCluster](API_StartDBCluster.md) + [StopDBCluster](API_StopDBCluster.md) + [SwitchoverGlobalCluster](API_SwitchoverGlobalCluster.md) # AddSourceIdentifierToSubscription 将源标识符添加到现有事件通知订阅。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** SourceIdentifier ** 要添加的事件源的标识符： + 如果源类型是实例，则必须提供 `DBInstanceIdentifier`。 + 如果源类型是安全组，则必须提供 `DBSecurityGroupName`。 + 如果源类型是参数组，则必须提供 `DBParameterGroupName`。 + 如果源类型是快照，则必须提供 `DBSnapshotIdentifier`。 类型：字符串 是否必需：是 ** SubscriptionName ** 要将源标识符添加到的 Amazon DocumentDB 事件通知订阅的名称。 类型：字符串 是否必需：是 ## 响应元素 服务返回以下元素。 ** EventSubscription ** 有关您已订阅事件的详细信息。 类型：[EventSubscription](API_EventSubscription.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** SourceNotFound ** 找不到请求的源。 HTTP 状态代码：404 ** SubscriptionNotFound ** 订阅名称不存在。 HTTP 状态代码：404 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/AddSourceIdentifierToSubscription) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/AddSourceIdentifierToSubscription) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/AddSourceIdentifierToSubscription) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/AddSourceIdentifierToSubscription) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/AddSourceIdentifierToSubscription) + [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/AddSourceIdentifierToSubscription) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/AddSourceIdentifierToSubscription) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/AddSourceIdentifierToSubscription) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/AddSourceIdentifierToSubscription) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/AddSourceIdentifierToSubscription) # AddTagsToResource 将元数据标签添加到 Amazon DocumentDB 资源。您可以将这些标签与成本分配报告配合使用，以跟踪与亚马逊 DocumentDB 资源相关的成本，也可以在亚马逊 DocumentDB 的 AWS Identity and Access Management (IAM) 政策`Condition`声明中使用这些标签。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** ResourceName ** 将标签添加到的 Amazon DocumentDB 资源。此值是 Amazon 资源名称。 类型：字符串 是否必需：是 **Tags.Tag.N** 要分配给 Amazon DocumentDB 资源的标签。 类型：[Tag](API_Tag.md) 对象数组 是否必需：是 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBClusterNotFoundFault ** `DBClusterIdentifier` 并不引用现有集群。 HTTP 状态代码：404 ** DBInstanceNotFound ** `DBInstanceIdentifier` 并不引用现有实例。 HTTP 状态代码：404 ** DBSnapshotNotFound ** `DBSnapshotIdentifier` 并不引用指现有快照。 HTTP 状态代码：404 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/AddTagsToResource) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/AddTagsToResource) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/AddTagsToResource) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/AddTagsToResource) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/AddTagsToResource) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/AddTagsToResource) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/AddTagsToResource) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/AddTagsToResource) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/AddTagsToResource) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/AddTagsToResource) # ApplyPendingMaintenanceAction 将待处理的维护操作应用于资源（例如，应用于 Amazon DocumentDB 实例）。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** ApplyAction ** 应用于此资源的待处理的维护操作。 有效值：`system-update`、`db-upgrade` 类型：字符串 是否必需：是 ** OptInType ** 用于指定加入请求类型或撤消加入请求的值。不能撤消 `immediate` 类型的加入请求。 有效值： + `immediate`：立即应用维护操作。 + `next-maintenance`：在资源的下一个维护时段内应用维护操作。 + `undo-opt-in`：取消任何现有的 `next-maintenance` 加入请求。 类型：字符串 是否必需：是 ** ResourceIdentifier ** 待处理的维护操作应用于的资源的 Amazon 资源名称 (ARN)。 类型：字符串 是否必需：是 ## 响应元素 服务返回以下元素。 ** ResourcePendingMaintenanceActions ** 表示 [ApplyPendingMaintenanceAction](#API_ApplyPendingMaintenanceAction) 的输出。 类型：[ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** InvalidDBClusterStateFault ** 集群未处于有效状态。 HTTP 状态代码：400 ** InvalidDBInstanceState ** 指定的实例未处于*可用* 状态。 HTTP 状态代码：400 ** ResourceNotFoundFault ** 找不到指定的资源 ID。 HTTP 状态代码：404 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ApplyPendingMaintenanceAction) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ApplyPendingMaintenanceAction) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ApplyPendingMaintenanceAction) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ApplyPendingMaintenanceAction) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ApplyPendingMaintenanceAction) + [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ApplyPendingMaintenanceAction) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ApplyPendingMaintenanceAction) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ApplyPendingMaintenanceAction) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ApplyPendingMaintenanceAction) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ApplyPendingMaintenanceAction) # CopyDBClusterParameterGroup 复制指定的集群参数组。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** SourceDBClusterParameterGroupIdentifier ** 源集群参数组的标识符或 Amazon 资源名称 (ARN)。 约束： + 必须指定有效的集群参数组。 + 如果源集群参数组与副本 AWS 区域 相同，请指定有效的参数组标识符；例如`my-db-cluster-param-group`，或有效的 ARN。 + 如果源参数组与副本 AWS 区域 不同，请指定有效的集群参数组 ARN；例如。`arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group` 类型：字符串 是否必需：是 ** TargetDBClusterParameterGroupDescription ** 复制的集群参数组的描述。 类型：字符串 是否必需：是 ** TargetDBClusterParameterGroupIdentifier ** 复制的集群参数组的标识符。 约束： + 不能为 null 或空。 + 必须包含 1 到 255 个字母、数字或连字符。 + 第一个字符必须是字母。 + 不能以连字符结尾或包含两个连续的连字符。 示例：`my-cluster-param-group1` 类型：字符串 是否必需：是 **Tags.Tag.N** 要分配给参数组的标签。 类型：[Tag](API_Tag.md) 对象数组 必需：否 ## 响应元素 服务返回以下元素。 ** DBClusterParameterGroup ** 有关集群参数组的详细信息。 类型：[DBClusterParameterGroup](API_DBClusterParameterGroup.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBParameterGroupAlreadyExists ** 已存在同名的参数组。 HTTP 状态代码：400 ** DBParameterGroupNotFound ** `DBParameterGroupName` 并不引用现有的参数组。 HTTP 状态代码：404 ** DBParameterGroupQuotaExceeded ** 该请求会导致您超出允许的参数组数量。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CopyDBClusterParameterGroup) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CopyDBClusterParameterGroup) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CopyDBClusterParameterGroup) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CopyDBClusterParameterGroup) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CopyDBClusterParameterGroup) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CopyDBClusterParameterGroup) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CopyDBClusterParameterGroup) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CopyDBClusterParameterGroup) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CopyDBClusterParameterGroup) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CopyDBClusterParameterGroup) # CopyDBClusterSnapshot 复制集群的快照。 要从共享的手动集群快照复制集群快照，`SourceDBClusterSnapshotIdentifier` 必须为共享的集群快照的 Amazon 资源名称（ARN）。无论加密与否，都只能在相同 AWS 区域中复制共享的数据库集群快照。 要在正在进行复制时取消操作，请在集群快照处于*正在复制*状态时删除由 `TargetDBClusterSnapshotIdentifier` 标识的目标集群快照。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** SourceDBClusterSnapshotIdentifier ** 要复制的集群快照的标识符。此参数不区分大小写。 约束： + 必须将有效的集群快照指定为*可用* 状态。 + 如果源集群快照与副本 AWS 区域 相同，请指定有效的快照标识符。 + 如果源集群快照在其他账户中 AWS 区域 或由其他 AWS 账户拥有，请指定快照 ARN。 示例：`my-cluster-snapshot1` 类型：字符串 是否必需：是 ** TargetDBClusterSnapshotIdentifier ** 要从源集群快照创建的新集群快照标识符​。此参数不区分大小写。 约束： + 必须包含 1 到 63 个字母、数字或连字符。 + 第一个字符必须是字母。 + 不能以连字符结尾或包含两个连续的连字符。 示例：`my-cluster-snapshot2` 类型：字符串 是否必需：是 ** CopyTags ** 设置为 `true`，则将源集群快照的所有标签复制到目标集群快照；否则为 `false`。默认值为 `false`。 类型：布尔值 必需：否 ** KmsKeyId ** 加密集群快照的密 AWS KMS 钥 ID。 AWS KMS 密钥 ID 是 AWS KMS 加密密钥的 Amazon 资源名称 (ARN)、 AWS KMS 密钥标识符或 AWS KMS 密钥别名。 如果您从中复制加密的集群快照 AWS 账户，则可以为指定一个值，`KmsKeyId`以便使用新的加密密钥对副本进行 AWS KMS 加密。如果您没有为指定值`KmsKeyId`，则集群快照的副本将使用与源集群快照相同的 AWS KMS 密钥进行加密。 如果您复制与另一个群集共享的加密群集快照 AWS 账户，则必须为指定一个值`KmsKeyId`。 要将加密的集群快照复制到另一个 AWS 区域集群快照，请将其设置`KmsKeyId`为要用于加密目标区域中集群快照副本的密 AWS KMS 钥 ID。 AWS KMS 加密密钥特定于它们创建时 AWS 区域 使用的密钥，您不能使用彼此 AWS 区域 的加密密钥 AWS 区域。 如果您复制未加密的集群快照并为 `KmsKeyId` 参数指定值，则会返回错误。 类型：字符串 必需：否 ** PreSignedUrl ** 包含签名版本 4 签名的 `CopyDBClusterSnapshot` API 操作请求的 URL AWS 区域 ，其中包含要复制的源集群快照。从另一个 AWS 区域复制集群快照时，必须使用 `PreSignedUrl` 参数。 如果您使用的是 S AWS DK 工具或 AWS CLI，则可以指定`SourceRegion`（或 `--source-region` AWS CLI），而不是`PreSignedUrl`手动指定。指定 `SourceRegion` 会自动生成一个预签名 URL，它是可在源 AWS 区域中执行的操作的有效请求。 预签名 URL 必须是对 `CopyDBClusterSnapshot` API 操作的有效请求，该操作可以在 AWS 区域 包含要复制的集群快照的源中执行。预签名 URL 请求必须包含以下参数值： + `SourceRegion`：包含要复制的快照的区域的 ID。 + `SourceDBClusterSnapshotIdentifier`：要复制的加密集群快照的标识符。对于源 AWS 区域，此标识符必须采用 Amazon 资源名称（ARN）格式。例如，如果您从 us-east-1 AWS 区域复制加密集群快照，则 `SourceDBClusterSnapshotIdentifier` 应类似于下文：`arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot`。 + `TargetDBClusterSnapshotIdentifier`：要复制的新集群快照的标识符。该参数不区分大小写。 类型：字符串 必需：否 **Tags.Tag.N** 要分配给集群快照的标签。 类型：[Tag](API_Tag.md) 对象数组 必需：否 ## 响应元素 服务返回以下元素。 ** DBClusterSnapshot ** 有关集群快照的详细信息。 类型：[DBClusterSnapshot](API_DBClusterSnapshot.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBClusterSnapshotAlreadyExistsFault ** 您已经有一个带有给定标识符的集群快照。 HTTP 状态代码：400 ** DBClusterSnapshotNotFoundFault ** `DBClusterSnapshotIdentifier` 并不引用现有集群快照。 HTTP 状态代码：404 ** InvalidDBClusterSnapshotStateFault ** 提供的值不是有效的集群快照状态。 HTTP 状态代码：400 ** InvalidDBClusterStateFault ** 集群未处于有效状态。 HTTP 状态代码：400 ** KMSKeyNotAccessibleFault ** 访问 AWS KMS 密钥时出错。 HTTP 状态代码：400 ** SnapshotQuotaExceeded ** 该请求会导致您超过允许的快照数目。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CopyDBClusterSnapshot) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CopyDBClusterSnapshot) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CopyDBClusterSnapshot) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CopyDBClusterSnapshot) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CopyDBClusterSnapshot) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CopyDBClusterSnapshot) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CopyDBClusterSnapshot) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CopyDBClusterSnapshot) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CopyDBClusterSnapshot) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CopyDBClusterSnapshot) # CreateDBCluster 创建新的 Amazon DocumentDB 集群。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBClusterIdentifier ** 集群标识符。该参数作为一个小写字符串存储。 约束： + 必须包含 1 到 63 个字母、数字或连字符。 + 第一个字符必须是字母。 + 不能以连字符结尾或包含两个连续的连字符。 示例：`my-cluster` 类型：字符串 是否必需：是 ** Engine ** 用于此集群的数据库引擎的名称。 有效值：`docdb` 类型：字符串 是否必需：是 **AvailabilityZones。 AvailabilityZone.N** 可在其中创建集群中的实例的 Amazon EC2 可用区的列表。 类型：字符串数组 必需：否 ** BackupRetentionPeriod ** 自动备份的保留天数。您必须指定最小值 1。 默认：1 约束： + 必须为介于 1 和 35 之间的值。 类型：整数 必需：否 ** DBClusterParameterGroupName ** 要与此集群关联的集群参数组的名称。 类型：字符串 必需：否 ** DBSubnetGroupName ** 要与此集群关联的子网组。 约束：必须与现有 `DBSubnetGroup` 的名称匹配。不能是默认值。 示例：`mySubnetgroup` 类型：字符串 必需：否 ** DeletionProtection ** 指定是否可以删除此集群。如果 `DeletionProtection` 启用，则无法删除集群，除非集群经修改并 `DeletionProtection` 禁用。`DeletionProtection` 防止意外删除集群。 类型：布尔值 必需：否 **EnableCloudwatchLogsExports.member.n** 需要启用才能导出到 Amazon CloudWatch 日志的日志类型列表。您可以启用审核日志或分析器日志。有关更多信息，请参阅[审核 Amazon DocumentDB 事件](https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html)和[分析 Amazon DocumentDB 操作](https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html)。 类型：字符串数组 必需：否 ** EngineVersion ** 要使用的数据库引擎的版本号。`--engine-version` 将默认为最新的主引擎版本。对于生产工作负载，我们建议使用预期的主引擎版本明确声明此参数。 类型：字符串 必需：否 ** GlobalClusterIdentifier ** 新全局集群的集群标识符。 类型：字符串 长度限制：最小长度为 1。最大长度为 255。 模式：`[A-Za-z][0-9A-Za-z-:._]*` 必需：否 ** KmsKeyId ** 加密集群的 AWS KMS 密钥标识符。 AWS KMS 密钥标识符是 AWS KMS 加密密钥的 Amazon 资源名称 (ARN)。如果您使用拥有用于加密新集群的 AWS KMS 加密密钥的集群创建集群，则可以使用 AWS KMS 密钥别名代替 ARN 作为 AWS KMS 加密密钥。 AWS 账户 未在 `KmsKeyId` 中指定加密密钥时： + 如果 `StorageEncrypted` 参数为 `true`，则 Amazon DocumentDB 将使用您的默认加密密钥。 AWS KMS 为您创建默认加密密钥 AWS 账户。每个 AWS 账户 都有不同的默认加密密钥 AWS 区域。 类型：字符串 必需：否 ** ManageMasterUserPassword ** 指示是否使用 Amazon Web Services Secrets Manager 管理主用户密码。 约束：如果已指定 `MasterUserPassword`，则无法使用 Amazon Web Services Secrets Manager 管理主用户密码。 类型：布尔值 必需：否 ** MasterUsername ** 集群的主用户名称。 约束： + 必须为 1 到 63 个字母或数字。 + 第一个字符必须是字母。 + 不能是所选数据库引擎的保留字。 类型：字符串 必需：否 ** MasterUserPassword ** 主数据库用户的密码。此密码可以包含除正斜杠 (/)、双引号 (") 或 @ 符号之外的任何可打印的 ASCII 字符。 约束：必须包含 8 到 100 个字符。 类型：字符串 必需：否 ** MasterUserSecretKmsKeyId ** Amazon Web Services KMS 密钥标识符，用于加密在 Amazon Web Services Secrets Manager 中自动生成和管理的密钥。仅当主用户密码由 Amazon DocumentDB 在数据库集群的 Amazon Web Services Secrets Manager 中进行管理时，此设置才有效。 Amazon Web Services KMS 密钥标识符是密钥 ARN、密钥 ID、别名 ARN 或者 KMS 密钥的别名。要使用不同 Amazon Web Services 中的 KMS 密钥，请指定密钥 ARN 或别名 ARN。 如果您未指定 `MasterUserSecretKmsKeyId`，则使用 `aws/secretsmanager` KMS 密钥对密钥进行加密。如果密钥位于不同的 Amazon Web Services 账户中，则无法使用 `aws/secretsmanager` KMS 密钥来对其进行加密，必须使用客户管理的 KMS 密钥。 您的 Amazon Web Services 账户有默认 KMS 密钥。您的 Amazon Web Services 账户对每个 Amazon Web Services 区域具有不同的默认 KMS 密钥。 类型：字符串 必需：否 ** NetworkType ** 集群的网络类型。 网络类型由为集群指定的 `DBSubnetGroup` 确定。A `DBSubnetGroup` 只能支持 IPv4 协议或 IPv4 和 IPv6 协议 (`DUAL`)。 有关更多信息，请参阅《Amazon DocumentDB 开发人员指南》中 [VPC 中的 DocumentDB 集群](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html)。 有效值：`IPV4` \$1 `DUAL` 类型：字符串 必需：否 ** Port ** 集群中实例接受连接的端口号。 类型：整数 必需：否 ** PreferredBackupWindow ** 使用 `BackupRetentionPeriod` 参数启用了自动备份时，自动执行备份的日常时间范围。 默认值是从 8 小时的时间段中随机选择一个 30 分钟的窗口。 AWS 区域 约束： + 必须采用 `hh24:mi-hh24:mi` 格式。 + 必须采用通用协调时间（UTC）。 + 不得与首选维护时段冲突。 + 必须至少为 30 分钟。 类型：字符串 必需：否 ** PreferredMaintenanceWindow ** 可进行系统维护的每周时间范围（采用通用协调时间（UTC））。 格式：`ddd:hh24:mi-ddd:hh24:mi` 默认值是从 8 小时的时间段中随机选择一个 30 分钟的窗口 AWS 区域，出现在一周中的随机某一天。 有效日：Mon、Tue、Wed、Thu、Fri、Sat、Sun 约束：至少为 30 分钟的时段。 类型：字符串 必需：否 ** PreSignedUrl ** 当前不支持。 类型：字符串 必需：否 ** ServerlessV2ScalingConfiguration ** 包含 Amazon DocumentDB 无服务器集群的扩缩配置。 类型：[ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) 对象 必需：否 ** StorageEncrypted ** 指定集群是否已加密。 类型：布尔值 必需：否 ** StorageType ** 与数据库集群关联的存储类型。 有关 Amazon DocumentDB 集群存储类型的信息，请参阅*《Amazon DocumentDB 开发人员指南》*中的集群存储配置。 存储类型的有效值：`standard | iopt1` 默认值为 `standard ` 创建存储类型设置为 `iopt1` 的 Amazon DocumentDB 集群时，响应中会返回存储类型。将存储类型设置为 `standard` 时不会返回该存储类型。 类型：字符串 必需：否 **Tags.Tag.N** 要分配给集群的标签。 类型：[Tag](API_Tag.md) 对象数组 必需：否 **VpcSecurityGroupIds。 VpcSecurityGroupId.N** 要与此集群关联的 EC2 VPC 安全组的列表。 类型：字符串数组 必需：否 ## 响应元素 服务返回以下元素。 ** DBCluster ** 有关集群的详细信息。 类型：[DBCluster](API_DBCluster.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBClusterAlreadyExistsFault ** 用户已拥有具有给定标识符的集群。 HTTP 状态代码：400 ** DBClusterNotFoundFault ** `DBClusterIdentifier` 并不引用现有集群。 HTTP 状态代码：404 ** DBClusterParameterGroupNotFound ** `DBClusterParameterGroupName` 并不引用现有集群参数组。 HTTP 状态代码：404 ** DBClusterQuotaExceededFault ** 无法创建集群，因为您已达到允许的集群最大配额。 HTTP 状态代码：403 ** DBInstanceNotFound ** `DBInstanceIdentifier` 并不引用现有实例。 HTTP 状态代码：404 ** DBSubnetGroupDoesNotCoverEnoughAZs ** 除非只有一个可用区，否则子网组中的子网应至少包含两个可用区。 HTTP 状态代码：400 ** DBSubnetGroupNotFoundFault ** `DBSubnetGroupName` 并不引用现有子网组。 HTTP 状态代码：404 ** GlobalClusterNotFoundFault ** `GlobalClusterIdentifier` 并不引用现有全局集群。 HTTP 状态代码：404 ** InsufficientStorageClusterCapacity ** 当前操作没有足够的可用存储空间。通过更新子网组来使用具有更多可用存储空间的不同可用区，可以解决此错误。 HTTP 状态代码：400 ** InvalidDBClusterStateFault ** 集群未处于有效状态。 HTTP 状态代码：400 ** InvalidDBInstanceState ** 指定的实例未处于*可用* 状态。 HTTP 状态代码：400 ** InvalidDBSubnetGroupStateFault ** 无法删除子网组，因为它正在使用中。 HTTP 状态代码：400 ** InvalidGlobalClusterStateFault ** 当集群处于这种状态时，无法执行请求的操作。 HTTP 状态代码：400 ** InvalidSubnet ** 请求的子网无效，或者请求的多个子网并非全部位于同一个常见虚拟私有云（VPC）中。 HTTP 状态代码：400 ** InvalidVPCNetworkStateFault ** 由于所做的更改，子网组在创建后并不会覆盖所有可用区。 HTTP 状态代码：400 ** KMSKeyNotAccessibleFault ** 访问 AWS KMS 密钥时出错。 HTTP 状态代码：400 ** NetworkTypeNotSupported ** `DBSubnetGroup` 或数据库引擎版本不支持该网络类型。 HTTP 状态代码：400 ** StorageQuotaExceeded ** 该请求会导致您超出跨所有实例可提供的已允许存储量。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBCluster) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBCluster) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBCluster) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBCluster) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBCluster) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBCluster) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBCluster) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBCluster) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBCluster) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBCluster) # CreateDBClusterParameterGroup 创建新的集群参数组。 集群参数组中的参数应用到集群中的所有实例。 最初创建集群参数组时，使用的是集群中实例所用数据库引擎的默认参数。在 Amazon DocumentDB 中，您无法直接对 `default.docdb3.6` 集群参数组进行修改。如果您的 Amazon DocumentDB 集群正使用默认集群参数组，而您想要修改其中的值，则您必须首先[创建新的参数组](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-create.html)或[复制现有参数组](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-copy.html)，修改它，然后将修改的参数组应用于您的集群。要使新集群参数组和关联设置生效，您必须重新启动集群中的实例，而不进行失效转移。有关更多信息，请参阅[修改 Amazon DocumentDB 集群参数组](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-modify.html)。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBClusterParameterGroupName ** 集群参数组的名称。 约束： + 不能与现有 `DBClusterParameterGroup` 的名称匹配。 此值以一个小写字符串存储。 类型：字符串 是否必需：是 ** DBParameterGroupFamily ** 集群参数组系列名称。 类型：字符串 是否必需：是 ** Description ** 集群参数组的描述。 类型：字符串 是否必需：是 **Tags.Tag.N** 要分配给集群参数组的标签。 类型：[Tag](API_Tag.md) 对象数组 必需：否 ## 响应元素 服务返回以下元素。 ** DBClusterParameterGroup ** 有关集群参数组的详细信息。 类型：[DBClusterParameterGroup](API_DBClusterParameterGroup.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBParameterGroupAlreadyExists ** 已存在同名的参数组。 HTTP 状态代码：400 ** DBParameterGroupQuotaExceeded ** 此请求将导致您超出允许的参数组数量。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBClusterParameterGroup) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBClusterParameterGroup) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBClusterParameterGroup) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBClusterParameterGroup) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBClusterParameterGroup) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBClusterParameterGroup) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBClusterParameterGroup) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBClusterParameterGroup) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBClusterParameterGroup) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBClusterParameterGroup) # CreateDBClusterSnapshot 创建集群的快照。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBClusterIdentifier ** 要为其创建快照的集群的标识符。此参数不区分大小写。 约束： + 必须与现有 `DBCluster` 的标识符匹配。 示例：`my-cluster` 类型：字符串 是否必需：是 ** DBClusterSnapshotIdentifier ** 集群快照的标识符。该参数作为一个小写字符串存储。 约束： + 必须包含 1 到 63 个字母、数字或连字符。 + 第一个字符必须是字母。 + 不能以连字符结尾或包含两个连续的连字符。 示例：`my-cluster-snapshot1` 类型：字符串 是否必需：是 **Tags.Tag.N** 要分配给集群快照的标签。 类型：[Tag](API_Tag.md) 对象数组 必需：否 ## 响应元素 服务返回以下元素。 ** DBClusterSnapshot ** 有关集群快照的详细信息。 类型：[DBClusterSnapshot](API_DBClusterSnapshot.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBClusterNotFoundFault ** `DBClusterIdentifier` 并不引用现有集群。 HTTP 状态代码：404 ** DBClusterSnapshotAlreadyExistsFault ** 您已拥有具有给定标识符的集群快照。 HTTP 状态代码：400 ** InvalidDBClusterSnapshotStateFault ** 提供的值不是有效的集群快照状态。 HTTP 状态代码：400 ** InvalidDBClusterStateFault ** 集群未处于有效状态。 HTTP 状态代码：400 ** SnapshotQuotaExceeded ** 该请求会导致您超过允许的快照数目。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBClusterSnapshot) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBClusterSnapshot) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBClusterSnapshot) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBClusterSnapshot) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBClusterSnapshot) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBClusterSnapshot) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBClusterSnapshot) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBClusterSnapshot) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBClusterSnapshot) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBClusterSnapshot) # CreateDBInstance 创建新的实例。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBClusterIdentifier ** 实例所属的集群的标识符。 类型：字符串 是否必需：是 ** DBInstanceClass ** 实例的计算和内存容量；例如，`db.r5.large`。 类型：字符串 是否必需：是 ** DBInstanceIdentifier ** 实例标识符。该参数作为一个小写字符串存储。 约束： + 必须包含 1 到 63 个字母、数字或连字符。 + 第一个字符必须是字母。 + 不能以连字符结尾或包含两个连续的连字符。 示例：`mydbinstance` 类型：字符串 是否必需：是 ** Engine ** 要用于此实例的数据库引擎的名称。 有效值：`docdb` 类型：字符串 是否必需：是 ** AutoMinorVersionUpgrade ** 此参数不适用于 Amazon DocumentDB。无论设置的值如何，Amazon DocumentDB 都不会执行次要版本升级。 默认值：`false` 类型：布尔值 必需：否 ** AvailabilityZone ** 在其中创建了实例的 Amazon EC2 可用区。 默认：终端节点中随机由系统选择的 AWS 区域可用区。 示例：`us-east-1d` 类型：字符串 必需：否 ** CACertificateIdentifier ** 用于数据库实例服务器证书的 CA 证书标识符。 有关更多信息，请参阅 *Amazon DocumentDB 开发人员指南*中更新您的 [Amazon DocumentDB TLS 证书](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html)和[加密传输中数据](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html)。 类型：字符串 必需：否 ** CopyTagsToSnapshot ** 指示是否将标签从数据库实例复制到数据库实例快照的值。默认情况下，不复制标签。 类型：布尔值 必需：否 ** EnablePerformanceInsights ** 指示是否为数据库实例启用 Performance Insights 的值。有关更多信息，请参阅[使用 Amazon Performance Insights](https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html)。 类型：布尔值 必需：否 ** PerformanceInsightsKMSKeyId ** Performance Insights 数据加密的密 AWS KMS 钥标识符。 AWS KMS 密钥标识符是 KMS 密钥的密钥 ARN、密钥 ID、别名 ARN 或 KMS 密钥的别名。 如果您没有为 PerformanceInsights KMSKey ID 指定值，则亚马逊文档数据库将使用您的默认 KMS 密钥。您的 Amazon Web Services 账户有默认 KMS 密钥。您的 Amazon 网络服务账户对每个 Amazon 网络服务区具有不同的默认 KMS 密钥。 类型：字符串 必需：否 ** PreferredMaintenanceWindow ** 每周可以进行系统维护的时间范围（采用通用协调时间 (UTC)）。 格式：`ddd:hh24:mi-ddd:hh24:mi` 默认值是从 8 小时的时间段中随机选择一个 30 分钟的窗口 AWS 区域，出现在一周中的随机某一天。 有效日：Mon、Tue、Wed、Thu、Fri、Sat、Sun 约束：至少为 30 分钟的时段。 类型：字符串 必需：否 ** PromotionTier ** 该值指定在现有主实例发生故障后将 Amazon DocumentDB 副本提升为主实例的顺序。 默认：1 有效值：0-15 类型：整数 必需：否 **Tags.Tag.N** 要分配给实例的标签。您可以为每个实例分配最多 10 个标签。 类型：[Tag](API_Tag.md) 对象数组 必需：否 ## 响应元素 服务返回以下元素。 ** DBInstance ** 有关实例的详细信息。 类型：[DBInstance](API_DBInstance.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** AuthorizationNotFound ** 已指定的 CIDR IP 或 Amazon EC2 安全组未获得指定的安全组的授权。 Amazon DocumentDB 也可能未授权代表您使用 IAM 执行必需操作。 HTTP 状态代码：404 ** DBClusterNotFoundFault ** `DBClusterIdentifier` 并不引用现有集群。 HTTP 状态代码：404 ** DBInstanceAlreadyExists ** 您已经有一个带有给定标识符的实例。 HTTP 状态代码：400 ** DBParameterGroupNotFound ** `DBParameterGroupName` 并不引用现有的参数组。 HTTP 状态代码：404 ** DBSecurityGroupNotFound ** `DBSecurityGroupName` 并不引用现有安全组。 HTTP 状态代码：404 ** DBSubnetGroupDoesNotCoverEnoughAZs ** 除非只有一个可用区，否则子网组中的子网应至少包含两个可用区。 HTTP 状态代码：400 ** DBSubnetGroupNotFoundFault ** `DBSubnetGroupName` 并不引用现有子网组。 HTTP 状态代码：404 ** InstanceQuotaExceeded ** 该请求会导致您超出允许的实例数量。 HTTP 状态代码：400 ** InsufficientDBInstanceCapacity ** 指定的实例类别在指定的可用区中不可用。 HTTP 状态代码：400 ** InvalidDBClusterStateFault ** 集群未处于有效状态。 HTTP 状态代码：400 ** InvalidSubnet ** 请求的子网无效，或者请求的多个子网并非全部位于同一个常见虚拟私有云（VPC）中。 HTTP 状态代码：400 ** InvalidVPCNetworkStateFault ** 由于所做的更改，子网组在创建后并不会覆盖所有可用区。 HTTP 状态代码：400 ** KMSKeyNotAccessibleFault ** 访问 AWS KMS 密钥时出错。 HTTP 状态代码：400 ** StorageQuotaExceeded ** 该请求会导致您超出跨所有实例可提供的已允许存储量。 HTTP 状态代码：400 ** StorageTypeNotSupported ** 指定的 `StorageType` 存储无法与数据库实例关联。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBInstance) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBInstance) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBInstance) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBInstance) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBInstance) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBInstance) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBInstance) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBInstance) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBInstance) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBInstance) # CreateDBSubnetGroup 创建一个新子网组。子网组必须至少包含 AWS 区域中至少两个可用区的一个子网。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBSubnetGroupDescription ** 子网组的描述。 类型：字符串 是否必需：是 ** DBSubnetGroupName ** 子网组的名称。此值以一个小写字符串存储。 约束：必须包含不超过 255 个字母、数字、句点、下划线、空格或连字符。不能是默认值。 示例：`mySubnetgroup` 类型：字符串 是否必需：是 **SubnetIds。 SubnetIdentifier.N** 子网 IDs 组的 Amazon EC2 子网。 类型：字符串数组 是否必需：是 **Tags.Tag.N** 要分配给子网组的标签。 类型：[Tag](API_Tag.md) 对象数组 必需：否 ## 响应元素 服务返回以下元素。 ** DBSubnetGroup ** 有关子网组的详细信息。 类型：[DBSubnetGroup](API_DBSubnetGroup.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBSubnetGroupAlreadyExists ** `DBSubnetGroupName` 已被现有子网组使用。 HTTP 状态代码：400 ** DBSubnetGroupDoesNotCoverEnoughAZs ** 除非只有一个可用区，否则子网组中的子网应至少包含两个可用区。 HTTP 状态代码：400 ** DBSubnetGroupQuotaExceeded ** 该请求会导致您超出允许的子网组数量。 HTTP 状态代码：400 ** DBSubnetQuotaExceededFault ** 该请求会导致用户超过子网组中允许的子网数。 HTTP 状态代码：400 ** InvalidSubnet ** 请求的子网无效，或者请求的多个子网并非全部位于同一个常见虚拟私有云（VPC）中。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBSubnetGroup) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBSubnetGroup) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBSubnetGroup) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBSubnetGroup) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBSubnetGroup) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBSubnetGroup) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBSubnetGroup) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBSubnetGroup) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBSubnetGroup) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBSubnetGroup) # CreateEventSubscription 创建 Amazon DocumentDB 事件通知订阅 此操作需要一个通过 Amazon DocumentDB 控制台、Amazon SNS 控制台或 Amazon SNS API 创建的主题 Amazon 资源名称（ARN）。要使用 Amazon SNS 获取 ARN，您必须在 Amazon SNS 中创建主题并订阅该主题。ARN 显示在 Amazon SNS 控制台中。 您可以指定希望收取其通知的源（`SourceType`）类型。您还可以提供触发事件的 Amazon DocumentDB 源 (`SourceIds`) 列表，以及为您要收到通知的事件提供事件类别列表 (`EventCategories`)。例如，您可以指定 `SourceType = db-instance`, `SourceIds = mydbinstance1, mydbinstance2` 和 `EventCategories = Availability, Backup`。 如果您同时指定 `SourceType` 和 `SourceIds`（如 `SourceType = db-instance` 和 `SourceIdentifier = myDBInstance1`），就会收到指定源的所有 `db-instance` 事件。如果指定 `SourceType`，但未指定 `SourceIdentifier`，则将收到所有 Amazon DocumentDB 源的该源类型的事件的通知。如果您未指定 `SourceType` 或 `SourceIdentifier`，则会收到属于您的客户账户的所有 Amazon DocumentDB 源所生成事件的通知。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** SnsTopicArn ** 为事件通知创建的 SNS 主题的 Amazon 资源名称（ARN）。在您创建主题并订阅到该主题时，Amazon SNS 会创建 ARN。 类型：字符串 是否必需：是 ** SubscriptionName ** 订阅的名称。 约束：名称必须少于 255 个字符。 类型：字符串 是否必需：是 ** Enabled ** 一个布尔值；设置为 `true` 可激活订阅，设置为 `false` 可创建订阅但不激活它。 类型：布尔值 必需：否 **EventCategories。 EventCategory.N** 您想要订阅到的 `SourceType` 的事件类别列表。 类型：字符串数组 必需：否 **SourceIds。 SourceId.N** 为其返回事件的事件源的标识符列表。如果未指定，则响应中包含所有源。标识符必须以字母开头，并且只能包含 ASCII 字母、数字和连字符，不能以连字符结尾，也不能包含两个连续的连字符。 约束： + 如果提供了 `SourceIds`，则必须提供 `SourceType`。 + 如果源类型是实例，则必须提供 `DBInstanceIdentifier`。 + 如果源类型是安全组，则必须提供 `DBSecurityGroupName`。 + 如果源类型是参数组，则必须提供 `DBParameterGroupName`。 + 如果源类型是快照，则必须提供 `DBSnapshotIdentifier`。 类型：字符串数组 必需：否 ** SourceType ** 生成事件的源的类型。例如，如果您希望收到关于实例生成的事件的通知，将此参数设置为 `db-instance`。如果未指定该值，则将返回所有事件。 有效值：`db-instance`，`db-cluster`，`db-parameter-group`，`db-security-group`，`db-cluster-snapshot` 类型：字符串 必需：否 **Tags.Tag.N** 要分配给事件订阅的标签。 类型：[Tag](API_Tag.md) 对象数组 必需：否 ## 响应元素 服务返回以下元素。 ** EventSubscription ** 有关您已订阅事件的详细信息。 类型：[EventSubscription](API_EventSubscription.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** EventSubscriptionQuotaExceeded ** 您已达到事件订阅的最大数目。 HTTP 状态代码：400 ** SNSInvalidTopic ** Amazon SNS 已回复，指定的主题存在问题。 HTTP 状态代码：400 ** SNSNoAuthorization ** 您没有发布到 SNS 主题的 Amazon 资源名称（ARN）上的权限。 HTTP 状态代码：400 ** SNSTopicArnNotFound ** SNS 主题的 Amazon 资源名称（ARN）不存在。 HTTP 状态代码：404 ** SourceNotFound ** 找不到请求的源。 HTTP 状态代码：404 ** SubscriptionAlreadyExist ** 提供的订阅名称已经存在。 HTTP 状态代码：400 ** SubscriptionCategoryNotFound ** 提供的类别不存在。 HTTP 状态代码：404 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateEventSubscription) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateEventSubscription) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateEventSubscription) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateEventSubscription) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateEventSubscription) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateEventSubscription) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateEventSubscription) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateEventSubscription) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateEventSubscription) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateEventSubscription) # CreateGlobalCluster 创建可以跨多个 AWS 区域的 Amazon DocumentDB 全局集群。该全局集群包含一个具有读写能力的主集群以及最多 10 个只读辅助集群。全球集群使用基于存储的跨区域快速复制，延迟小于一秒，使用专用基础设施，不影响您的工作负载性能。 您可以创建最初为空的全局集群，然后向其中添加主集群和辅助集群。或者，您可以在创建操作期间指定现有集群，而这个集群将成为全局群集的主集群。 **注意** 该操作仅适用于 Amazon DocumentDB 集群。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** GlobalClusterIdentifier ** 新全局集群的集群标识符。 类型：字符串 长度限制：最小长度为 1。最大长度为 255。 模式：`[A-Za-z][0-9A-Za-z-:._]*` 是否必需：是 ** DatabaseName ** 数据库的名称，最多 64 个字母和数字字符。如果您不提供名称，Amazon DocumentDB 就不会在您正在创建的全局集群中创建数据库。 类型：字符串 必需：否 ** DeletionProtection ** 新全局集群的删除保护设置。在启用删除保护时，无法删除全局集群。 类型：布尔值 必需：否 ** Engine ** 用于此集群的数据库引擎的名称。 类型：字符串 必需：否 ** EngineVersion ** 全局集群的引擎版本。 类型：字符串 必需：否 ** SourceDBClusterIdentifier ** 要用作全局集群的主集群的 Amazon 资源名称（ARN）。此参数为可选的。 类型：字符串 必需：否 ** StorageEncrypted ** 新全局集群的存储加密设置。 类型：布尔值 必需：否 ## 响应元素 服务返回以下元素。 ** GlobalCluster ** 一种表示 Amazon DocumentDB 全球集群的数据类型。 类型：[GlobalCluster](API_GlobalCluster.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBClusterNotFoundFault ** `DBClusterIdentifier` 并不引用现有集群。 HTTP 状态代码：404 ** GlobalClusterAlreadyExistsFault ** `GlobalClusterIdentifier` 已经存在。选择一个新的全局群集标识符（唯一名称）创建新的全局群集。 HTTP 状态代码：400 ** GlobalClusterQuotaExceededFault ** 该账户的全局集群数目已处于允许的最大值。 HTTP 状态代码：400 ** InvalidDBClusterStateFault ** 集群未处于有效状态。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateGlobalCluster) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateGlobalCluster) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateGlobalCluster) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateGlobalCluster) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateGlobalCluster) + [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateGlobalCluster) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateGlobalCluster) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateGlobalCluster) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateGlobalCluster) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateGlobalCluster) # DeleteDBCluster 删除之前预置的集群。在您删除集群时，会删除该集群的所有自动备份，且无法恢复。系统不会删除指定集群的手动数据库集群快照。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBClusterIdentifier ** 要删除集群的集群标识符。该参数不区分大小写。 约束： + 必须匹配现有 `DBClusterIdentifier`。 类型：字符串 是否必需：是 ** FinalDBSnapshotIdentifier ** `SkipFinalSnapshot` 设置为 `false` 时，新创建集群快照的集群快照标识符。 指定此参数并且将 `SkipFinalShapshot` 参数设置为 `true` 会导致错误。 约束： + 必须为从 1 到 255 个字母、数字或连字符。 + 第一个字符必须是字母。 + 不能以连字符结尾或包含两个连续的连字符。 类型：字符串 必需：否 ** SkipFinalSnapshot ** 确定删除集群之前是否创建最终集群快照。如果指定 `true`，则不创建集群快照。如果指定 `false`，则删除数据库集群之前创建一个集群快照。 如果 `SkipFinalSnapshot` 为 `false`，则必须指定 `FinalDBSnapshotIdentifier` 参数。 默认值：`false` 类型：布尔值 必需：否 ## 响应元素 服务返回以下元素。 ** DBCluster ** 有关集群的详细信息。 类型：[DBCluster](API_DBCluster.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBClusterNotFoundFault ** `DBClusterIdentifier` 并不引用现有集群。 HTTP 状态代码：404 ** DBClusterSnapshotAlreadyExistsFault ** 您已拥有具有给定标识符的集群快照。 HTTP 状态代码：400 ** InvalidDBClusterSnapshotStateFault ** 提供的值不是有效的集群快照状态。 HTTP 状态代码：400 ** InvalidDBClusterStateFault ** 集群未处于有效状态。 HTTP 状态代码：400 ** SnapshotQuotaExceeded ** 该请求会导致您超过允许的快照数目。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBCluster) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBCluster) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBCluster) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBCluster) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBCluster) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBCluster) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBCluster) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBCluster) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBCluster) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBCluster) # DeleteDBClusterParameterGroup 删除指定的集群参数组。要添加的集群参数组不能与任何集群关联。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBClusterParameterGroupName ** 集群参数组的名称。 约束： + 必须是现有集群参数组的名称。 + 您无法删除默认的集群参数组。 + 不能与任何集群关联。 类型：字符串 是否必需：是 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBParameterGroupNotFound ** `DBParameterGroupName` 并不引用现有的参数组。 HTTP 状态代码：404 ** InvalidDBParameterGroupState ** 参数组正在使用中或处于无效状态。如果您尝试删除参数组，则在参数组处于此状态时无法将其删除。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBClusterParameterGroup) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBClusterParameterGroup) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBClusterParameterGroup) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBClusterParameterGroup) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBClusterParameterGroup) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBClusterParameterGroup) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBClusterParameterGroup) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBClusterParameterGroup) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBClusterParameterGroup) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBClusterParameterGroup) # DeleteDBClusterSnapshot 删除集群快照。如果正在复制快照，则复制操作将会终止。 **注意** 只有处于 `available` 状态的集群快照才能删除。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBClusterSnapshotIdentifier ** 要删除的集群快照的标识符。 约束：必须为处于 `available` 状态的现有集群快照的名称。 类型：字符串 是否必需：是 ## 响应元素 服务返回以下元素。 ** DBClusterSnapshot ** 有关集群快照的详细信息。 类型：[DBClusterSnapshot](API_DBClusterSnapshot.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBClusterSnapshotNotFoundFault ** `DBClusterSnapshotIdentifier` 并不引用现有集群快照。 HTTP 状态代码：404 ** InvalidDBClusterSnapshotStateFault ** 提供的值不是有效的集群快照状态。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBClusterSnapshot) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBClusterSnapshot) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBClusterSnapshot) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBClusterSnapshot) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBClusterSnapshot) + [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBClusterSnapshot) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBClusterSnapshot) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBClusterSnapshot) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBClusterSnapshot) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBClusterSnapshot) # DeleteDBInstance 删除之前预配置的实例。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBInstanceIdentifier ** 要删除实例的实例标识符。该参数不区分大小写。 约束： + 必须与现有实例的名称匹配。 类型：字符串 是否必需：是 ## 响应元素 服务返回以下元素。 ** DBInstance ** 有关实例的详细信息。 类型：[DBInstance](API_DBInstance.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBInstanceNotFound ** `DBInstanceIdentifier` 并不引用现有实例。 HTTP 状态代码：404 ** DBSnapshotAlreadyExists ** `DBSnapshotIdentifier` 已为现有快照所用。 HTTP 状态代码：400 ** InvalidDBClusterStateFault ** 集群未处于有效状态。 HTTP 状态代码：400 ** InvalidDBInstanceState ** 指定的实例未处于*可用* 状态。 HTTP 状态代码：400 ** SnapshotQuotaExceeded ** 该请求会导致您超过允许的快照数目。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBInstance) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBInstance) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBInstance) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBInstance) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBInstance) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBInstance) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBInstance) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBInstance) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBInstance) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBInstance) # DeleteDBSubnetGroup 删除子网组。 **注意** 指定的数据库子网组不得与任何数据库实例关联。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBSubnetGroupName ** 要删除的数据库子网组的名称。 您不能删除默认子网组。 约束： 必须与现有 `DBSubnetGroup` 的名称匹配。不能是默认值。 示例：`mySubnetgroup` 类型：字符串 是否必需：是 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBSubnetGroupNotFoundFault ** `DBSubnetGroupName` 并不引用现有子网组。 HTTP 状态代码：404 ** InvalidDBSubnetGroupStateFault ** 无法删除子网组，因为它正在使用中。 HTTP 状态代码：400 ** InvalidDBSubnetStateFault ** 子网未处于*可用* 状态。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBSubnetGroup) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBSubnetGroup) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBSubnetGroup) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBSubnetGroup) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBSubnetGroup) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBSubnetGroup) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBSubnetGroup) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBSubnetGroup) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBSubnetGroup) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBSubnetGroup) # DeleteEventSubscription 删除 Amazon DocumentDB 事件通知订阅 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** SubscriptionName ** 您要删除的 Amazon DocumentDB 事件通知订阅的名称。 类型：字符串 是否必需：是 ## 响应元素 服务返回以下元素。 ** EventSubscription ** 有关您已订阅事件的详细信息。 类型：[EventSubscription](API_EventSubscription.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** InvalidEventSubscriptionState ** 其他人可能正在修改订阅。请等待几秒钟，然后重试。 HTTP 状态代码：400 ** SubscriptionNotFound ** 订阅名称不存在。 HTTP 状态代码：404 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteEventSubscription) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteEventSubscription) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteEventSubscription) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteEventSubscription) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteEventSubscription) + [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteEventSubscription) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteEventSubscription) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteEventSubscription) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteEventSubscription) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteEventSubscription) # DeleteGlobalCluster 删除全局集群。在尝试删除全局集群之前，必须已分离或删除主集群和辅助集群。 **注意** 此操作仅适用于 Amazon DocumentDB 集群。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** GlobalClusterIdentifier ** 正在删除的全局集群的集群标识符。 类型：字符串 长度限制：最小长度为 1。最大长度为 255。 模式：`[A-Za-z][0-9A-Za-z-:._]*` 是否必需：是 ## 响应元素 服务返回以下元素。 ** GlobalCluster ** 一种表示 Amazon DocumentDB 全球集群的数据类型。 类型：[GlobalCluster](API_GlobalCluster.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** GlobalClusterNotFoundFault ** `GlobalClusterIdentifier` 并不引用现有全局集群。 HTTP 状态代码：404 ** InvalidGlobalClusterStateFault ** 当集群处于这种状态时，无法执行请求的操作。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteGlobalCluster) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteGlobalCluster) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteGlobalCluster) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteGlobalCluster) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteGlobalCluster) + [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteGlobalCluster) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteGlobalCluster) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteGlobalCluster) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteGlobalCluster) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteGlobalCluster) # DescribeCertificates 返回 Amazon DocumentDB 为此 AWS 账户提供的证书颁发机构 (CA) 证书的列表。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** CertificateIdentifier ** 用户提供的证书标识符。如果指定此参数，则仅返回指定证书的信息。如果省略此参数，则返回最多 `MaxRecords` 个证书的列表。此参数不区分大小写。 约束 + 必须匹配现有 `CertificateIdentifier`。 类型：字符串 必需：否 **Filters.Filter.N** 当前不支持此参数。 类型：[Filter](API_Filter.md) 对象数组 必需：否 ** Marker ** 由之前的 `DescribeCertificates` 请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。 类型：字符串 必需：否 ** MaxRecords ** 包括在响应中的最大记录数。如果存在的记录数超过了指定的`MaxRecords` 值，则在响应中包含称为标记的分页记号，以便检索剩余的结果。 默认值：100 约束： + 最小值：20 + 最大值：100 类型：整数 必需：否 ## 响应元素 服务返回以下元素。 **Certificates.Certificate.N** 此 AWS 账户的证书列表。 类型：[Certificate](API_Certificate.md) 对象数组 ** Marker ** 如果检索的记录数大于 `MaxRecords`，则提供可选的分页标记。如果指定了此参数，则标记将指定列表中的下一条记录。在对 `DescribeCertificates` 的下一次调用中包括 `Marker` 的值会导致下一页证书。 类型：字符串 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** CertificateNotFound ** `CertificateIdentifier` 并不引用现有证书。 HTTP 状态代码：404 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeCertificates) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeCertificates) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeCertificates) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeCertificates) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeCertificates) + [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeCertificates) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeCertificates) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeCertificates) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeCertificates) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeCertificates) # DescribeDBClusterParameterGroups 返回 `DBClusterParameterGroup` 描述的列表。如果指定了 `DBClusterParameterGroupName` 参数，则列表中只包含指定集群参数组的描述。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBClusterParameterGroupName ** 要返回其详细信息的特定集群参数组的名称。 约束： + 如果提供，则必须与现有 `DBClusterParameterGroup` 的名称匹配。 类型：字符串 必需：否 **Filters.Filter.N** 当前不支持此参数。 类型：[Filter](API_Filter.md) 对象数组 必需：否 ** Marker ** 由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。 类型：字符串 必需：否 ** MaxRecords ** 包括在响应中的最大记录数。如果存在的记录数超过了指定的`MaxRecords` 值，则在响应中包含分页记号（标记），以便检索剩余的结果。 默认值：100 约束：最低为 20，最高为 100。 类型：整数 必需：否 ## 响应元素 服务返回以下元素。 **DBClusterParameterGroups。 DBClusterParameterGroup.N** 集群参数组的列表。 类型：[DBClusterParameterGroup](API_DBClusterParameterGroup.md) 对象数组 ** Marker ** 由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。 类型：字符串 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBParameterGroupNotFound ** `DBParameterGroupName` 并不引用现有的参数组。 HTTP 状态代码：404 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterParameterGroups) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterParameterGroups) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterParameterGroups) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterParameterGroups) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterParameterGroups) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterParameterGroups) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterParameterGroups) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterParameterGroups) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterParameterGroups) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterParameterGroups) # DescribeDBClusterParameters 返回特定集群参数组的详细参数列表。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBClusterParameterGroupName ** 要返回其参数详细信息的特定集群参数组的名称。 约束： + 如果提供，则必须与现有 `DBClusterParameterGroup` 的名称匹配。 类型：字符串 是否必需：是 **Filters.Filter.N** 当前不支持此参数。 类型：[Filter](API_Filter.md) 对象数组 必需：否 ** Marker ** 由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。 类型：字符串 必需：否 ** MaxRecords ** 包括在响应中的最大记录数。如果存在的记录数超过了指定的`MaxRecords` 值，则在响应中包含分页记号（标记），以便检索剩余的结果。 默认值：100 约束：最低为 20，最高为 100。 类型：整数 必需：否 ** Source ** 指示仅返回特定源的参数的值。参数源可以是 `engine`、`service` 或 `customer`。 类型：字符串 必需：否 ## 响应元素 服务返回以下元素。 ** Marker ** 由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。 类型：字符串 **Parameters.Parameter.N** 提供集群参数组的参数列表。 类型：[Parameter](API_Parameter.md) 对象数组 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBParameterGroupNotFound ** `DBParameterGroupName` 并不引用现有的参数组。 HTTP 状态代码：404 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterParameters) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterParameters) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterParameters) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterParameters) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterParameters) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterParameters) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterParameters) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterParameters) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterParameters) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterParameters) # DescribeDBClusters 返回有关预配置的 Amazon DocumentDB 集群的信息。API 操作支持分页。对于某些管理功能（如集群和实例周期管理），Amazon DocumentDB 利用与 Amazon RDS 和 Amazon Neptune 共享的操作技术。使用 `filterName=engine,Values=docdb` 筛选条件参数仅返回 Amazon DocumentDB 集群。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBClusterIdentifier ** 用户提供的集群标识符。如果指定了此参数，则只返回特定集群的信息。该参数不区分大小写。 约束： + 如提供，则必须匹配现有 `DBClusterIdentifier`。 类型：字符串 必需：否 **Filters.Filter.N** 筛选条件指定要描述的一个或多个集群。 支持的筛选条件： + `db-cluster-id`-接受集群标识符和集群 Amazon 资源名称 (ARNs)。结果列表仅包含有关这些聚类标识的聚类的信息 ARNs。 类型：[Filter](API_Filter.md) 对象数组 必需：否 ** Marker ** 由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。 类型：字符串 必需：否 ** MaxRecords ** 包括在响应中的最大记录数。如果存在的记录数超过了指定的`MaxRecords` 值，则在响应中包含分页记号（标记），以便检索剩余的结果。 默认值：100 约束：最低为 20，最高为 100。 类型：整数 必需：否 ## 响应元素 服务返回以下元素。 **DBClusters。 DBCluster.N** 集群列表。 类型：[DBCluster](API_DBCluster.md) 对象数组 ** Marker ** 由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。 类型：字符串 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBClusterNotFoundFault ** `DBClusterIdentifier` 并不引用现有集群。 HTTP 状态代码：404 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusters) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusters) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusters) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusters) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusters) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusters) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusters) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusters) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusters) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusters) # DescribeDBClusterSnapshotAttributes 返回手动数据库集群快照的集群快照属性名称和值的列表。 当您与其他人共享快照时 AWS 账户，会`DescribeDBClusterSnapshotAttributes`返回有权复制或还原手动集群快照的`restore`属性和列表。 IDs AWS 账户 如果 `restore` 属性的值列表中包含了 `all`，则手动集群快照为公有，可以由所有 AWS 账户复制或还原。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBClusterSnapshotIdentifier ** 集群快照描述其属性的标识符。 类型：字符串 是否必需：是 ## 响应元素 服务返回以下元素。 ** DBClusterSnapshotAttributesResult ** 有关集群快照关联属性的详细信息。 类型：[DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBClusterSnapshotNotFoundFault ** `DBClusterSnapshotIdentifier` 并不引用现有集群快照。 HTTP 状态代码：404 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes) # DescribeDBClusterSnapshots 返回有关集群快照的信息。API 操作支持分页。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBClusterIdentifier ** 要为其检索集群快照列表的集群 ID。此参数不能与 `DBClusterSnapshotIdentifier` 参数一起使用。此参数不区分大小写。 约束： + 如果提供，必须与现有 `DBCluster` 的标识符匹配。 类型：字符串 必需：否 ** DBClusterSnapshotIdentifier ** 要描述的特定集群快照标识符。此参数不能与 `DBClusterIdentifier` 参数一起使用。此值以一个小写字符串存储。 约束： + 如果提供，必须与现有 `DBClusterSnapshot` 的标识符匹配。 + 如果此标识符用于自动快照，则还必须指定 `SnapshotType` 参数。 类型：字符串 必需：否 **Filters.Filter.N** 当前不支持此参数。 类型：[Filter](API_Filter.md) 对象数组 必需：否 ** IncludePublic ** 设置`true`为包括手动集群快照，这些快照是公开的，可以由任何人复制或恢复 AWS 账户，也可以由其他人进行复制或恢复`false`。默认值为 `false`。 类型：布尔值 必需：否 ** IncludeShared ** 设置为`true`以包括其他人共享的手动群集快照 AWS 账户 ，该快照 AWS 账户 已被授予复制或还原权限等`false`。默认值为 `false`。 类型：布尔值 必需：否 ** Marker ** 由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。 类型：字符串 必需：否 ** MaxRecords ** 包括在响应中的最大记录数。如果存在的记录数超过了指定的`MaxRecords` 值，则在响应中包含分页记号（标记），以便检索剩余的结果。 默认值：100 约束：最低为 20，最高为 100。 类型：整数 必需：否 ** SnapshotType ** 要返回的集群快照的类型。可以指定以下值之一： + `automated`：返回 Amazon DocumentDB 自动为您的 AWS 账户创建的所有集群快照。 + `manual`：返回您为 AWS 账户手动创建的所有集群快照。 + `shared`：返回与您的 AWS 账户共享的所有手动集群快照。 + `public`：返回已标记为公有的所有集群快照。 如果您未指定 `SnapshotType` 值，则返回自动和手动集群快照。您可以通过将 `IncludeShared` 参数设置为 `true`，在这些结果中包括共享集群快照。您可以通过将 `IncludePublic` 参数设置为 `true`，在这些结果中包括公有集群快照。 `IncludeShared` 和 `IncludePublic` 参数不适用于 `SnapshotType` 的值 `manual` 或 `automated`。`SnapshotType` 设置为 `shared` 时，`IncludePublic` 参数不适用。`SnapshotType` 设置为 `public` 时，`IncludeShared` 参数不适用。 类型：字符串 必需：否 ## 响应元素 服务返回以下元素。 **DBCluster快照。 DBClusterSnapshot.N** 提供集群快照列表。 类型：[DBClusterSnapshot](API_DBClusterSnapshot.md) 对象数组 ** Marker ** 由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。 类型：字符串 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBClusterSnapshotNotFoundFault ** `DBClusterSnapshotIdentifier` 并不引用现有集群快照。 HTTP 状态代码：404 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterSnapshots) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterSnapshots) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterSnapshots) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterSnapshots) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterSnapshots) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterSnapshots) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterSnapshots) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterSnapshots) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterSnapshots) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterSnapshots) # DescribeDBEngineVersions 返回可用引擎的列表。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBParameterGroupFamily ** 要返回其详细信息的特定参数组系列的名称。 约束： + 如提供，则必须匹配现有 `DBParameterGroupFamily`。 类型：字符串 必需：否 ** DefaultOnly ** 指示仅返回指定引擎的默认版本还是返回引擎与主要版本的组合。 类型：布尔值 必需：否 ** Engine ** 要返回的数据库引擎。 类型：字符串 必需：否 ** EngineVersion ** 要返回的数据库引擎版本。 示例：`3.6.0` 类型：字符串 必需：否 **Filters.Filter.N** 当前不支持此参数。 类型：[Filter](API_Filter.md) 对象数组 必需：否 ** ListSupportedCharacterSets ** 如果指定了此参数且请求的引擎支持 `CreateDBInstance` 的 `CharacterSetName` 参数，则响应包括每个引擎版本支持的字符集列表。 类型：布尔值 必需：否 ** ListSupportedTimezones ** 如果指定了此参数且请求的引擎支持 `CreateDBInstance` 的 `TimeZone` 参数，则响应包括每个引擎版本支持的时区列表。 类型：布尔值 必需：否 ** Marker ** 由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。 类型：字符串 必需：否 ** MaxRecords ** 包括在响应中的最大记录数。如果存在的记录数超过了指定的`MaxRecords` 值，则在响应中包含分页记号（标记），以便检索剩余的结果。 默认值：100 约束：最低为 20，最高为 100。 类型：整数 必需：否 ## 响应元素 服务返回以下元素。 **DBEngine版本。 DBEngine版本.N** 有关一个或多个引擎版本的详细信息。 类型：[DBEngineVersion](API_DBEngineVersion.md) 对象数组 ** Marker ** 由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。 类型：字符串 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBEngineVersions) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBEngineVersions) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBEngineVersions) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBEngineVersions) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBEngineVersions) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBEngineVersions) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBEngineVersions) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBEngineVersions) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBEngineVersions) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBEngineVersions) # DescribeDBInstances 返回有关预置的 Amazon DocumentDB 实例的信息。此 API 支持分页。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBInstanceIdentifier ** 用户提供的实例标识符。如果指定了此参数，则只返回特定实例的信息。该参数不区分大小写。 约束： + 如果提供，必须与现有 `DBInstance` 的标识符匹配。 类型：字符串 必需：否 **Filters.Filter.N** 筛选条件指定要描述的一个或多个实例。 支持的筛选条件： + `db-cluster-id`-接受集群标识符和集群 Amazon 资源名称 (ARNs)。结果列表仅包含与由这些集群标识的集群关联的实例的相关信息 ARNs。 + `db-instance-id`-接受实例标识符和实例 ARNs。结果列表仅包含有关由这些实例标识的实例的信息 ARNs。 类型：[Filter](API_Filter.md) 对象数组 必需：否 ** Marker ** 由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。 类型：字符串 必需：否 ** MaxRecords ** 包括在响应中的最大记录数。如果存在的记录数超过了指定的`MaxRecords` 值，则在响应中包含分页记号（标记），以便检索剩余的结果。 默认值：100 约束：最低为 20，最高为 100。 类型：整数 必需：否 ## 响应元素 服务返回以下元素。 **DBInstances。 DBInstance.N** 有关一个或多个实例的详细信息。 类型：[DBInstance](API_DBInstance.md) 对象数组 ** Marker ** 由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。 类型：字符串 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBInstanceNotFound ** `DBInstanceIdentifier` 并不引用现有实例。 HTTP 状态代码：404 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBInstances) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBInstances) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBInstances) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBInstances) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBInstances) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBInstances) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBInstances) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBInstances) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBInstances) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBInstances) # DescribeDBSubnetGroups 返回 `DBSubnetGroup` 描述的列表。如果指定了 `DBSubnetGroupName`，则列表中只包含指定 `DBSubnetGroup` 的描述。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBSubnetGroupName ** 要为其返回详细信息的子网组的名称。 类型：字符串 必需：否 **Filters.Filter.N** 当前不支持此参数。 类型：[Filter](API_Filter.md) 对象数组 必需：否 ** Marker ** 由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。 类型：字符串 必需：否 ** MaxRecords ** 包括在响应中的最大记录数。如果存在的记录数超过了指定的`MaxRecords` 值，则在响应中包含分页记号（标记），以便检索剩余的结果。 默认值：100 约束：最低为 20，最高为 100。 类型：整数 必需：否 ## 响应元素 服务返回以下元素。 **DBSubnet群组。 DBSubnetGroup.N** 有关一个或多个子网组的详细信息。 类型：[DBSubnetGroup](API_DBSubnetGroup.md) 对象数组 ** Marker ** 由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。 类型：字符串 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBSubnetGroupNotFoundFault ** `DBSubnetGroupName` 并不引用现有子网组。 HTTP 状态代码：404 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBSubnetGroups) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBSubnetGroups) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBSubnetGroups) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBSubnetGroups) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBSubnetGroups) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBSubnetGroups) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBSubnetGroups) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBSubnetGroups) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBSubnetGroups) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBSubnetGroups) # DescribeEngineDefaultClusterParameters 返回集群数据库引擎的默认引擎和系统参数信息。 ## 请求参数 有关所有操作常用的参数的信息，请参阅[常用参数](CommonParameters.md)。 ** DBParameterGroupFamily ** 要返回其引擎参数信息的集群参数组族的名称。 类型：字符串 是否必需：是 **Filters.Filter.N** 当前不支持此参数。 类型：[Filter](API_Filter.md) 对象数组 必需：否 ** Marker ** 由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。 类型：字符串 必需：否 ** MaxRecords ** 包括在响应中的最大记录数。如果存在的记录数超过了指定的`MaxRecords` 值，则在响应中包含分页记号（标记），以便检索剩余的结果。 默认值：100 约束：最低为 20，最高为 100。 类型：整数 必需：否 ## 响应元素 服务返回以下元素。 ** EngineDefaults ** 包含成功调用 `DescribeEngineDefaultClusterParameters` 操作的结果。 类型：[EngineDefaults](API_EngineDefaults.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) + [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters) # DescribeEventCategories 显示所有事件源类型的类别列表；或如果指定，则显示指定源类型的类别列表。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 **Filters.Filter.N** 当前不支持此参数。 类型：[Filter](API_Filter.md) 对象数组 必需：否 ** SourceType ** 生成事件的源的类型。 有效值：`db-instance`、`db-parameter-group`、`db-security-group` 类型：字符串 必需：否 ## 响应元素 服务返回以下元素。 **EventCategoriesMapList。 EventCategoriesMap.N** 事件类别映射的列表。 类型：[EventCategoriesMap](API_EventCategoriesMap.md) 对象数组 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEventCategories) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEventCategories) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEventCategories) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEventCategories) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEventCategories) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEventCategories) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEventCategories) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEventCategories) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEventCategories) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEventCategories) # DescribeEvents 返回过去 14 天与实例、安全组、快照和数据库参数组相关的事件。对于特定的数据库实例、安全组、快照或参数组，特定于它们的事件可以通过提供名称作为参数来获取。默认情况下，返回过去一小时的事件。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** Duration ** 从中检索事件的分钟数。 默认值：60 类型：整数 必需：否 ** EndTime ** 要检索事件的时间段的结束，以 ISO 8601 格式指定。 示例：2009-07-08T18:00Z 类型：时间戳 必需：否 **EventCategories。 EventCategory.N** 触发事件通知订阅的通知的事件类别列表。 类型：字符串数组 必需：否 **Filters.Filter.N** 当前不支持此参数。 类型：[Filter](API_Filter.md) 对象数组 必需：否 ** Marker ** 由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。 类型：字符串 必需：否 ** MaxRecords ** 包括在响应中的最大记录数。如果存在的记录数超过了指定的`MaxRecords` 值，则在响应中包含分页记号（标记），以便检索剩余的结果。 默认值：100 约束：最低为 20，最高为 100。 类型：整数 必需：否 ** SourceIdentifier ** 为其返回事件的事件源的标识符。如果未指定，则响应中包含所有源。 约束： + 如果提供了 `SourceIdentifier`，则也必须提供 `SourceType`。 + 如果源类型是 `DBInstance`，则必须提供 `DBInstanceIdentifier`。 + 如果源类型是 `DBSecurityGroup`，则必须提供 `DBSecurityGroupName`。 + 如果源类型是 `DBParameterGroup`，则必须提供 `DBParameterGroupName`。 + 如果源类型是 `DBSnapshot`，则必须提供 `DBSnapshotIdentifier`。 + 不能以连字符结尾或包含两个连续的连字符。 类型：字符串 必需：否 ** SourceType ** 要从中检索事件的事件源。如果未指定值，则返回所有事件。 类型：字符串 有效值：`db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot` 必需：否 ** StartTime ** 要检索事件的时间段的开始，以 ISO 8601 格式指定。 示例：2009-07-08T18:00Z 类型：时间戳 必需：否 ## 响应元素 服务返回以下元素。 **Events.Event.N** 有关一个或多个事件的详细信息。 类型：[Event](API_Event.md) 对象数组 ** Marker ** 由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。 类型：字符串 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEvents) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEvents) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEvents) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEvents) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEvents) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEvents) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEvents) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEvents) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEvents) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEvents) # DescribeEventSubscriptions 列出客户账户的所有订阅描述。订阅说明包括 `SubscriptionName`、`SNSTopicARN`、`CustomerID`、`SourceType`、`SourceID`、`CreationTime` 和 `Status`。 如果您指定了 `SubscriptionName`，则列出该订阅的描述。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 **Filters.Filter.N** 当前不支持此参数。 类型：[Filter](API_Filter.md) 对象数组 必需：否 ** Marker ** 由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。 类型：字符串 必需：否 ** MaxRecords ** 包括在响应中的最大记录数。如果存在的记录数超过了指定的`MaxRecords` 值，则在响应中包含分页记号（标记），以便检索剩余的结果。 默认值：100 约束：最低为 20，最高为 100。 类型：整数 必需：否 ** SubscriptionName ** 您要描述的 Amazon DocumentDB 事件通知订阅的名称。 类型：字符串 必需：否 ## 响应元素 服务返回以下元素。 **EventSubscriptionsList。 EventSubscription.N** 事件订阅列表。 类型：[EventSubscription](API_EventSubscription.md) 对象数组 ** Marker ** 由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。 类型：字符串 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** SubscriptionNotFound ** 订阅名称不存在。 HTTP 状态代码：404 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEventSubscriptions) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEventSubscriptions) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEventSubscriptions) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEventSubscriptions) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEventSubscriptions) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEventSubscriptions) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEventSubscriptions) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEventSubscriptions) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEventSubscriptions) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEventSubscriptions) # DescribeGlobalClusters 返回有关 Amazon DocumentDB 全局集群的信息。此 API 支持分页。 **注意** 此操作仅适用于 Amazon DocumentDB 集群。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 **Filters.Filter.N** 筛选条件指定要描述的一个或多个全局数据库集群。 支持的筛选条件：`db-cluster-id`接受集群标识符和集群 Amazon 资源名称 (ARNs)。结果列表将仅包含有关这些聚类标识的聚类的信息 ARNs。 类型：[Filter](API_Filter.md) 对象数组 必需：否 ** GlobalClusterIdentifier ** 用户提供的集群标识符。如果指定了此参数，则只返回特定集群的信息。该参数不区分大小写。 类型：字符串 长度限制：最小长度为 1。最大长度为 255。 模式：`[A-Za-z][0-9A-Za-z-:._]*` 必需：否 ** Marker ** 由之前的 `DescribeGlobalClusters` 请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。 类型：字符串 必需：否 ** MaxRecords ** 包括在响应中的最大记录数。如果存在的记录数超过了指定的`MaxRecords` 值，则在响应中包含分页记号（标记），以便检索剩余的结果。 类型：整数 必需：否 ## 响应元素 服务返回以下元素。 **GlobalClusters。 GlobalClusterMember.N** 类型：[GlobalCluster](API_GlobalCluster.md) 对象数组 ** Marker ** 类型：字符串 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** GlobalClusterNotFoundFault ** `GlobalClusterIdentifier` 并不引用现有全局集群。 HTTP 状态代码：404 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeGlobalClusters) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeGlobalClusters) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeGlobalClusters) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeGlobalClusters) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeGlobalClusters) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeGlobalClusters) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeGlobalClusters) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeGlobalClusters) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeGlobalClusters) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeGlobalClusters) # DescribeOrderableDBInstanceOptions 返回指定引擎的可订购实例选项的列表。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** Engine ** 为其检索实例选项的引擎的名称。 类型：字符串 是否必需：是 ** DBInstanceClass ** 实例类筛选值。指定此参数以只显示与指定实例类匹配的可用产品。 类型：字符串 必需：否 ** EngineVersion ** 引擎版本筛选值。指定此参数以只显示与指定引擎版本匹配的可用产品。 类型：字符串 必需：否 **Filters.Filter.N** 当前不支持此参数。 类型：[Filter](API_Filter.md) 对象数组 必需：否 ** LicenseModel ** 许可模式筛选值。指定此参数以只显示与指定许可模式匹配的可用产品。 类型：字符串 必需：否 ** Marker ** 由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。 类型：字符串 必需：否 ** MaxRecords ** 包括在响应中的最大记录数。如果存在的记录数超过了指定的`MaxRecords` 值，则在响应中包含分页记号（标记），以便检索剩余的结果。 默认值：100 约束：最低为 20，最高为 100。 类型：整数 必需：否 ** Vpc ** 虚拟私有云（VPC）筛选器值。指定此参数以只显示可用的 VPC 或非 VPC 产品。 类型：布尔值 必需：否 ## 响应元素 服务返回以下元素。 ** Marker ** 由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。 类型：字符串 **可订购期权。可订购DBInstance期权.N DBInstance** 可提供给具体可订购实例的选项。 类型：[OrderableDBInstanceOption](API_OrderableDBInstanceOption.md) 对象数组 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) + [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions) # DescribePendingMaintenanceActions 返回至少具有一个待处理的维护操作的资源（例如，实例）的列表。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 **Filters.Filter.N** 一个筛选条件，用于指定一个或多个资源以返回其待处理的维护操作。 支持的筛选条件： + `db-cluster-id`-接受集群标识符和集群 Amazon 资源名称 (ARNs)。结果列表仅包含由它们标识的群集的待处理维护操作 ARNs。 + `db-instance-id`-接受实例标识符和实例 ARNs。结果列表仅包括这些结果所标识的数据库实例的待处理维护操作 ARNs。 类型：[Filter](API_Filter.md) 对象数组 必需：否 ** Marker ** 由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。 类型：字符串 必需：否 ** MaxRecords ** 包括在响应中的最大记录数。如果存在的记录数超过了指定的`MaxRecords` 值，则在响应中包含分页记号（标记），以便检索剩余的结果。 默认值：100 约束：最低为 20，最高为 100。 类型：整数 必需：否 ** ResourceIdentifier ** 用于返回其待处理维护操作的资源的 ARN。 类型：字符串 必需：否 ## 响应元素 服务返回以下元素。 ** Marker ** 由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。 类型：字符串 **PendingMaintenanceActions。 ResourcePendingMaintenanceActions.N** 待应用的维护操作。 类型：[ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) 对象数组 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** ResourceNotFoundFault ** 找不到指定的资源 ID。 HTTP 状态代码：404 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribePendingMaintenanceActions) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribePendingMaintenanceActions) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribePendingMaintenanceActions) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribePendingMaintenanceActions) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribePendingMaintenanceActions) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribePendingMaintenanceActions) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribePendingMaintenanceActions) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribePendingMaintenanceActions) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribePendingMaintenanceActions) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribePendingMaintenanceActions) # FailoverDBCluster 强制集群失效转移。 集群的失效转移会将集群中的 Amazon DocumentDB 副本之一（只读实例）提升为主实例（集群写入器）。 当主实例失效时，Amazon DocumentDB 会自动将失效转移到 Amazon DocumentDB 副本（如果存在）。当您要模拟主实例的故障以进行测试时，可以强制进行故障转移。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBClusterIdentifier ** 用于强制进行失效转移的集群标识符。此参数不区分大小写。 约束： + 必须与现有 `DBCluster` 的标识符匹配。 类型：字符串 必需：否 ** TargetDBInstanceIdentifier ** 提升为主实例的实例的名称。 您必须指定 Amazon DocumentDB 集群中只读副本的实例标识符。例如 `mydbcluster-replica1`。 类型：字符串 必需：否 ## 响应元素 服务返回以下元素。 ** DBCluster ** 有关集群的详细信息。 类型：[DBCluster](API_DBCluster.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBClusterNotFoundFault ** `DBClusterIdentifier` 并不引用现有集群。 HTTP 状态代码：404 ** InvalidDBClusterStateFault ** 集群未处于有效状态。 HTTP 状态代码：400 ** InvalidDBInstanceState ** 指定的实例未处于*可用* 状态。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/FailoverDBCluster) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/FailoverDBCluster) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverDBCluster) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/FailoverDBCluster) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverDBCluster) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/FailoverDBCluster) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/FailoverDBCluster) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/FailoverDBCluster) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/FailoverDBCluster) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverDBCluster) # FailoverGlobalCluster 全局集群发生失效转移时，将指定的辅助数据库集群提升为全局集群的主数据库集群。 使用此操作来应对计划外事件，例如主区域发生区域性灾难。失效转移可导致在失效转移事件发生之前，未复制到选定辅助区域的写入事务数据丢失。但是，将所选辅助数据库集群上的数据库实例提升为主写入器数据库实例的恢复过程可确保数据处于事务一致状态。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** GlobalClusterIdentifier ** 用于应用此操作的 Amazon DocumentDB 全局集群标识符。标识符是用户在创建集群时分配的唯一密钥。换句话说，这是全局集群的名称。 约束： + 必须匹配现有全局集群的标识符。 + 最小长度为 1。最大长度为 255。 模式：`[A-Za-z][0-9A-Za-z-:._]*` 类型：字符串 长度限制：最小长度为 1。最大长度为 255。 模式：`[A-Za-z][0-9A-Za-z-:._]*` 是否必需：是 ** TargetDbClusterIdentifier ** 要提升为全局集群主集群的 Amazon DocumentDB 辅助集群的标识符。使用亚马逊资源名称 (ARN) 作为标识符，这样 Amazon DocumentDB 就可以在其区域中找到集群。 AWS 约束： + 必须与现有辅助集群的标识符匹配。 + 最小长度为 1。最大长度为 255。 模式：`[A-Za-z][0-9A-Za-z-:._]*` 类型：字符串 长度限制：最小长度为 1。最大长度为 255。 模式：`[A-Za-z][0-9A-Za-z-:._]*` 是否必需：是 ** AllowDataLoss ** 指定是否允许此全局集群操作丢失数据。允许丢失数据会触发全局失效转移操作。 如果未指定 `AllowDataLoss`，全局集群操作默认采用切换。 约束： + 不能与 `Switchover` 参数一起指定。 类型：布尔值 必需：否 ** Switchover ** 指定是否切换该全局数据库集群。 约束： + 不能与 `AllowDataLoss` 参数一起指定。 类型：布尔值 必需：否 ## 响应元素 服务返回以下元素。 ** GlobalCluster ** 一种表示 Amazon DocumentDB 全球集群的数据类型。 类型：[GlobalCluster](API_GlobalCluster.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBClusterNotFoundFault ** `DBClusterIdentifier` 并不引用现有集群。 HTTP 状态代码：404 ** GlobalClusterNotFoundFault ** `GlobalClusterIdentifier` 并不引用现有全局集群。 HTTP 状态代码：404 ** InvalidDBClusterStateFault ** 集群未处于有效状态。 HTTP 状态代码：400 ** InvalidGlobalClusterStateFault ** 当集群处于这种状态时，无法执行请求的操作。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/FailoverGlobalCluster) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/FailoverGlobalCluster) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverGlobalCluster) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/FailoverGlobalCluster) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverGlobalCluster) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/FailoverGlobalCluster) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/FailoverGlobalCluster) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/FailoverGlobalCluster) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/FailoverGlobalCluster) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverGlobalCluster) # ListTagsForResource 列出 Amazon DocumentDB 资源上的所有标签。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** ResourceName ** 带有要列出的标签的 Amazon DocumentDB 资源。此值是 Amazon 资源名称（ARN）。 类型：字符串 是否必需：是 **Filters.Filter.N** 当前不支持此参数。 类型：[Filter](API_Filter.md) 对象数组 必需：否 ## 响应元素 服务返回以下元素。 **TagList.Tag.N** 一或多个标签的列表。 类型：[Tag](API_Tag.md) 对象数组 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBClusterNotFoundFault ** `DBClusterIdentifier` 并不引用现有集群。 HTTP 状态代码：404 ** DBInstanceNotFound ** `DBInstanceIdentifier` 并不引用现有实例。 HTTP 状态代码：404 ** DBSnapshotNotFound ** `DBSnapshotIdentifier` 并不引用指现有快照。 HTTP 状态代码：404 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ListTagsForResource) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ListTagsForResource) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ListTagsForResource) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ListTagsForResource) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ListTagsForResource) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ListTagsForResource) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ListTagsForResource) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ListTagsForResource) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ListTagsForResource) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ListTagsForResource) # ModifyDBCluster 修改 Amazon DocumentDB 集群的设置。您可通过在请求中指定这些参数以及新值，更改一个或多个数据库配置参数。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBClusterIdentifier ** 要修改的集群的集群标识符。此参数不区分大小写。 约束： + 必须与现有 `DBCluster` 的标识符匹配。 类型：字符串 是否必需：是 ** AllowMajorVersionUpgrade ** 指示是否允许主要版本升级的值。 约束： + 将 `EngineVersion` 参数的值指定为不同于集群当前版本的主要版本时，必须允许主要版本升级。 + 由于某些参数是特定于版本的，因此对其进行更改需要在就地 MVU 完成后执行新的 `ModifyDBCluster` API 调用。 执行 MVU 会直接影响以下参数： + `MasterUserPassword` + `NewDBClusterIdentifier` + `VpcSecurityGroupIds` + `Port` 类型：布尔值 必需：否 ** ApplyImmediately ** 指定应尽快异步应用此请求中修改及任何待处理修改的值，无论集群的 `PreferredMaintenanceWindow` 设置如何。如果此参数设置为 `false`，则在下一个维护时段中应用对集群的更改。 `ApplyImmediately` 参数仅影响 `NewDBClusterIdentifier` 和 `MasterUserPassword` 值。如果将此参数值设置为 `false`，则对 `NewDBClusterIdentifier` 和 `MasterUserPassword` 值的更改在下一维护时段中应用。所有其他更改会立即应用，而不管 `ApplyImmediately` 参数的值如何。 默认值：`false` 类型：布尔值 必需：否 ** BackupRetentionPeriod ** 自动备份的保留天数。您必须指定最小值 1。 默认：1 约束： + 必须为介于 1 和 35 之间的值。 类型：整数 必需：否 ** CloudwatchLogsExportConfiguration ** 允许将日志类型导出到特定实例或集群的 Amazon CloudWatch Logs 的配置设置。`EnableLogTypes`和`DisableLogTypes`数组决定将哪些日志导出（或不导出）到 CloudWatch 日志。 类型：[CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md) 对象 必需：否 ** DBClusterParameterGroupName ** 用于集群的集群参数组的名称。 类型：字符串 必需：否 ** DeletionProtection ** 指定是否可以删除此集群。如果 `DeletionProtection` 启用，则无法删除集群，除非集群经修改并 `DeletionProtection` 禁用。`DeletionProtection` 防止意外删除集群。 类型：布尔值 必需：否 ** EngineVersion ** 要升级到的数据库引擎的版本号。更改此参数会导致中断。除非 `ApplyImmediately` 启用，否则会在下个维护时段内应用更改。 要列出 Amazon DocumentDB 的所有可用引擎版本，请使用以下命令： `aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"` 类型：字符串 必需：否 ** ManageMasterUserPassword ** 指示是否使用 Amazon Web Services Secrets Manager 管理主用户密码。如果集群未使用 Amazon Web Services Secrets Manager 管理主用户密码，则可以启用此管理。在这种情况下，无法指定 `MasterUserPassword`。如果集群已通过 Amazon Web Services Secrets Manager 管理主用户密码，并且您指定主用户密码不通过 Amazon Web Services Secrets Manager 进行管理，则必须指定 `MasterUserPassword`。在这种情况下，Amazon DocumentDB 会删除密钥并使用通过 `MasterUserPassword` 指定的主用户新密码。 类型：布尔值 必需：否 ** MasterUserPassword ** 主数据库用户的密码。此密码可以包含除正斜杠 (/)、双引号 (") 或 @ 符号之外的任何可打印的 ASCII 字符。 约束：必须包含 8 到 100 个字符。 类型：字符串 必需：否 ** MasterUserSecretKmsKeyId ** Amazon Web Services KMS 密钥标识符，用于加密在 Amazon Web Services Secrets Manager 中自动生成和管理的密钥。 仅当同时满足以下两个条件时此设置才有效： + 集群未在 Amazon Web Services Secrets Manager 中管理主用户密码。如果集群已在 Amazon Web Services Secrets Manager 中管理主用户密码，则您无法更改用于对密钥进行加密的 KMS 密钥。 + 您将启用 `ManageMasterUserPassword` 以在 Amazon Web Services Secrets Manager 中管理主用户密码。如果您正在开启 `ManageMasterUserPassword` 但未指定 `MasterUserSecretKmsKeyId`，则使用 `aws/secretsmanager` KMS 密钥来对密钥进行加密。如果密钥位于不同的 Amazon Web Services 账户中，则无法使用 `aws/secretsmanager` KMS 密钥来对其进行加密，必须使用客户管理的 KMS 密钥。 Amazon Web Services KMS 密钥标识符是密钥 ARN、密钥 ID、别名 ARN 或者 KMS 密钥的别名。要使用不同 Amazon Web Services 中的 KMS 密钥，请指定密钥 ARN 或别名 ARN。 您的 Amazon Web Services 账户有默认 KMS 密钥。您的 Amazon Web Services 账户对每个 Amazon Web Services 区域具有不同的默认 KMS 密钥。 类型：字符串 必需：否 ** NetworkType ** 集群的网络类型。 网络类型由为集群指定的 `DBSubnetGroup` 确定。A `DBSubnetGroup` 只能支持 IPv4 协议或 IPv4 和 IPv6 协议 (`DUAL`)。 有关更多信息，请参阅《Amazon DocumentDB 开发人员指南》中 [VPC 中的 DocumentDB 集群](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html)。 有效值：`IPV4` \$1 `DUAL` 类型：字符串 必需：否 ** NewDBClusterIdentifier ** 重命名集群时集群的新集群标识符。此值以一个小写字符串存储。 约束： + 必须包含 1 到 63 个字母、数字或连字符。 + 第一个字符必须是字母。 + 不能以连字符结尾或包含两个连续的连字符。 示例：`my-cluster2` 类型：字符串 必需：否 ** Port ** 集群接受连接的端口号。 约束：必须是介于 `1150` 到 `65535`的值。 默认值：与原始数据库集群相同的端口。 类型：整数 必需：否 ** PreferredBackupWindow ** 使用 `BackupRetentionPeriod` 参数启用了自动备份时，自动执行备份的日常时间范围。 默认值是从 8 小时的时间段中随机选择一个 30 分钟的窗口。 AWS 区域 约束： + 必须采用 `hh24:mi-hh24:mi` 格式。 + 必须采用通用协调时间（UTC）。 + 不得与首选维护时段冲突。 + 必须至少为 30 分钟。 类型：字符串 必需：否 ** PreferredMaintenanceWindow ** 可进行系统维护的每周时间范围（采用通用协调时间（UTC））。 格式：`ddd:hh24:mi-ddd:hh24:mi` 默认值是从 8 小时的时间段中随机选择一个 30 分钟的窗口 AWS 区域，出现在一周中的随机某一天。 有效日：Mon、Tue、Wed、Thu、Fri、Sat、Sun 约束：至少为 30 分钟的时段。 类型：字符串 必需：否 ** RotateMasterUserPassword ** 指示是否轮换 Amazon Web Services Secrets Manager 管理的用于主用户密码的密钥。 仅当主用户密码由 Amazon DocumentDB 在集群的 Amazon Web Services Secrets Manager 中进行管理时，此设置才有效。密钥值包含更新后的密码。 约束：在轮换主用户密码时，必须立即应用更改。 类型：布尔值 必需：否 ** ServerlessV2ScalingConfiguration ** 包含 Amazon DocumentDB 无服务器集群的扩缩配置。 类型：[ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) 对象 必需：否 ** StorageType ** 与数据库集群关联的存储类型。 有关 Amazon DocumentDB 集群存储类型的信息，请参阅*《Amazon DocumentDB 开发人员指南》*中的集群存储配置。 存储类型的有效值：`standard | iopt1` 默认值为 `standard ` 类型：字符串 必需：否 **VpcSecurityGroupIds。 VpcSecurityGroupId.N** 集群将隶属于的 Virtual Private Cloud (VPC) 安全组的列表。 类型：字符串数组 必需：否 ## 响应元素 服务返回以下元素。 ** DBCluster ** 有关集群的详细信息。 类型：[DBCluster](API_DBCluster.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBClusterAlreadyExistsFault ** 用户已拥有具有给定标识符的集群。 HTTP 状态代码：400 ** DBClusterNotFoundFault ** `DBClusterIdentifier` 并不引用现有集群。 HTTP 状态代码：404 ** DBClusterParameterGroupNotFound ** `DBClusterParameterGroupName` 并不引用现有集群参数组。 HTTP 状态代码：404 ** DBSubnetGroupNotFoundFault ** `DBSubnetGroupName` 并不引用现有子网组。 HTTP 状态代码：404 ** InvalidDBClusterStateFault ** 集群未处于有效状态。 HTTP 状态代码：400 ** InvalidDBInstanceState ** 指定的实例未处于*可用* 状态。 HTTP 状态代码：400 ** InvalidDBSecurityGroupState ** 安全组的状态不允许执行删除。 HTTP 状态代码：400 ** InvalidDBSubnetGroupStateFault ** 无法删除子网组，因为它正在使用中。 HTTP 状态代码：400 ** InvalidSubnet ** 请求的子网无效，或者请求的多个子网并非全部位于同一个常见虚拟私有云（VPC）中。 HTTP 状态代码：400 ** InvalidVPCNetworkStateFault ** 由于所做的更改，子网组在创建后并不会覆盖所有可用区。 HTTP 状态代码：400 ** NetworkTypeNotSupported ** `DBSubnetGroup` 或数据库引擎版本不支持该网络类型。 HTTP 状态代码：400 ** StorageQuotaExceeded ** 该请求会导致您超出跨所有实例可提供的已允许存储量。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBCluster) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBCluster) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBCluster) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBCluster) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBCluster) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBCluster) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBCluster) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBCluster) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBCluster) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBCluster) # ModifyDBClusterParameterGroup 修改一个集群参数组的参数。要修改多个参数，请提交以下对象的列表：`ParameterName`、`ParameterValue` 和 `ApplyMethod`。在单个请求中，最多可以修改 20 个参数。 **注意** 对动态参数所做的更改将立即应用。对静态参数的更改需要重启或维护时段，之后这些更改才能生效。 **重要** 创建集群参数组之后，您应至少等待 5 分钟，再创建使用该集群参数组作为默认参数组的第一个集群。这让 Amazon DocumentDB 可以在参数组用作新集群的默认值之前完全完成创建操作。此步骤对于在为集群创建默认数据库时十分关键的参数（例如，由 `character_set_database` 参数定义的默认数据库字符集）非常重要。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBClusterParameterGroupName ** 要修改的集群参数组的名称。 类型：字符串 是否必需：是 **Parameters.Parameter.N** 要修改的集群参数组中参数的列表。 类型：[Parameter](API_Parameter.md) 对象数组 是否必需：是 ## 响应元素 服务返回以下元素。 ** DBClusterParameterGroupName ** 集群参数组的名称。 约束： + 必须为 1 到 255 个字母或数字。 + 第一个字符必须是字母。 + 不能以连字符结尾或包含两个连续的连字符。 此值以一个小写字符串存储。 类型：字符串 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBParameterGroupNotFound ** `DBParameterGroupName` 并不引用现有的参数组。 HTTP 状态代码：404 ** InvalidDBParameterGroupState ** 参数组正在使用中或处于无效状态。如果您尝试删除参数组，则在参数组处于此状态时无法将其删除。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBClusterParameterGroup) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBClusterParameterGroup) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBClusterParameterGroup) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBClusterParameterGroup) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBClusterParameterGroup) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBClusterParameterGroup) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBClusterParameterGroup) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBClusterParameterGroup) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBClusterParameterGroup) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBClusterParameterGroup) # ModifyDBClusterSnapshotAttribute 向手动集群快照添加属性和值，或者从中删除属性和值。 要与其他人共享手动集群快照 AWS 账户`AttributeName`，请指定`restore`为，然后使用`ValuesToAdd`参数添加有权恢复手动集群快照的用户列表。 IDs AWS 账户 使用值 `all` 来公开手动集群快照，这意味着所有 AWS 账户都可以复制或还原它。若任何手动集群快照包含您不想向所有 AWS 账户公开的私有信息，则不要添加 `all` 值。如果手动集群快照已加密，则可以共享该快照，但只能通过 AWS 账户 IDs 为`ValuesToAdd`参数指定授权列表来共享。在这种情况下，您不能使用 `all` 作为该参数的值。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** AttributeName ** 要修改的集群快照属性的名称。 要管理其他 AWS 账户 人复制或恢复手动集群快照的授权，请将此值设置为`restore`。 类型：字符串 是否必需：是 ** DBClusterSnapshotIdentifier ** 要修改其属性的集群快照的标识符。 类型：字符串 是否必需：是 **ValuesToAdd。 AttributeValue.N** 要添加到 `AttributeName` 所指定属性的集群快照属性的列表。 要授权其他 AWS 账户 人复制或恢复手动集群快照，请将此列表设置为包括一个或多个快照 AWS 账户 IDs。要使手动集群快照可由任何人恢复 AWS 账户，请`all`将其设置为。若任何手动集群快照包含您不想向所有 AWS 账户公开的私有信息，请不要添加 `all` 值。 类型：字符串数组 必需：否 **ValuesToRemove。 AttributeValue.N** 要从 `AttributeName` 所指定属性中移除的集群快照属性的列表。 要取消其他 AWS 账户 人复制或恢复手动集群快照的授权，请将此列表设置为包含一个或多个 AWS 账户 标识符。要取消任何 AWS 账户 人复制或恢复集群快照的授权，请将其设置为`all`。如果您指定`all`，则 AWS 账户 其账户 ID 已明确添加到`restore`属性中的用户仍可以复制或恢复手动集群快照。 类型：字符串数组 必需：否 ## 响应元素 服务返回以下元素。 ** DBClusterSnapshotAttributesResult ** 有关集群快照关联属性的详细信息。 类型：[DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBClusterSnapshotNotFoundFault ** `DBClusterSnapshotIdentifier` 并不引用现有集群快照。 HTTP 状态代码：404 ** InvalidDBClusterSnapshotStateFault ** 提供的值不是有效的集群快照状态。 HTTP 状态代码：400 ** SharedSnapshotQuotaExceeded ** 您已超过您可与其共享手动数据库快照的最大账户数。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute) # ModifyDBInstance 修改实例的设置。您可通过在请求中指定这些参数以及新值，更改一个或多个数据库配置参数。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBInstanceIdentifier ** 实例标识符。此值以一个小写字符串存储。 约束： + 必须与现有 `DBInstance` 的标识符匹配。 类型：字符串 是否必需：是 ** ApplyImmediately ** 指定是否应尽快异步应用此请求中修改及任何待处理修改，无论实例的 `PreferredMaintenanceWindow` 设置如何。 如果此参数设置为 `false`，则在下一个维护时段中应用对实例的更改。某些参数更改会导致中断，在下次重启时应用。 默认值：`false` 类型：布尔值 必需：否 ** AutoMinorVersionUpgrade ** 此参数不适用于 Amazon DocumentDB。无论设置的值如何，Amazon DocumentDB 都不会执行次要版本升级。 类型：布尔值 必需：否 ** CACertificateIdentifier ** 指示需要与实例相关联的证书。 类型：字符串 必需：否 ** CertificateRotationRestart ** 指定在轮换 SSL/TLS 证书时是否重新启动数据库实例。 默认情况下，当您轮换 SSL/TLS 证书时，数据库实例会重新启动。证书直到 DB 实例重新启动才更新。 仅当您*不*使用连接数据库实例 SSL/TLS 时才设置此参数。 *如果您使用连接数据库实例 SSL/TLS ，请参阅 Amazon DocumentDB 开发者指南中的[更新您的亚马逊 DocumentDB TLS 证书](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html)和[加密传输中的数据](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html)。* 类型：布尔值 必需：否 ** CopyTagsToSnapshot ** 指示是否将所有标签从数据库实例复制到数据库实例快照的值。默认情况下，不复制标签。 类型：布尔值 必需：否 ** DBInstanceClass ** 实例新的计算和内存容量；例如，`db.r5.large`。并非所有实例类型在所有 AWS 区域中都可用。 如果您修改实例类，则在更改期间会发生中断。更改在下一个维护时段内应用，除非此请求的 `ApplyImmediately` 指定为 `true`。 默认值：使用现有设置。 类型：字符串 必需：否 ** EnablePerformanceInsights ** 指示是否为数据库实例启用 Performance Insights 的值。有关更多信息，请参阅[使用 Amazon Performance Insights](https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html)。 类型：布尔值 必需：否 ** NewDBInstanceIdentifier ** 重命名实例时实例的新标识符。当您更改实例标识符时，如果您将 `Apply Immediately` 设置成 `true`，则实例重启立即发生。如果您将 `Apply Immediately` 设置成 `false`，则实例重启在下一个维护窗口期间发生。此值以一个小写字符串存储。 约束： + 必须包含 1 到 63 个字母、数字或连字符。 + 第一个字符必须是字母。 + 不能以连字符结尾或包含两个连续的连字符。 示例：`mydbinstance` 类型：字符串 必需：否 ** PerformanceInsightsKMSKeyId ** Performance Insights 数据加密的密 AWS KMS 钥标识符。 AWS KMS 密钥标识符是 KMS 密钥的密钥 ARN、密钥 ID、别名 ARN 或 KMS 密钥的别名。 如果您没有为 PerformanceInsights KMSKey ID 指定值，则亚马逊文档数据库将使用您的默认 KMS 密钥。您的 Amazon Web Services 账户有默认 KMS 密钥。您的 Amazon 网络服务账户对每个 Amazon 网络服务区具有不同的默认 KMS 密钥。 类型：字符串 必需：否 ** PreferredMaintenanceWindow ** 可进行系统维护的每周时间范围（采用 UTC），这可能导致中断。更改此参数不会导致中断（除非在下列情况中），所做更改会尽快以异步方式应用。如果有待处理的操作导致服务重启，并且维护时段经过更改，加入了当前时间，则更改此参数将导致实例重启。如果将此时段移动到当前时间，则当前时间与时段结束之间必须相隔至少 30 分钟以确保应用待处理的更改。 默认值：使用现有设置。 格式：`ddd:hh24:mi-ddd:hh24:mi` 有效日：Mon、Tue、Wed、Thu、Fri、Sat、Sun 约束：必须至少为 30 分钟。 类型：字符串 必需：否 ** PromotionTier ** 该值指定在现有主实例发生故障后将 Amazon DocumentDB 副本提升为主实例的顺序。 默认：1 有效值：0-15 类型：整数 必需：否 ## 响应元素 服务返回以下元素。 ** DBInstance ** 有关实例的详细信息。 类型：[DBInstance](API_DBInstance.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** AuthorizationNotFound ** 已指定的 CIDR IP 或 Amazon EC2 安全组未获得指定的安全组的授权。 Amazon DocumentDB 也可能未授权代表您使用 IAM 执行必需操作。 HTTP 状态代码：404 ** CertificateNotFound ** `CertificateIdentifier` 并不引用现有证书。 HTTP 状态代码：404 ** DBInstanceAlreadyExists ** 您已经有一个带有给定标识符的实例。 HTTP 状态代码：400 ** DBInstanceNotFound ** `DBInstanceIdentifier` 并不引用现有实例。 HTTP 状态代码：404 ** DBParameterGroupNotFound ** `DBParameterGroupName` 并不引用现有的参数组。 HTTP 状态代码：404 ** DBSecurityGroupNotFound ** `DBSecurityGroupName` 并不引用现有安全组。 HTTP 状态代码：404 ** DBUpgradeDependencyFailure ** 升级失败，因为 依赖的资源无法修改。 HTTP 状态代码：400 ** InsufficientDBInstanceCapacity ** 指定的实例类别在指定的可用区中不可用。 HTTP 状态代码：400 ** InvalidDBInstanceState ** 指定的实例未处于*可用* 状态。 HTTP 状态代码：400 ** InvalidDBSecurityGroupState ** 安全组的状态不允许执行删除。 HTTP 状态代码：400 ** InvalidVPCNetworkStateFault ** 由于所做的更改，子网组在创建后并不会覆盖所有可用区。 HTTP 状态代码：400 ** StorageQuotaExceeded ** 该请求会导致您超出跨所有实例可提供的已允许存储量。 HTTP 状态代码：400 ** StorageTypeNotSupported ** 指定的 `StorageType` 存储无法与数据库实例关联。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBInstance) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBInstance) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBInstance) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBInstance) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBInstance) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBInstance) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBInstance) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBInstance) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBInstance) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBInstance) # ModifyDBSubnetGroup 修改现有子网组。子网组必须至少包含 AWS 区域可用区中至少两个可用区的一个子网。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBSubnetGroupName ** 子网组的名称。此值以一个小写字符串存储。您不能修改默认子网组。 约束：必须与现有 `DBSubnetGroup` 的名称匹配。不能是默认值。 示例：`mySubnetgroup` 类型：字符串 是否必需：是 **SubnetIds。 SubnetIdentifier.N** 子网 IDs 组的 Amazon EC2 子网。 类型：字符串数组 是否必需：是 ** DBSubnetGroupDescription ** 子网组的描述。 类型：字符串 必需：否 ## 响应元素 服务返回以下元素。 ** DBSubnetGroup ** 有关子网组的详细信息。 类型：[DBSubnetGroup](API_DBSubnetGroup.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBSubnetGroupDoesNotCoverEnoughAZs ** 除非只有一个可用区，否则子网组中的子网应至少包含两个可用区。 HTTP 状态代码：400 ** DBSubnetGroupNotFoundFault ** `DBSubnetGroupName` 并不引用现有子网组。 HTTP 状态代码：404 ** DBSubnetQuotaExceededFault ** 该请求会导致用户超过子网组中允许的子网数。 HTTP 状态代码：400 ** InvalidSubnet ** 请求的子网无效，或者请求的多个子网并非全部位于同一个常见虚拟私有云（VPC）中。 HTTP 状态代码：400 ** SubnetAlreadyInUse ** 子网已在可用区中使用。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBSubnetGroup) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBSubnetGroup) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBSubnetGroup) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBSubnetGroup) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBSubnetGroup) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBSubnetGroup) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBSubnetGroup) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBSubnetGroup) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBSubnetGroup) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBSubnetGroup) # ModifyEventSubscription 修改现有的 Amazon DocumentDB 事件通知订阅。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** SubscriptionName ** Amazon DocumentDB 事件通知订阅的名称。 类型：字符串 是否必需：是 ** Enabled ** 布尔值；设置为 `true` 可激活订阅。 类型：布尔值 必需：否 **EventCategories。 EventCategory.N** 您想要订阅到的 `SourceType` 的事件类别列表。 类型：字符串数组 必需：否 ** SnsTopicArn ** 为事件通知创建的 SNS 主题的 Amazon 资源名称（ARN）。在您创建主题并订阅到该主题时，由 Amazon SNS 创建 ARN。 类型：字符串 必需：否 ** SourceType ** 生成事件的源的类型。例如，如果希望收到关于实例生成的事件的通知，请将此参数设置为 `db-instance`。如果未指定该值，则将返回所有事件。 有效值：`db-instance`、`db-parameter-group`、`db-security-group` 类型：字符串 必需：否 ## 响应元素 服务返回以下元素。 ** EventSubscription ** 有关您已订阅事件的详细信息。 类型：[EventSubscription](API_EventSubscription.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** EventSubscriptionQuotaExceeded ** 您已达到事件订阅的最大数目。 HTTP 状态代码：400 ** SNSInvalidTopic ** Amazon SNS 已回复，指定的主题存在问题。 HTTP 状态代码：400 ** SNSNoAuthorization ** 您没有发布到 SNS 主题的 Amazon 资源名称（ARN）上的权限。 HTTP 状态代码：400 ** SNSTopicArnNotFound ** SNS 主题的 Amazon 资源名称（ARN）不存在。 HTTP 状态代码：404 ** SubscriptionCategoryNotFound ** 提供的类别不存在。 HTTP 状态代码：404 ** SubscriptionNotFound ** 订阅名称不存在。 HTTP 状态代码：404 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyEventSubscription) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyEventSubscription) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyEventSubscription) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyEventSubscription) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyEventSubscription) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyEventSubscription) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyEventSubscription) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyEventSubscription) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyEventSubscription) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyEventSubscription) # ModifyGlobalCluster 修改 Amazon DocumentDB 全局集群的设置。您可以通过在请求中指定这些参数和新值来更改一个或多个配置参数（例如：删除保护）或全局群集标识符。 **注意** 此操作仅适用于 Amazon DocumentDB 集群。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** GlobalClusterIdentifier ** 要修改的集群的数据库集群标识符。该参数不区分大小写。 约束： + 必须匹配现有全局集群的标识符。 类型：字符串 长度限制：最小长度为 1。最大长度为 255。 模式：`[A-Za-z][0-9A-Za-z-:._]*` 是否必需：是 ** DeletionProtection ** 指示全局集群是否启用了删除保护。在启用删除保护时，无法删除全局集群。 类型：布尔值 必需：否 ** NewGlobalClusterIdentifier ** 您修改全局群集时全局群集的新标识符。此值以一个小写字符串存储。 + 必须包含 1 到 63 个字母、数字或连字符 第一个字符必须是字母 不能以连字符结尾，也不能包含两个连续连字符 示例：`my-cluster2` 类型：字符串 长度限制：最小长度为 1。最大长度为 255。 模式：`[A-Za-z][0-9A-Za-z-:._]*` 必需：否 ## 响应元素 服务返回以下元素。 ** GlobalCluster ** 一种表示 Amazon DocumentDB 全球集群的数据类型。 类型：[GlobalCluster](API_GlobalCluster.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** GlobalClusterNotFoundFault ** `GlobalClusterIdentifier` 并不引用现有全局集群。 HTTP 状态代码：404 ** InvalidGlobalClusterStateFault ** 当集群处于这种状态时，无法执行请求的操作。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyGlobalCluster) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyGlobalCluster) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyGlobalCluster) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyGlobalCluster) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyGlobalCluster) + [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyGlobalCluster) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyGlobalCluster) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyGlobalCluster) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyGlobalCluster) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyGlobalCluster) # RebootDBInstance 您可能需要重启实例，通常是出于维护目的。例如，如果进行某些修改或更改与实例关联的集群参数组，您必须重启该实例以使更改生效。 重启实例会重新启动数据库引擎服务。重启实例将导致短暂中断，在此期间，实例状态将设置为*正在重启*。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBInstanceIdentifier ** 实例标识符。该参数作为一个小写字符串存储。 约束： + 必须与现有 `DBInstance` 的标识符匹配。 类型：字符串 是否必需：是 ** ForceFailover ** 如果为 `true`，则通过多可用区失效转移进行重启。 约束：如果没有为多可用区配置实例，则无法指定 `true`。 类型：布尔值 必需：否 ## 响应元素 服务返回以下元素。 ** DBInstance ** 有关实例的详细信息。 类型：[DBInstance](API_DBInstance.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBInstanceNotFound ** `DBInstanceIdentifier` 并不引用现有实例。 HTTP 状态代码：404 ** InvalidDBInstanceState ** 指定的实例未处于*可用* 状态。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RebootDBInstance) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RebootDBInstance) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RebootDBInstance) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RebootDBInstance) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RebootDBInstance) + [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RebootDBInstance) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RebootDBInstance) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RebootDBInstance) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RebootDBInstance) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RebootDBInstance) # RemoveFromGlobalCluster 使 Amazon DocumentDB 辅助集群从全局集群分离。该集群变成具有读写功能而不是只读且从一个不同区域中主集群接收数据的独立集群。 **注意** 此操作仅适用于 Amazon DocumentDB 集群。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DbClusterIdentifier ** Amazon 资源名称（ARN）标识从 Amazon DocumentDB 全局集群已分离的集群。 类型：字符串 是否必需：是 ** GlobalClusterIdentifier ** 从 Amazon DocumentDB 全局集群分离的集群标识符。 类型：字符串 长度限制：最小长度为 1。最大长度为 255。 模式：`[A-Za-z][0-9A-Za-z-:._]*` 是否必需：是 ## 响应元素 服务返回以下元素。 ** GlobalCluster ** 一种表示 Amazon DocumentDB 全球集群的数据类型。 类型：[GlobalCluster](API_GlobalCluster.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBClusterNotFoundFault ** `DBClusterIdentifier` 并不引用现有集群。 HTTP 状态代码：404 ** GlobalClusterNotFoundFault ** `GlobalClusterIdentifier` 并不引用现有全局集群。 HTTP 状态代码：404 ** InvalidGlobalClusterStateFault ** 当集群处于这种状态时，无法执行请求的操作。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RemoveFromGlobalCluster) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RemoveFromGlobalCluster) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RemoveFromGlobalCluster) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RemoveFromGlobalCluster) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RemoveFromGlobalCluster) + [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RemoveFromGlobalCluster) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RemoveFromGlobalCluster) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RemoveFromGlobalCluster) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RemoveFromGlobalCluster) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RemoveFromGlobalCluster) # RemoveSourceIdentifierFromSubscription 从现有 Amazon DocumentDB 事件通知订阅中删除源标识符。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** SourceIdentifier ** 要从订阅中删除的源标识符，例如实例的实例标识符或安全组的名称。 类型：字符串 是否必需：是 ** SubscriptionName ** 要从中删除源标识符的 Amazon DocumentDB 事件通知订阅的名称。 类型：字符串 是否必需：是 ## 响应元素 服务返回以下元素。 ** EventSubscription ** 有关您已订阅事件的详细信息。 类型：[EventSubscription](API_EventSubscription.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** SourceNotFound ** 找不到请求的源。 HTTP 状态代码：404 ** SubscriptionNotFound ** 订阅名称不存在。 HTTP 状态代码：404 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) + [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription) # RemoveTagsFromResource 从 Amazon DocumentDB 资源中删除元数据标签。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** ResourceName ** 从其中删除标签的 Amazon DocumentDB 资源。此值是 Amazon 资源名称（ARN）。 类型：字符串 是否必需：是 **TagKeys.member.n** 要删除的标签的标签键（名称）。 类型：字符串数组 是否必需：是 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBClusterNotFoundFault ** `DBClusterIdentifier` 并不引用现有集群。 HTTP 状态代码：404 ** DBInstanceNotFound ** `DBInstanceIdentifier` 并不引用现有实例。 HTTP 状态代码：404 ** DBSnapshotNotFound ** `DBSnapshotIdentifier` 并不引用指现有快照。 HTTP 状态代码：404 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RemoveTagsFromResource) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RemoveTagsFromResource) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RemoveTagsFromResource) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RemoveTagsFromResource) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RemoveTagsFromResource) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RemoveTagsFromResource) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RemoveTagsFromResource) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RemoveTagsFromResource) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RemoveTagsFromResource) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RemoveTagsFromResource) # ResetDBClusterParameterGroup 将集群参数组的参数修改为默认值。要重置特定参数，请提交以下内容的列表：`ParameterName` 和 `ApplyMethod`。要重置整个集群参数组，请指定 `DBClusterParameterGroupName` 和 `ResetAllParameters` 参数。 当您重置整个组时，动态参数立即更新，静态参数设置为 `pending-reboot`以便在下次 DB 实例重新启动时生效。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBClusterParameterGroupName ** 要重置的集群参数组的名称。 类型：字符串 是否必需：是 **Parameters.Parameter.N** 集群参数组中要重置为默认值的参数名称列表。如果 `ResetAllParameters` 参数设置为 `true`，则无法使用此参数。 类型：[Parameter](API_Parameter.md) 对象数组 必需：否 ** ResetAllParameters ** 值设置为 `true` 可将库集群参数组中的所有参数重置为其默认值，否则为 `false`。如果为 `Parameters` 参数指定了参数名称列表，您无法使用此参数。 类型：布尔值 必需：否 ## 响应元素 服务返回以下元素。 ** DBClusterParameterGroupName ** 集群参数组的名称。 约束： + 必须为 1 到 255 个字母或数字。 + 第一个字符必须是字母。 + 不能以连字符结尾或包含两个连续的连字符。 此值以一个小写字符串存储。 类型：字符串 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBParameterGroupNotFound ** `DBParameterGroupName` 并不引用现有的参数组。 HTTP 状态代码：404 ** InvalidDBParameterGroupState ** 参数组正在使用中或处于无效状态。如果您尝试删除参数组，则在参数组处于此状态时无法将其删除。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ResetDBClusterParameterGroup) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ResetDBClusterParameterGroup) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ResetDBClusterParameterGroup) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ResetDBClusterParameterGroup) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ResetDBClusterParameterGroup) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ResetDBClusterParameterGroup) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ResetDBClusterParameterGroup) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ResetDBClusterParameterGroup) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ResetDBClusterParameterGroup) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ResetDBClusterParameterGroup) # RestoreDBClusterFromSnapshot 从快照或集群快照创建新的集群。 如果指定快照，则使用默认配置和默认安全组，从源数据库快照创建目标集群。 如果指定集群快照，则使用具有与原始源数据库集群相同配置的源集群恢复点，创建目标集群，不同之处在于新集群在默认安全组中创建。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBClusterIdentifier ** 从快照或集群快照创建集群的名称。该参数不区分大小写。 约束： + 必须包含 1 到 63 个字母、数字或连字符。 + 第一个字符必须是字母。 + 不能以连字符结尾或包含两个连续的连字符。 示例：`my-snapshot-id` 类型：字符串 是否必需：是 ** Engine ** 要用于新集群的数据库引擎。 默认值：与源相同 约束：必须与源的引擎兼容 类型：字符串 是否必需：是 ** SnapshotIdentifier ** 要从中进行还原的快照或集群快照的标识符。 您可以使用名称或 Amazon 资源名称（ARN） 指定集群快照。但是，您只能使用 ARN 指定快照。 约束： + 必须与现有快照的标识符匹配。 类型：字符串 是否必需：是 **AvailabilityZones。 AvailabilityZone.N** 提供可在其中创建所还原数据库集群的实例的 Amazon EC2 可用区列表。 类型：字符串数组 必需：否 ** DBClusterParameterGroupName ** 要与该数据库集群关联的数据库集群参数组的名称。 *类型*：字符串。      *必需*：否。 如果省略此参数，则使用指默认数据库参数组。如果提供，必须与现有默认数据库集群参数组的名称匹配。字符串必须包含 1 到 255 个字母、数字或连字符。必须以字母开头，并且不能以连字符结束或包含两个连续的连字符。 类型：字符串 必需：否 ** DBSubnetGroupName ** 用于新集群的子网组的名称。 约束：如果提供，则必须与现有 `DBSubnetGroup` 的名称匹配。 示例：`mySubnetgroup` 类型：字符串 必需：否 ** DeletionProtection ** 指定是否可以删除此集群。如果 `DeletionProtection` 启用，则无法删除集群，除非集群经修改并 `DeletionProtection` 禁用。`DeletionProtection` 防止意外删除集群。 类型：布尔值 必需：否 **EnableCloudwatchLogsExports.member.n** 必须启用才能导出到 Amazon CloudWatch 日志的日志类型列表。 类型：字符串数组 必需：否 ** EngineVersion ** 要用于新集群的数据库引擎的版本。 类型：字符串 必需：否 ** KmsKeyId ** 从数据库快照或集群快照还原加密集群时使用的密 AWS KMS 钥标识符。 AWS KMS 密钥标识符是 AWS KMS 加密密钥的 Amazon 资源名称 (ARN)。如果您要使用拥有用于加密新集群的 AWS KMS 加密密钥的集群恢复集群，则可以使用 AWS KMS 密钥别名代替 ARN 作为 AWS KMS 加密密钥。 AWS 账户 如果不为 `KmsKeyId` 参数指定值，则会出现以下情况： + 如果中的`SnapshotIdentifier`快照或集群快照已加密，则使用用于加密快照或集群快照的 AWS KMS 密钥对还原的集群进行加密。 + 如果 `SnapshotIdentifier` 中的快照或集群快照未加密，还原的数据库集群也不会加密。 类型：字符串 必需：否 ** NetworkType ** 集群的网络类型。 网络类型由为集群指定的 `DBSubnetGroup` 确定。A `DBSubnetGroup` 只能支持 IPv4 协议或 IPv4 和 IPv6 协议 (`DUAL`)。 有关更多信息，请参阅《Amazon DocumentDB 开发人员指南》中 [VPC 中的 DocumentDB 集群](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html)。 有效值：`IPV4` \$1 `DUAL` 类型：字符串 必需：否 ** Port ** 新集群接受连接的端口号。 约束：必须是介于 `1150` 到 `65535` 的值。 默认值：与原始数据库集群相同的端口。 类型：整数 必需：否 ** ServerlessV2ScalingConfiguration ** 包含 Amazon DocumentDB 无服务器集群的扩缩配置。 类型：[ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) 对象 必需：否 ** StorageType ** 与数据库集群关联的存储类型。 有关 Amazon DocumentDB 集群存储类型的信息，请参阅*《Amazon DocumentDB 开发人员指南》*中的集群存储配置。 存储类型的有效值：`standard | iopt1` 默认值为 `standard ` 类型：字符串 必需：否 **Tags.Tag.N** 要分配给所还原集群的标签。 类型：[Tag](API_Tag.md) 对象数组 必需：否 **VpcSecurityGroupIds。 VpcSecurityGroupId.N** 新集群将从属的虚拟私有云（VPC）安全组的列表。 类型：字符串数组 必需：否 ## 响应元素 服务返回以下元素。 ** DBCluster ** 有关集群的详细信息。 类型：[DBCluster](API_DBCluster.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBClusterAlreadyExistsFault ** 用户已拥有具有给定标识符的集群。 HTTP 状态代码：400 ** DBClusterQuotaExceededFault ** 无法创建集群，因为您已达到允许的集群最大配额。 HTTP 状态代码：403 ** DBClusterSnapshotNotFoundFault ** `DBClusterSnapshotIdentifier` 并不引用现有集群快照。 HTTP 状态代码：404 ** DBSnapshotNotFound ** `DBSnapshotIdentifier` 并不引用指现有快照。 HTTP 状态代码：404 ** DBSubnetGroupNotFoundFault ** `DBSubnetGroupName` 并不引用现有子网组。 HTTP 状态代码：404 ** DBSubnetGroupNotFoundFault ** `DBSubnetGroupName` 并不引用现有子网组。 HTTP 状态代码：404 ** InsufficientDBClusterCapacityFault ** 集群没有足够的容量用于当前操作。 HTTP 状态代码：403 ** InsufficientStorageClusterCapacity ** 当前操作没有足够的可用存储空间。通过更新子网组来使用具有更多可用存储空间的不同可用区，可以解决此错误。 HTTP 状态代码：400 ** InvalidDBClusterSnapshotStateFault ** 提供的值不是有效的集群快照状态。 HTTP 状态代码：400 ** InvalidDBSnapshotState ** 快照的状态不允许执行删除。 HTTP 状态代码：400 ** InvalidRestoreFault ** 您无法从虚拟私有云（VPC）备份恢复到非虚拟私有云（VPC）实例。 HTTP 状态代码：400 ** InvalidSubnet ** 请求的子网无效，或者请求的多个子网并非全部位于同一个常见虚拟私有云（VPC）中。 HTTP 状态代码：400 ** InvalidVPCNetworkStateFault ** 由于所做的更改，子网组在创建后并不会覆盖所有可用区。 HTTP 状态代码：400 ** KMSKeyNotAccessibleFault ** 访问 AWS KMS 密钥时出错。 HTTP 状态代码：400 ** NetworkTypeNotSupported ** `DBSubnetGroup` 或数据库引擎版本不支持该网络类型。 HTTP 状态代码：400 ** StorageQuotaExceeded ** 该请求会导致您超出跨所有实例可提供的已允许存储量。 HTTP 状态代码：400 ** StorageQuotaExceeded ** 该请求会导致您超出跨所有实例可提供的已允许存储量。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RestoreDBClusterFromSnapshot) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RestoreDBClusterFromSnapshot) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RestoreDBClusterFromSnapshot) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RestoreDBClusterFromSnapshot) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RestoreDBClusterFromSnapshot) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RestoreDBClusterFromSnapshot) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RestoreDBClusterFromSnapshot) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RestoreDBClusterFromSnapshot) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RestoreDBClusterFromSnapshot) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RestoreDBClusterFromSnapshot) # RestoreDBClusterToPointInTime 将集群还原到任意时间点。用户可以还原到 `LatestRestorableTime` 之前最多 `BackupRetentionPeriod` 天的任意时间点。使用具有与原始集群相同配置的源集群创建目标集群，不同之处在于新集群在默认安全组中创建。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBClusterIdentifier ** 要创建的新集群的名称。 约束： + 必须包含 1 到 63 个字母、数字或连字符。 + 第一个字符必须是字母。 + 不能以连字符结尾或包含两个连续的连字符。 类型：字符串 是否必需：是 ** SourceDBClusterIdentifier ** 要从中还原的源集群的标识符。 约束： + 必须与现有 `DBCluster` 的标识符匹配。 类型：字符串 是否必需：是 ** DBSubnetGroupName ** 要用于新集群的子网组名称。 约束：如果提供，则必须与现有 `DBSubnetGroup` 的名称匹配。 示例：`mySubnetgroup` 类型：字符串 必需：否 ** DeletionProtection ** 指定是否可以删除此集群。如果 `DeletionProtection` 启用，则无法删除集群，除非集群经修改并 `DeletionProtection` 禁用。`DeletionProtection` 防止意外删除集群。 类型：布尔值 必需：否 **EnableCloudwatchLogsExports.member.n** 必须启用才能导出到 Amazon CloudWatch 日志的日志类型列表。 类型：字符串数组 必需：否 ** KmsKeyId ** 从加密集群恢复加密集群时使用的密 AWS KMS 钥标识符。 AWS KMS 密钥标识符是 AWS KMS 加密密钥的 Amazon 资源名称 (ARN)。如果您要使用拥有用于加密新集群的 AWS KMS 加密密钥的集群恢复集群，则可以使用 AWS KMS 密钥别名代替 ARN 作为 AWS KMS 加密密钥。 AWS 账户 您可以恢复到新集群，并使用与用于加密源集群的 AWS KMS 密钥不同的 AWS KMS 密钥对新集群进行加密。使用`KmsKeyId`参数标识的 AWS KMS 密钥对新的数据库集群进行加密。 如果不为 `KmsKeyId` 参数指定值，则会出现以下情况： + 如果集群已加密，则使用用于加密源集群的 AWS KMS 密钥对还原的集群进行加密。 + 如果集群未加密，则还原的集群也不会加密。 如果 `DBClusterIdentifier` 引用未加密的集群，则将拒绝还原请求。 类型：字符串 必需：否 ** NetworkType ** 集群的网络类型。 网络类型由为集群指定的 `DBSubnetGroup` 确定。A `DBSubnetGroup` 只能支持 IPv4 协议或 IPv4 和 IPv6 协议 (`DUAL`)。 有关更多信息，请参阅《Amazon DocumentDB 开发人员指南》中 [VPC 中的 DocumentDB 集群](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html)。 有效值：`IPV4` \$1 `DUAL` 类型：字符串 必需：否 ** Port ** 新集群接受连接的端口号。 约束：必须是介于 `1150` 到 `65535` 的值。 默认：引擎的默认端口。 类型：整数 必需：否 ** RestoreToTime ** 要将集群还原到的日期和时间。 有效值：通用协调时间（UTC）格式的时间。 约束： + 必须在实例的最新可还原时间之前。 + 如果未提供 `UseLatestRestorableTime` 参数，则必须指定。 + 如果 `UseLatestRestorableTime` 参数为 `true`，则无法指定。 + 如果 `RestoreType` 参数为 `copy-on-write`，则无法指定。 示例：`2015-03-07T23:45:00Z` 类型：时间戳 必需：否 ** RestoreType ** 要执行的还原类型。可以指定以下值之一： + `full-copy`：新数据库集群作为源数据库集群的完整副本还原。 + `copy-on-write`：新数据库集群作为源数据库集群的克隆还原。 约束：如果源数据库群集的引擎版本早于 1.11，则不能指定 `copy-on-write`。 如果您没有指定 `RestoreType` 值，则新数据库集群作为源数据库集群的完整副本还原。 类型：字符串 必需：否 ** ServerlessV2ScalingConfiguration ** 包含 Amazon DocumentDB 无服务器集群的扩缩配置。 类型：[ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) 对象 必需：否 ** StorageType ** 与数据库集群关联的存储类型。 有关 Amazon DocumentDB 集群存储类型的信息，请参阅*《Amazon DocumentDB 开发人员指南》*中的集群存储配置。 存储类型的有效值：`standard | iopt1` 默认值为 `standard ` 类型：字符串 必需：否 **Tags.Tag.N** 要分配给所还原集群的标签。 类型：[Tag](API_Tag.md) 对象数组 必需：否 ** UseLatestRestorableTime ** 值设置为 `true` 时，将集群还原到最新可还原的备份时间，否则为 `false`。 默认值：`false` 约束：如果未提供 `RestoreToTime` 参数，则无法指定。 类型：布尔值 必需：否 **VpcSecurityGroupIds。 VpcSecurityGroupId.N** 新集群所属的 VPC 安全组的列表。 类型：字符串数组 必需：否 ## 响应元素 服务返回以下元素。 ** DBCluster ** 有关集群的详细信息。 类型：[DBCluster](API_DBCluster.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBClusterAlreadyExistsFault ** 用户已拥有具有给定标识符的集群。 HTTP 状态代码：400 ** DBClusterNotFoundFault ** `DBClusterIdentifier` 并不引用现有集群。 HTTP 状态代码：404 ** DBClusterQuotaExceededFault ** 无法创建集群，因为您已达到允许的集群最大配额。 HTTP 状态代码：403 ** DBClusterSnapshotNotFoundFault ** `DBClusterSnapshotIdentifier` 并不引用现有集群快照。 HTTP 状态代码：404 ** DBSubnetGroupNotFoundFault ** `DBSubnetGroupName` 并不引用现有子网组。 HTTP 状态代码：404 ** InsufficientDBClusterCapacityFault ** 集群没有足够的容量用于当前操作。 HTTP 状态代码：403 ** InsufficientStorageClusterCapacity ** 当前操作没有足够的可用存储空间。通过更新子网组来使用具有更多可用存储空间的不同可用区，可以解决此错误。 HTTP 状态代码：400 ** InvalidDBClusterSnapshotStateFault ** 提供的值不是有效的集群快照状态。 HTTP 状态代码：400 ** InvalidDBClusterStateFault ** 集群未处于有效状态。 HTTP 状态代码：400 ** InvalidDBSnapshotState ** 快照的状态不允许执行删除。 HTTP 状态代码：400 ** InvalidRestoreFault ** 您无法从虚拟私有云（VPC）备份恢复到非虚拟私有云（VPC）实例。 HTTP 状态代码：400 ** InvalidSubnet ** 请求的子网无效，或者请求的多个子网并非全部位于同一个常见虚拟私有云（VPC）中。 HTTP 状态代码：400 ** InvalidVPCNetworkStateFault ** 由于所做的更改，子网组在创建后并不会覆盖所有可用区。 HTTP 状态代码：400 ** KMSKeyNotAccessibleFault ** 访问 AWS KMS 密钥时出错。 HTTP 状态代码：400 ** NetworkTypeNotSupported ** `DBSubnetGroup` 或数据库引擎版本不支持该网络类型。 HTTP 状态代码：400 ** StorageQuotaExceeded ** 该请求会导致您超出跨所有实例可提供的已允许存储量。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RestoreDBClusterToPointInTime) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RestoreDBClusterToPointInTime) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RestoreDBClusterToPointInTime) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RestoreDBClusterToPointInTime) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RestoreDBClusterToPointInTime) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RestoreDBClusterToPointInTime) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RestoreDBClusterToPointInTime) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RestoreDBClusterToPointInTime) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RestoreDBClusterToPointInTime) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RestoreDBClusterToPointInTime) # StartDBCluster 重新启动 `DBClusterIdentifier` 指定的已停止集群。有关更多信息，请参阅[停止和启动 Amazon DocumentDB 集群](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html)。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBClusterIdentifier ** 要重启的集群的标识符。示例：`docdb-2019-05-28-15-24-52` 类型：字符串 是否必需：是 ## 响应元素 服务返回以下元素。 ** DBCluster ** 有关集群的详细信息。 类型：[DBCluster](API_DBCluster.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBClusterNotFoundFault ** `DBClusterIdentifier` 并不引用现有集群。 HTTP 状态代码：404 ** InvalidDBClusterStateFault ** 集群未处于有效状态。 HTTP 状态代码：400 ** InvalidDBInstanceState ** 指定的实例未处于*可用* 状态。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/StartDBCluster) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/StartDBCluster) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/StartDBCluster) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/StartDBCluster) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/StartDBCluster) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/StartDBCluster) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/StartDBCluster) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/StartDBCluster) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/StartDBCluster) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/StartDBCluster) # StopDBCluster 停止由 `DBClusterIdentifier` 指定的正在运行的集群。集群必须为*可用*状态。有关更多信息，请参阅[停止和启动 Amazon DocumentDB 集群](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html)。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** DBClusterIdentifier ** 停止集群的标识符。示例：`docdb-2019-05-28-15-24-52` 类型：字符串 是否必需：是 ## 响应元素 服务返回以下元素。 ** DBCluster ** 有关集群的详细信息。 类型：[DBCluster](API_DBCluster.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBClusterNotFoundFault ** `DBClusterIdentifier` 并不引用现有集群。 HTTP 状态代码：404 ** InvalidDBClusterStateFault ** 集群未处于有效状态。 HTTP 状态代码：400 ** InvalidDBInstanceState ** 指定的实例未处于*可用* 状态。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/StopDBCluster) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/StopDBCluster) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/StopDBCluster) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/StopDBCluster) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/StopDBCluster) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/StopDBCluster) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/StopDBCluster) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/StopDBCluster) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/StopDBCluster) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/StopDBCluster) # SwitchoverGlobalCluster 将指定的 Amazon DocumentDB 辅助集群切换为全局数据库集群中的 Amazon DocumentDB 新主集群。 ## 请求参数 有关所有操作的通用参数的信息，请参阅[通用参数](CommonParameters.md)。 ** GlobalClusterIdentifier ** 要切换的 Amazon DocumentDB 全局数据库集群的标识符。标识符是用户在创建集群时分配的唯一密钥。换句话说，这是全局集群的名称。该参数不区分大小写。 约束： + 必须与现有全局集群（Amazon DocumentDB 全局数据库）的标识符匹配。 + 最小长度为 1。最大长度为 255。 模式：`[A-Za-z][0-9A-Za-z-:._]*` 类型：字符串 长度限制：最小长度为 1。最大长度为 255。 模式：`[A-Za-z][0-9A-Za-z-:._]*` 是否必需：是 ** TargetDbClusterIdentifier ** 要提升为全局数据库集群的新主集群的 Amazon DocumentDB 辅助集群的标识符。使用亚马逊资源名称 (ARN) 作为标识符，这样 Amazon DocumentDB 就可以在其区域中找到集群。 AWS 约束： + 必须与现有辅助集群的标识符匹配。 + 最小长度为 1。最大长度为 255。 模式：`[A-Za-z][0-9A-Za-z-:._]*` 类型：字符串 长度限制：最小长度为 1。最大长度为 255。 模式：`[A-Za-z][0-9A-Za-z-:._]*` 是否必需：是 ## 响应元素 服务返回以下元素。 ** GlobalCluster ** 一种表示 Amazon DocumentDB 全球集群的数据类型。 类型：[GlobalCluster](API_GlobalCluster.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** DBClusterNotFoundFault ** `DBClusterIdentifier` 并不引用现有集群。 HTTP 状态代码：404 ** GlobalClusterNotFoundFault ** `GlobalClusterIdentifier` 并不引用现有全局集群。 HTTP 状态代码：404 ** InvalidDBClusterStateFault ** 集群未处于有效状态。 HTTP 状态代码：400 ** InvalidGlobalClusterStateFault ** 当集群处于这种状态时，无法执行请求的操作。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/SwitchoverGlobalCluster) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/SwitchoverGlobalCluster) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/SwitchoverGlobalCluster) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/SwitchoverGlobalCluster) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/SwitchoverGlobalCluster) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/SwitchoverGlobalCluster) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/SwitchoverGlobalCluster) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/SwitchoverGlobalCluster) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/SwitchoverGlobalCluster) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/SwitchoverGlobalCluster) # Amazon DocumentDB Elastic Clusters Amazon DocumentDB Elastic Clusters 支持以下操作： + [ApplyPendingMaintenanceAction](API_elastic_ApplyPendingMaintenanceAction.md) + [CopyClusterSnapshot](API_elastic_CopyClusterSnapshot.md) + [CreateCluster](API_elastic_CreateCluster.md) + [CreateClusterSnapshot](API_elastic_CreateClusterSnapshot.md) + [DeleteCluster](API_elastic_DeleteCluster.md) + [DeleteClusterSnapshot](API_elastic_DeleteClusterSnapshot.md) + [GetCluster](API_elastic_GetCluster.md) + [GetClusterSnapshot](API_elastic_GetClusterSnapshot.md) + [GetPendingMaintenanceAction](API_elastic_GetPendingMaintenanceAction.md) + [ListClusters](API_elastic_ListClusters.md) + [ListClusterSnapshots](API_elastic_ListClusterSnapshots.md) + [ListPendingMaintenanceActions](API_elastic_ListPendingMaintenanceActions.md) + [ListTagsForResource](API_elastic_ListTagsForResource.md) + [RestoreClusterFromSnapshot](API_elastic_RestoreClusterFromSnapshot.md) + [StartCluster](API_elastic_StartCluster.md) + [StopCluster](API_elastic_StopCluster.md) + [TagResource](API_elastic_TagResource.md) + [UntagResource](API_elastic_UntagResource.md) + [UpdateCluster](API_elastic_UpdateCluster.md) # ApplyPendingMaintenanceAction 要应用于此资源的待处理维护操作的类型。 ## 请求语法 ``` POST /pending-action HTTP/1.1 Content-type: application/json { "applyAction": "string", "applyOn": "string", "optInType": "string", "resourceArn": "string" } ``` ## URI 请求参数 该请求不使用任何 URI 参数。 ## 请求正文 请求接受采用 JSON 格式的以下数据。 ** [applyAction](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) ** 要应用于此资源的待处理维护操作。 有效的操作是： + `ENGINE_UPDATE ` + `ENGINE_UPGRADE` + `SECURITY_UPDATE` + `OS_UPDATE` + `MASTER_USER_PASSWORD_UPDATE` 类型：字符串 长度限制：最小长度为 1。最大长度为 256。 是否必需：是 ** [optInType](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) ** 用于指定加入请求类型或撤消加入请求的值。不能撤消 `IMMEDIATE` 类型的加入请求。 类型：字符串 有效值：`IMMEDIATE | NEXT_MAINTENANCE | APPLY_ON | UNDO_OPT_IN` 是否必需：是 ** [resourceArn](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) ** 待处理的维护操作应用于的资源的 Amazon DocumentDB Amazon 资源名称（ARN）。 类型：字符串 长度限制：最小长度为 1。最大长度为 256。 是否必需：是 ** [applyOn](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) ** 要应用待处理维护操作的具体日期。如果 opt-in-type 为 `APPLY_ON`，则必需。格式：`yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mm` 类型：字符串 长度限制：最小长度为 1。最大长度为 256。 必需：否 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "resourcePendingMaintenanceAction": { "pendingMaintenanceActionDetails": [ { "action": "string", "autoAppliedAfterDate": "string", "currentApplyDate": "string", "description": "string", "forcedApplyDate": "string", "optInStatus": "string" } ], "resourceArn": "string" } } ``` ## 响应元素 如果此操作成功，则该服务将会发送回 HTTP 200 响应。 服务以 JSON 格式返回以下数据。 ** [resourcePendingMaintenanceAction](#API_elastic_ApplyPendingMaintenanceAction_ResponseSyntax) ** 正在应用的待处理维护操作的输出。 类型：[ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** AccessDeniedException ** 没有足够权限执行某操作时出现的异常。 ** message ** 一条解释访问被拒绝原因的错误消息。 HTTP 状态代码：403 ** ConflictException ** 存在访问冲突。 ** resourceId ** 存在访问冲突的资源的 ID。 ** resourceType ** 存在访问冲突的资源的类型。 HTTP 状态代码：409 ** InternalServerException ** 出现内部服务器错误。 HTTP 状态代码：500 ** ResourceNotFoundException ** 不能定位指定的资源。 ** message ** 一条描述失败的错误消息。 ** resourceId ** 找不到的资源的 ID。 ** resourceType ** 找不到的资源的类型。 HTTP 状态代码：404 ** ThrottlingException ** ThrottlingException 当由于请求限制而导致请求被拒绝时，将抛出。 ** retryAfterSeconds ** 重试操作之前等待的秒数。 HTTP 状态代码：429 ** ValidationException ** 定义验证异常的结构。 ** fieldList ** 发生验证异常的字段列表。 ** message ** 一条描述验证异常的错误消息。 ** reason ** 发生验证异常的原因（`unknownOperation`、`cannotParse`、`fieldValidationFailed` 或 `other` 之一）。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) # CopyClusterSnapshot 复制弹性集群的快照。 ## 请求语法 ``` POST /cluster-snapshot/snapshotArn/copy HTTP/1.1 Content-type: application/json { "copyTags": boolean, "kmsKeyId": "string", "tags": { "string" : "string" }, "targetSnapshotName": "string" } ``` ## URI 请求参数 请求使用以下 URI 参数。 ** [snapshotArn](#API_elastic_CopyClusterSnapshot_RequestSyntax) ** 弹性集群快照的 Amazon 资源名称（ARN）标识符。 是否必需：是 ## 请求体 请求接受采用 JSON 格式的以下数据。 ** [targetSnapshotName](#API_elastic_CopyClusterSnapshot_RequestSyntax) ** 要从源集群快照创建的新弹性集群快照标识符​。此参数不区分大小写。 约束： + 必须包含 1 到 63 个字母、数字或连字符。 + 第一个字符必须是字母。 + 不能以连字符结尾或包含两个连续的连字符。 示例：`elastic-cluster-snapshot-5` 类型：字符串 长度限制：最小长度为 1。最大长度为 63。 是否必需：是 ** [copyTags](#API_elastic_CopyClusterSnapshot_RequestSyntax) ** 设置为 `true`，将源集群快照的所有标签复制到目标弹性集群快照。默认值为 `false`。 类型：布尔值 必需：否 ** [kmsKeyId](#API_elastic_CopyClusterSnapshot_RequestSyntax) ** 加密弹性集群快照的 AWS KMS 密钥 ID。 AWS KMS 密钥 ID 是亚马逊资源名称 (ARN)、 AWS KMS 密钥标识符或 KMS 加密密 AWS 钥的 KMS 密钥别名。 AWS 如果您从 AWS 账户中复制加密的弹性集群快照，则可以为`KmsKeyId`指定一个值，使用新的 S KM AWS S 加密密钥对副本进行加密。如果您不为 `KmsKeyId` 指定值，则使用与源弹性集群快照相同的 `AWS` KMS 密钥来加密弹性集群快照的副本。 如果您复制未加密的弹性集群快照并为 `KmsKeyId` 参数指定值，则会返回错误。 类型：字符串 必需：否 ** [tags](#API_elastic_CopyClusterSnapshot_RequestSyntax) ** 要分配给弹性集群快照的标签。 类型：字符串到字符串映射 密钥长度限制：最小长度为 1。最大长度为 128。 键模式：`(?!aws:)[a-zA-Z+-=._:/]+` 值长度限制：最小长度为 0。长度上限为 256。 必需：否 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "snapshot": { "adminUserName": "string", "clusterArn": "string", "clusterCreationTime": "string", "kmsKeyId": "string", "snapshotArn": "string", "snapshotCreationTime": "string", "snapshotName": "string", "snapshotType": "string", "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## 响应元素 如果此操作成功，则该服务将会发送回 HTTP 200 响应。 服务以 JSON 格式返回以下数据。 ** [snapshot](#API_elastic_CopyClusterSnapshot_ResponseSyntax) ** 返回有关特定弹性集群快照的信息。 类型：[ClusterSnapshot](API_elastic_ClusterSnapshot.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** AccessDeniedException ** 没有足够权限执行某操作时出现的异常。 ** message ** 一条解释访问被拒绝原因的错误消息。 HTTP 状态代码：403 ** ConflictException ** 存在访问冲突。 ** resourceId ** 存在访问冲突的资源的 ID。 ** resourceType ** 存在访问冲突的资源的类型。 HTTP 状态代码：409 ** InternalServerException ** 出现内部服务器错误。 HTTP 状态代码：500 ** ResourceNotFoundException ** 不能定位指定的资源。 ** message ** 一条描述失败的错误消息。 ** resourceId ** 找不到的资源的 ID。 ** resourceType ** 找不到的资源的类型。 HTTP 状态代码：404 ** ServiceQuotaExceededException ** 已超过该操作的服务限额。 HTTP 状态代码：402 ** ThrottlingException ** ThrottlingException 当由于请求限制而导致请求被拒绝时，将抛出。 ** retryAfterSeconds ** 重试操作之前等待的秒数。 HTTP 状态代码：429 ** ValidationException ** 定义验证异常的结构。 ** fieldList ** 发生验证异常的字段列表。 ** message ** 一条描述验证异常的错误消息。 ** reason ** 发生验证异常的原因（`unknownOperation`、`cannotParse`、`fieldValidationFailed` 或 `other` 之一）。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) # CreateCluster 创建新的 Amazon DocumentDB 弹性集群并返回其集群结构。 ## 请求语法 ``` POST /cluster HTTP/1.1 Content-type: application/json { "adminUserName": "string", "adminUserPassword": "string", "authType": "string", "backupRetentionPeriod": number, "clientToken": "string", "clusterName": "string", "kmsKeyId": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "subnetIds": [ "string" ], "tags": { "string" : "string" }, "vpcSecurityGroupIds": [ "string" ] } ``` ## URI 请求参数 该请求不使用任何 URI 参数。 ## 请求正文 请求接受采用 JSON 格式的以下数据。 ** [adminUserName](#API_elastic_CreateCluster_RequestSyntax) ** Amazon DocumentDB 弹性集群管理员的名称。 *约束*： + 必须为 1 到 63 个字母或数字。 + 第一个字符必须是字母。 + 不能使用保留关键字。 类型：字符串 是否必需：是 ** [adminUserPassword](#API_elastic_CreateCluster_RequestSyntax) ** Amazon DocumentDB 弹性集群管理员的密码。密码可以包含任何可打印的 ASCII 字符。 *约束*： + 必须包含 8 到 100 个字符。 + 不能包含正斜杠 (/)、双引号 (“) 或“在”符号 (@)。 类型：字符串 是否必需：是 ** [authType](#API_elastic_CreateCluster_RequestSyntax) ** 用于确定从何处获取用于访问弹性集群的密码的身份验证类型。有效的类型为 `PLAIN_TEXT` 或 `SECRET_ARN`。 类型：字符串 有效值：`PLAIN_TEXT | SECRET_ARN` 是否必需：是 ** [clusterName](#API_elastic_CreateCluster_RequestSyntax) ** 新弹性集群的名称。该参数作为一个小写字符串存储。 *约束*： + 必须包含 1 到 63 个字母、数字或连字符。 + 第一个字符必须是字母。 + 不能以连字符结尾或包含两个连续的连字符。 *示例*：`my-cluster` 类型：字符串 是否必需：是 ** [shardCapacity](#API_elastic_CreateCluster_RequestSyntax) ** CPUs 分配给每个弹性集群分片的 v 数。最大值为 64。允许值为 2、4、8、16、32、64。 类型：整数 是否必需：是 ** [shardCount](#API_elastic_CreateCluster_RequestSyntax) ** 分配给弹性集群的分片数目。最大值为 32。 类型：整数 是否必需：是 ** [backupRetentionPeriod](#API_elastic_CreateCluster_RequestSyntax) ** 自动快照的保留天数。 类型：整数 必需：否 ** [clientToken](#API_elastic_CreateCluster_RequestSyntax) ** 弹性集群的客户端令牌。 类型：字符串 必需：否 ** [kmsKeyId](#API_elastic_CreateCluster_RequestSyntax) ** 用于加密新弹性集群的 KMS 密钥标识符。 KMS 密钥标识符是 KMS 加密密钥的 Amazon 资源名称 (ARN)。如果使用拥有此 KMS 加密密钥的同一 Amazon 账户创建集群，则可以使用 KMS 密钥别名而不是 ARN 作为 KMS 加密密钥。 如果未指定加密密钥，Amazon DocumentDB 将使用 KMS 为您的账户创建的默认加密密钥。您的账户在每个 Amazon 区域都有一个不同的默认加密密钥。 类型：字符串 必需：否 ** [preferredBackupWindow](#API_elastic_CreateCluster_RequestSyntax) ** 在启用自动备份的情况下每日执行自动备份的时间范围，如 `backupRetentionPeriod` 所规定。 类型：字符串 必需：否 ** [preferredMaintenanceWindow](#API_elastic_CreateCluster_RequestSyntax) ** 可进行系统维护的每周时间范围（采用通用协调时间（UTC））。 *Format*: `ddd:hh24:mi-ddd:hh24:mi` *默认*：从每个 8 小时的时间段中随机选择一个 30 分钟的窗口 AWS 区域，发生在一周中的随机某一天。 *有效日*：Mon、Tue、Wed、Thu、Fri、Sat、Sun *约束*：至少为 30 分钟的时段。 类型：字符串 必需：否 ** [shardInstanceCount](#API_elastic_CreateCluster_RequestSyntax) ** 适用于弹性集群中所有分片的副本实例的数量。`shardInstanceCount` 值为 1 表示有一个写入器实例，其他任何实例都是可用于读取和提高可用性的副本。 类型：整数 必需：否 ** [subnetIds](#API_elastic_CreateCluster_RequestSyntax) ** 新弹性集群的 Amazon EC2 子网 IDs 。 类型：字符串数组 必需：否 ** [tags](#API_elastic_CreateCluster_RequestSyntax) ** 要分配给新弹性集群的标签。 类型：字符串到字符串映射 密钥长度限制：最小长度为 1。最大长度为 128。 键模式：`(?!aws:)[a-zA-Z+-=._:/]+` 值长度限制：最小长度为 0。长度上限为 256。 必需：否 ** [vpcSecurityGroupIds](#API_elastic_CreateCluster_RequestSyntax) ** 要与新弹性集群关联的 EC2 VPC 安全组的列表。 类型：字符串数组 必需：否 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "cluster": { "adminUserName": "string", "authType": "string", "backupRetentionPeriod": number, "clusterArn": "string", "clusterEndpoint": "string", "clusterName": "string", "createTime": "string", "kmsKeyId": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "shards": [ { "createTime": "string", "shardId": "string", "status": "string" } ], "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## 响应元素 如果此操作成功，则该服务将会发送回 HTTP 200 响应。 服务以 JSON 格式返回以下数据。 ** [cluster](#API_elastic_CreateCluster_ResponseSyntax) ** 已创建的新弹性集群。 类型：[Cluster](API_elastic_Cluster.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** AccessDeniedException ** 没有足够权限执行某操作时出现的异常。 ** message ** 一条解释访问被拒绝原因的错误消息。 HTTP 状态代码：403 ** ConflictException ** 存在访问冲突。 ** resourceId ** 存在访问冲突的资源的 ID。 ** resourceType ** 存在访问冲突的资源的类型。 HTTP 状态代码：409 ** InternalServerException ** 出现内部服务器错误。 HTTP 状态代码：500 ** ServiceQuotaExceededException ** 已超过该操作的服务限额。 HTTP 状态代码：402 ** ThrottlingException ** ThrottlingException 当由于请求限制而导致请求被拒绝时，将抛出。 ** retryAfterSeconds ** 重试操作之前等待的秒数。 HTTP 状态代码：429 ** ValidationException ** 定义验证异常的结构。 ** fieldList ** 发生验证异常的字段列表。 ** message ** 一条描述验证异常的错误消息。 ** reason ** 发生验证异常的原因（`unknownOperation`、`cannotParse`、`fieldValidationFailed` 或 `other` 之一）。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CreateCluster) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CreateCluster) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CreateCluster) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateCluster) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateCluster) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CreateCluster) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CreateCluster) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateCluster) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CreateCluster) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CreateCluster) # CreateClusterSnapshot 创建弹性集群的快照。 ## 请求语法 ``` POST /cluster-snapshot HTTP/1.1 Content-type: application/json { "clusterArn": "string", "snapshotName": "string", "tags": { "string" : "string" } } ``` ## URI 请求参数 该请求不使用任何 URI 参数。 ## 请求正文 请求接受采用 JSON 格式的以下数据。 ** [clusterArn](#API_elastic_CreateClusterSnapshot_RequestSyntax) ** 您想要创建其快照的弹性集群的 ARN 标识符。 类型：字符串 是否必需：是 ** [snapshotName](#API_elastic_CreateClusterSnapshot_RequestSyntax) ** 新的弹性集群快照的名称。 类型：字符串 长度限制：最小长度为 1。最大长度为 63。 是否必需：是 ** [tags](#API_elastic_CreateClusterSnapshot_RequestSyntax) ** 要分配给新的弹性集群快照的标签。 类型：字符串到字符串映射 密钥长度限制：最小长度为 1。最大长度为 128。 键模式：`(?!aws:)[a-zA-Z+-=._:/]+` 值长度限制：最小长度为 0。长度上限为 256。 必需：否 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "snapshot": { "adminUserName": "string", "clusterArn": "string", "clusterCreationTime": "string", "kmsKeyId": "string", "snapshotArn": "string", "snapshotCreationTime": "string", "snapshotName": "string", "snapshotType": "string", "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## 响应元素 如果此操作成功，则该服务将会发送回 HTTP 200 响应。 服务以 JSON 格式返回以下数据。 ** [snapshot](#API_elastic_CreateClusterSnapshot_ResponseSyntax) ** 返回有关新的弹性集群快照的信息。 类型：[ClusterSnapshot](API_elastic_ClusterSnapshot.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** AccessDeniedException ** 没有足够权限执行某操作时出现的异常。 ** message ** 一条解释访问被拒绝原因的错误消息。 HTTP 状态代码：403 ** ConflictException ** 存在访问冲突。 ** resourceId ** 存在访问冲突的资源的 ID。 ** resourceType ** 存在访问冲突的资源的类型。 HTTP 状态代码：409 ** InternalServerException ** 出现内部服务器错误。 HTTP 状态代码：500 ** ResourceNotFoundException ** 不能定位指定的资源。 ** message ** 一条描述失败的错误消息。 ** resourceId ** 找不到的资源的 ID。 ** resourceType ** 找不到的资源的类型。 HTTP 状态代码：404 ** ServiceQuotaExceededException ** 已超过该操作的服务限额。 HTTP 状态代码：402 ** ThrottlingException ** ThrottlingException 当由于请求限制而导致请求被拒绝时，将抛出。 ** retryAfterSeconds ** 重试操作之前等待的秒数。 HTTP 状态代码：429 ** ValidationException ** 定义验证异常的结构。 ** fieldList ** 发生验证异常的字段列表。 ** message ** 一条描述验证异常的错误消息。 ** reason ** 发生验证异常的原因（`unknownOperation`、`cannotParse`、`fieldValidationFailed` 或 `other` 之一）。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) # DeleteCluster 删除弹性集群。 ## 请求语法 ``` DELETE /cluster/clusterArn HTTP/1.1 ``` ## URI 请求参数 请求使用以下 URI 参数。 ** [clusterArn](#API_elastic_DeleteCluster_RequestSyntax) ** 待删除弹性集群的 ARN 标识符。 是否必需：是 ## 请求体 该请求没有请求正文。 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "cluster": { "adminUserName": "string", "authType": "string", "backupRetentionPeriod": number, "clusterArn": "string", "clusterEndpoint": "string", "clusterName": "string", "createTime": "string", "kmsKeyId": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "shards": [ { "createTime": "string", "shardId": "string", "status": "string" } ], "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## 响应元素 如果此操作成功，则该服务将会发送回 HTTP 200 响应。 服务以 JSON 格式返回以下数据。 ** [cluster](#API_elastic_DeleteCluster_ResponseSyntax) ** 返回有关已新删除弹性集群的信息。 类型：[Cluster](API_elastic_Cluster.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** AccessDeniedException ** 没有足够权限执行某操作时出现的异常。 ** message ** 一条解释访问被拒绝原因的错误消息。 HTTP 状态代码：403 ** ConflictException ** 存在访问冲突。 ** resourceId ** 存在访问冲突的资源的 ID。 ** resourceType ** 存在访问冲突的资源的类型。 HTTP 状态代码：409 ** InternalServerException ** 出现内部服务器错误。 HTTP 状态代码：500 ** ResourceNotFoundException ** 不能定位指定的资源。 ** message ** 一条描述失败的错误消息。 ** resourceId ** 找不到的资源的 ID。 ** resourceType ** 找不到的资源的类型。 HTTP 状态代码：404 ** ThrottlingException ** ThrottlingException 当由于请求限制而导致请求被拒绝时，将抛出。 ** retryAfterSeconds ** 重试操作之前等待的秒数。 HTTP 状态代码：429 ** ValidationException ** 定义验证异常的结构。 ** fieldList ** 发生验证异常的字段列表。 ** message ** 一条描述验证异常的错误消息。 ** reason ** 发生验证异常的原因（`unknownOperation`、`cannotParse`、`fieldValidationFailed` 或 `other` 之一）。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/DeleteCluster) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/DeleteCluster) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/DeleteCluster) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteCluster) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteCluster) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/DeleteCluster) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/DeleteCluster) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteCluster) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/DeleteCluster) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/DeleteCluster) # DeleteClusterSnapshot 删除弹性集群快照。 ## 请求语法 ``` DELETE /cluster-snapshot/snapshotArn HTTP/1.1 ``` ## URI 请求参数 请求使用以下 URI 参数。 ** [snapshotArn](#API_elastic_DeleteClusterSnapshot_RequestSyntax) ** 待删除弹性集群快照的 ARN 标识符。 是否必需：是 ## 请求体 该请求没有请求正文。 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "snapshot": { "adminUserName": "string", "clusterArn": "string", "clusterCreationTime": "string", "kmsKeyId": "string", "snapshotArn": "string", "snapshotCreationTime": "string", "snapshotName": "string", "snapshotType": "string", "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## 响应元素 如果此操作成功，则该服务将会发送回 HTTP 200 响应。 服务以 JSON 格式返回以下数据。 ** [snapshot](#API_elastic_DeleteClusterSnapshot_ResponseSyntax) ** 返回有关已新删除弹性集群快照的信息。 类型：[ClusterSnapshot](API_elastic_ClusterSnapshot.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** AccessDeniedException ** 没有足够权限执行某操作时出现的异常。 ** message ** 一条解释访问被拒绝原因的错误消息。 HTTP 状态代码：403 ** ConflictException ** 存在访问冲突。 ** resourceId ** 存在访问冲突的资源的 ID。 ** resourceType ** 存在访问冲突的资源的类型。 HTTP 状态代码：409 ** InternalServerException ** 出现内部服务器错误。 HTTP 状态代码：500 ** ResourceNotFoundException ** 不能定位指定的资源。 ** message ** 一条描述失败的错误消息。 ** resourceId ** 找不到的资源的 ID。 ** resourceType ** 找不到的资源的类型。 HTTP 状态代码：404 ** ThrottlingException ** ThrottlingException 当由于请求限制而导致请求被拒绝时，将抛出。 ** retryAfterSeconds ** 重试操作之前等待的秒数。 HTTP 状态代码：429 ** ValidationException ** 定义验证异常的结构。 ** fieldList ** 发生验证异常的字段列表。 ** message ** 一条描述验证异常的错误消息。 ** reason ** 发生验证异常的原因（`unknownOperation`、`cannotParse`、`fieldValidationFailed` 或 `other` 之一）。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) # GetCluster 返回有关特定弹性集群的信息。 ## 请求语法 ``` GET /cluster/clusterArn HTTP/1.1 ``` ## URI 请求参数 请求使用以下 URI 参数。 ** [clusterArn](#API_elastic_GetCluster_RequestSyntax) ** 弹性集群的 ARN 标识符。 是否必需：是 ## 请求体 该请求没有请求正文。 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "cluster": { "adminUserName": "string", "authType": "string", "backupRetentionPeriod": number, "clusterArn": "string", "clusterEndpoint": "string", "clusterName": "string", "createTime": "string", "kmsKeyId": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "shards": [ { "createTime": "string", "shardId": "string", "status": "string" } ], "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## 响应元素 如果此操作成功，则该服务将会发送回 HTTP 200 响应。 服务以 JSON 格式返回以下数据。 ** [cluster](#API_elastic_GetCluster_ResponseSyntax) ** 返回有关特定弹性集群的信息。 类型：[Cluster](API_elastic_Cluster.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** AccessDeniedException ** 没有足够权限执行某操作时出现的异常。 ** message ** 一条解释访问被拒绝原因的错误消息。 HTTP 状态代码：403 ** InternalServerException ** 出现内部服务器错误。 HTTP 状态代码：500 ** ResourceNotFoundException ** 不能定位指定的资源。 ** message ** 一条描述失败的错误消息。 ** resourceId ** 找不到的资源的 ID。 ** resourceType ** 找不到的资源的类型。 HTTP 状态代码：404 ** ThrottlingException ** ThrottlingException 当由于请求限制而导致请求被拒绝时，将抛出。 ** retryAfterSeconds ** 重试操作之前等待的秒数。 HTTP 状态代码：429 ** ValidationException ** 定义验证异常的结构。 ** fieldList ** 发生验证异常的字段列表。 ** message ** 一条描述验证异常的错误消息。 ** reason ** 发生验证异常的原因（`unknownOperation`、`cannotParse`、`fieldValidationFailed` 或 `other` 之一）。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetCluster) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetCluster) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetCluster) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetCluster) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetCluster) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetCluster) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetCluster) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetCluster) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetCluster) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetCluster) # GetClusterSnapshot 返回有关特定弹性集群快照的信息 ## 请求语法 ``` GET /cluster-snapshot/snapshotArn HTTP/1.1 ``` ## URI 请求参数 请求使用以下 URI 参数。 ** [snapshotArn](#API_elastic_GetClusterSnapshot_RequestSyntax) ** 弹性集群快照的标识符。 是否必需：是 ## 请求体 该请求没有请求正文。 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "snapshot": { "adminUserName": "string", "clusterArn": "string", "clusterCreationTime": "string", "kmsKeyId": "string", "snapshotArn": "string", "snapshotCreationTime": "string", "snapshotName": "string", "snapshotType": "string", "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## 响应元素 如果此操作成功，则该服务将会发送回 HTTP 200 响应。 服务以 JSON 格式返回以下数据。 ** [snapshot](#API_elastic_GetClusterSnapshot_ResponseSyntax) ** 返回有关特定弹性集群快照的信息。 类型：[ClusterSnapshot](API_elastic_ClusterSnapshot.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** AccessDeniedException ** 没有足够权限执行某操作时出现的异常。 ** message ** 一条解释访问被拒绝原因的错误消息。 HTTP 状态代码：403 ** InternalServerException ** 出现内部服务器错误。 HTTP 状态代码：500 ** ResourceNotFoundException ** 不能定位指定的资源。 ** message ** 一条描述失败的错误消息。 ** resourceId ** 找不到的资源的 ID。 ** resourceType ** 找不到的资源的类型。 HTTP 状态代码：404 ** ThrottlingException ** ThrottlingException 当由于请求限制而导致请求被拒绝时，将抛出。 ** retryAfterSeconds ** 重试操作之前等待的秒数。 HTTP 状态代码：429 ** ValidationException ** 定义验证异常的结构。 ** fieldList ** 发生验证异常的字段列表。 ** message ** 一条描述验证异常的错误消息。 ** reason ** 发生验证异常的原因（`unknownOperation`、`cannotParse`、`fieldValidationFailed` 或 `other` 之一）。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetClusterSnapshot) # GetPendingMaintenanceAction 检索待处理的所有维护操作。 ## 请求语法 ``` GET /pending-action/resourceArn HTTP/1.1 ``` ## URI 请求参数 请求使用以下 URI 参数。 ** [resourceArn](#API_elastic_GetPendingMaintenanceAction_RequestSyntax) ** 检索特定 Amazon 资源名称（ARN）的待处理维护操作。 长度限制：最小长度为 1。最大长度为 256。 是否必需：是 ## 请求体 该请求没有请求正文。 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "resourcePendingMaintenanceAction": { "pendingMaintenanceActionDetails": [ { "action": "string", "autoAppliedAfterDate": "string", "currentApplyDate": "string", "description": "string", "forcedApplyDate": "string", "optInStatus": "string" } ], "resourceArn": "string" } } ``` ## 响应元素 如果此操作成功，则该服务将会发送回 HTTP 200 响应。 服务以 JSON 格式返回以下数据。 ** [resourcePendingMaintenanceAction](#API_elastic_GetPendingMaintenanceAction_ResponseSyntax) ** 提供有关资源的待处理维护操作的信息。 类型：[ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** AccessDeniedException ** 没有足够权限执行某操作时出现的异常。 ** message ** 一条解释访问被拒绝原因的错误消息。 HTTP 状态代码：403 ** ConflictException ** 存在访问冲突。 ** resourceId ** 存在访问冲突的资源的 ID。 ** resourceType ** 存在访问冲突的资源的类型。 HTTP 状态代码：409 ** InternalServerException ** 出现内部服务器错误。 HTTP 状态代码：500 ** ResourceNotFoundException ** 不能定位指定的资源。 ** message ** 一条描述失败的错误消息。 ** resourceId ** 找不到的资源的 ID。 ** resourceType ** 找不到的资源的类型。 HTTP 状态代码：404 ** ThrottlingException ** ThrottlingException 当由于请求限制而导致请求被拒绝时，将抛出。 ** retryAfterSeconds ** 重试操作之前等待的秒数。 HTTP 状态代码：429 ** ValidationException ** 定义验证异常的结构。 ** fieldList ** 发生验证异常的字段列表。 ** message ** 一条描述验证异常的错误消息。 ** reason ** 发生验证异常的原因（`unknownOperation`、`cannotParse`、`fieldValidationFailed` 或 `other` 之一）。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) # ListClusters 返回有关预配置的 Amazon DocumentDB 弹性集群的信息。 ## 请求语法 ``` GET /clusters?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI 请求参数 请求使用以下 URI 参数。 ** [maxResults](#API_elastic_ListClusters_RequestSyntax) ** 在响应中接收的弹性集群快照结果的最大数量。 有效范围：最小值为 1。最大值为 100。 ** [nextToken](#API_elastic_ListClusters_RequestSyntax) ** 由之前的请求提供的分页标记。如果指定此参数，则响应仅包含该标记之外的记录，最大数量为 `max-results` 指定的值。 如果响应中没有更多数据，则不会返回 `nextToken`。 ## 请求正文 该请求没有请求正文。 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "clusters": [ { "clusterArn": "string", "clusterName": "string", "status": "string" } ], "nextToken": "string" } ``` ## 响应元素 如果此操作成功，则该服务将会发送回 HTTP 200 响应。 服务以 JSON 格式返回以下数据。 ** [clusters](#API_elastic_ListClusters_ResponseSyntax) ** Amazon DocumentDB 弹性集群的列表 类型：[ClusterInList](API_elastic_ClusterInList.md) 对象数组 ** [nextToken](#API_elastic_ListClusters_ResponseSyntax) ** 由之前的请求提供的分页标记。如果指定此参数，则响应仅包含该标记之外的记录，最大数量为 `max-results` 指定的值。 如果响应中没有更多数据，则不会返回 `nextToken`。 类型：字符串 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** AccessDeniedException ** 没有足够权限执行某操作时出现的异常。 ** message ** 一条解释访问被拒绝原因的错误消息。 HTTP 状态代码：403 ** InternalServerException ** 出现内部服务器错误。 HTTP 状态代码：500 ** ThrottlingException ** ThrottlingException 当由于请求限制而导致请求被拒绝时，将抛出。 ** retryAfterSeconds ** 重试操作之前等待的秒数。 HTTP 状态代码：429 ** ValidationException ** 定义验证异常的结构。 ** fieldList ** 发生验证异常的字段列表。 ** message ** 一条描述验证异常的错误消息。 ** reason ** 发生验证异常的原因（`unknownOperation`、`cannotParse`、`fieldValidationFailed` 或 `other` 之一）。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusters) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusters) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusters) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusters) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusters) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusters) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusters) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusters) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusters) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusters) # ListClusterSnapshots 返回有关指定弹性集群的快照的信息。 ## 请求语法 ``` GET /cluster-snapshots?clusterArn=clusterArn&maxResults=maxResults&nextToken=nextToken&snapshotType=snapshotType HTTP/1.1 ``` ## URI 请求参数 请求使用以下 URI 参数。 ** [clusterArn](#API_elastic_ListClusterSnapshots_RequestSyntax) ** 弹性集群的 ARN 标识符。 ** [maxResults](#API_elastic_ListClusterSnapshots_RequestSyntax) ** 在响应中接收的弹性集群快照结果的最大数量。 有效范围：最小值为 20。最大值为 100。 ** [nextToken](#API_elastic_ListClusterSnapshots_RequestSyntax) ** 由之前的请求提供的分页标记。如果指定此参数，则响应仅包含该标记之外的记录，最大数量为 `max-results` 指定的值。 如果响应中没有更多数据，则不会返回 `nextToken`。 ** [snapshotType](#API_elastic_ListClusterSnapshots_RequestSyntax) ** 要返回的集群快照的类型。可以指定以下值之一： + `automated`-返回 Amazon DocumentDB 自动为您的 AWS 账户创建的所有集群快照。 + `manual`-返回您为 AWS 账户手动创建的所有集群快照。 ## 请求正文 该请求没有请求正文。 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "snapshots": [ { "clusterArn": "string", "snapshotArn": "string", "snapshotCreationTime": "string", "snapshotName": "string", "status": "string" } ] } ``` ## 响应元素 如果此操作成功，则该服务将会发送回 HTTP 200 响应。 服务以 JSON 格式返回以下数据。 ** [nextToken](#API_elastic_ListClusterSnapshots_ResponseSyntax) ** 由之前的请求提供的分页标记。如果指定此参数，则响应仅包含该标记之外的记录，最大数量为 `max-results` 指定的值。 如果响应中没有更多数据，则不会返回 `nextToken`。 类型：字符串 ** [snapshots](#API_elastic_ListClusterSnapshots_ResponseSyntax) ** 指定弹性集群的快照列表。 类型：[ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md) 对象数组 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** AccessDeniedException ** 没有足够权限执行某操作时出现的异常。 ** message ** 一条解释访问被拒绝原因的错误消息。 HTTP 状态代码：403 ** InternalServerException ** 出现内部服务器错误。 HTTP 状态代码：500 ** ThrottlingException ** ThrottlingException 当由于请求限制而导致请求被拒绝时，将抛出。 ** retryAfterSeconds ** 重试操作之前等待的秒数。 HTTP 状态代码：429 ** ValidationException ** 定义验证异常的结构。 ** fieldList ** 发生验证异常的字段列表。 ** message ** 一条描述验证异常的错误消息。 ** reason ** 发生验证异常的原因（`unknownOperation`、`cannotParse`、`fieldValidationFailed` 或 `other` 之一）。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusterSnapshots) # ListPendingMaintenanceActions 检索待处理的所有维护操作的列表。 ## 请求语法 ``` GET /pending-actions?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI 请求参数 请求使用以下 URI 参数。 ** [maxResults](#API_elastic_ListPendingMaintenanceActions_RequestSyntax) ** 包括在响应中的最大记录数。如果存在的记录数超过了指定的`maxResults` 值，则在响应中包含分页记号（标记），以便检索剩余的结果。 有效范围：最小值为 1。最大值为 100。 ** [nextToken](#API_elastic_ListPendingMaintenanceActions_RequestSyntax) ** 由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `maxResults` 指定的值。 ## 请求正文 该请求没有请求正文。 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "resourcePendingMaintenanceActions": [ { "pendingMaintenanceActionDetails": [ { "action": "string", "autoAppliedAfterDate": "string", "currentApplyDate": "string", "description": "string", "forcedApplyDate": "string", "optInStatus": "string" } ], "resourceArn": "string" } ] } ``` ## 响应元素 如果此操作成功，则该服务将会发送回 HTTP 200 响应。 服务以 JSON 格式返回以下数据。 ** [resourcePendingMaintenanceActions](#API_elastic_ListPendingMaintenanceActions_ResponseSyntax) ** 提供有关资源的待处理维护操作的信息。 类型：[ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) 对象数组 ** [nextToken](#API_elastic_ListPendingMaintenanceActions_ResponseSyntax) ** 由之前的请求提供的可选分页标记。如果显示此参数，则响应将仅包含标记之外的记录，最大数量为 `maxResults` 指定的值。 类型：字符串 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** AccessDeniedException ** 没有足够权限执行某操作时出现的异常。 ** message ** 一条解释访问被拒绝原因的错误消息。 HTTP 状态代码：403 ** InternalServerException ** 出现内部服务器错误。 HTTP 状态代码：500 ** ThrottlingException ** ThrottlingException 当由于请求限制而导致请求被拒绝时，将抛出。 ** retryAfterSeconds ** 重试操作之前等待的秒数。 HTTP 状态代码：429 ** ValidationException ** 定义验证异常的结构。 ** fieldList ** 发生验证异常的字段列表。 ** message ** 一条描述验证异常的错误消息。 ** reason ** 发生验证异常的原因（`unknownOperation`、`cannotParse`、`fieldValidationFailed` 或 `other` 之一）。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) # ListTagsForResource 列出弹性集群资源上的所有标签 ## 请求语法 ``` GET /tags/resourceArn HTTP/1.1 ``` ## URI 请求参数 请求使用以下 URI 参数。 ** [resourceArn](#API_elastic_ListTagsForResource_RequestSyntax) ** 弹性集群资源的 ARN 标识符。 长度限制：最小长度为 1。最大长度为 1011。 是否必需：是 ## 请求体 该请求没有请求正文。 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "tags": { "string" : "string" } } ``` ## 响应元素 如果此操作成功，则该服务将会发送回 HTTP 200 响应。 服务以 JSON 格式返回以下数据。 ** [tags](#API_elastic_ListTagsForResource_ResponseSyntax) ** 指定弹性集群资源的标签列表。 类型：字符串到字符串映射 密钥长度限制：最小长度为 1。最大长度为 128。 键模式：`(?!aws:)[a-zA-Z+-=._:/]+` 值长度限制：最小长度为 0。最大长度为 256。 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** InternalServerException ** 出现内部服务器错误。 HTTP 状态代码：500 ** ResourceNotFoundException ** 不能定位指定的资源。 ** message ** 一条描述失败的错误消息。 ** resourceId ** 找不到的资源的 ID。 ** resourceType ** 找不到的资源的类型。 HTTP 状态代码：404 ** ThrottlingException ** ThrottlingException 当由于请求限制而导致请求被拒绝时，将抛出。 ** retryAfterSeconds ** 重试操作之前等待的秒数。 HTTP 状态代码：429 ** ValidationException ** 定义验证异常的结构。 ** fieldList ** 发生验证异常的字段列表。 ** message ** 一条描述验证异常的错误消息。 ** reason ** 发生验证异常的原因（`unknownOperation`、`cannotParse`、`fieldValidationFailed` 或 `other` 之一）。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListTagsForResource) # RestoreClusterFromSnapshot 从快照还原弹性集群 ## 请求语法 ``` POST /cluster-snapshot/snapshotArn/restore HTTP/1.1 Content-type: application/json { "clusterName": "string", "kmsKeyId": "string", "shardCapacity": number, "shardInstanceCount": number, "subnetIds": [ "string" ], "tags": { "string" : "string" }, "vpcSecurityGroupIds": [ "string" ] } ``` ## URI 请求参数 请求使用以下 URI 参数。 ** [snapshotArn](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** 弹性集群快照的标识符。 是否必需：是 ## 请求体 请求接受采用 JSON 格式的以下数据。 ** [clusterName](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** 弹性集群的名称。 类型：字符串 是否必需：是 ** [kmsKeyId](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** 用于加密新 Amazon DocumentDB 弹性集群的 KMS 密钥标识符。 KMS 密钥标识符是 KMS 加密密钥的 Amazon 资源名称 (ARN)。如果使用拥有此 KMS 加密密钥的同一 Amazon 账户创建集群，则可以使用 KMS 密钥别名而不是 ARN 作为 KMS 加密密钥。 如果此处未指定加密密钥，Amazon DocumentDB 将使用 KMS 为您的账户创建的默认加密密钥。您的账户在每个 Amazon 区域都有一个不同的默认加密密钥。 类型：字符串 必需：否 ** [shardCapacity](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** 新恢复的弹性集群中每个分片的容量。 类型：整数 必需：否 ** [shardInstanceCount](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** 适用于弹性集群中所有分片的副本实例的数量。`shardInstanceCount` 值为 1 表示有一个写入器实例，其他任何实例都是可用于读取和提高可用性的副本。 类型：整数 必需：否 ** [subnetIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** 弹性集群的 Amazon EC2 子网 IDs 。 类型：字符串数组 必需：否 ** [tags](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** 待分配给已恢复弹性集群的标签名称列表，处于其中键是标签名称且值为键值的键-值对数组形式。 类型：字符串到字符串映射 密钥长度限制：最小长度为 1。最大长度为 128。 键模式：`(?!aws:)[a-zA-Z+-=._:/]+` 值长度限制：最小长度为 0。长度上限为 256。 必需：否 ** [vpcSecurityGroupIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** 要与弹性集群关联的 EC2 VPC 安全组的列表。 类型：字符串数组 必需：否 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "cluster": { "adminUserName": "string", "authType": "string", "backupRetentionPeriod": number, "clusterArn": "string", "clusterEndpoint": "string", "clusterName": "string", "createTime": "string", "kmsKeyId": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "shards": [ { "createTime": "string", "shardId": "string", "status": "string" } ], "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## 响应元素 如果此操作成功，则该服务将会发送回 HTTP 200 响应。 服务以 JSON 格式返回以下数据。 ** [cluster](#API_elastic_RestoreClusterFromSnapshot_ResponseSyntax) ** 返回有关已恢复弹性集群的信息。 类型：[Cluster](API_elastic_Cluster.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** AccessDeniedException ** 没有足够权限执行某操作时出现的异常。 ** message ** 一条解释访问被拒绝原因的错误消息。 HTTP 状态代码：403 ** ConflictException ** 存在访问冲突。 ** resourceId ** 存在访问冲突的资源的 ID。 ** resourceType ** 存在访问冲突的资源的类型。 HTTP 状态代码：409 ** InternalServerException ** 出现内部服务器错误。 HTTP 状态代码：500 ** ResourceNotFoundException ** 不能定位指定的资源。 ** message ** 一条描述失败的错误消息。 ** resourceId ** 找不到的资源的 ID。 ** resourceType ** 找不到的资源的类型。 HTTP 状态代码：404 ** ServiceQuotaExceededException ** 已超过该操作的服务限额。 HTTP 状态代码：402 ** ThrottlingException ** ThrottlingException 当由于请求限制而导致请求被拒绝时，将抛出。 ** retryAfterSeconds ** 重试操作之前等待的秒数。 HTTP 状态代码：429 ** ValidationException ** 定义验证异常的结构。 ** fieldList ** 发生验证异常的字段列表。 ** message ** 一条描述验证异常的错误消息。 ** reason ** 发生验证异常的原因（`unknownOperation`、`cannotParse`、`fieldValidationFailed` 或 `other` 之一）。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) # StartCluster 重新启动 `clusterARN` 指定的已停止弹性集群。 ## 请求语法 ``` POST /cluster/clusterArn/start HTTP/1.1 ``` ## URI 请求参数 请求使用以下 URI 参数。 ** [clusterArn](#API_elastic_StartCluster_RequestSyntax) ** 弹性集群的 ARN 标识符。 是否必需：是 ## 请求体 该请求没有请求正文。 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "cluster": { "adminUserName": "string", "authType": "string", "backupRetentionPeriod": number, "clusterArn": "string", "clusterEndpoint": "string", "clusterName": "string", "createTime": "string", "kmsKeyId": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "shards": [ { "createTime": "string", "shardId": "string", "status": "string" } ], "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## 响应元素 如果此操作成功，则该服务将会发送回 HTTP 200 响应。 服务以 JSON 格式返回以下数据。 ** [cluster](#API_elastic_StartCluster_ResponseSyntax) ** 返回有关特定弹性集群的信息。 类型：[Cluster](API_elastic_Cluster.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** AccessDeniedException ** 没有足够权限执行某操作时出现的异常。 ** message ** 一条解释访问被拒绝原因的错误消息。 HTTP 状态代码：403 ** InternalServerException ** 出现内部服务器错误。 HTTP 状态代码：500 ** ResourceNotFoundException ** 不能定位指定的资源。 ** message ** 一条描述失败的错误消息。 ** resourceId ** 找不到的资源的 ID。 ** resourceType ** 找不到的资源的类型。 HTTP 状态代码：404 ** ThrottlingException ** ThrottlingException 当由于请求限制而导致请求被拒绝时，将抛出。 ** retryAfterSeconds ** 重试操作之前等待的秒数。 HTTP 状态代码：429 ** ValidationException ** 定义验证异常的结构。 ** fieldList ** 发生验证异常的字段列表。 ** message ** 一条描述验证异常的错误消息。 ** reason ** 发生验证异常的原因（`unknownOperation`、`cannotParse`、`fieldValidationFailed` 或 `other` 之一）。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/StartCluster) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/StartCluster) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/StartCluster) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StartCluster) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StartCluster) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/StartCluster) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/StartCluster) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StartCluster) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/StartCluster) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/StartCluster) # StopCluster 停止由 `clusterArn` 指定的正在运行的弹性集群。弹性集群必须处于*可用*状态。 ## 请求语法 ``` POST /cluster/clusterArn/stop HTTP/1.1 ``` ## URI 请求参数 请求使用以下 URI 参数。 ** [clusterArn](#API_elastic_StopCluster_RequestSyntax) ** 弹性集群的 ARN 标识符。 是否必需：是 ## 请求体 该请求没有请求正文。 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "cluster": { "adminUserName": "string", "authType": "string", "backupRetentionPeriod": number, "clusterArn": "string", "clusterEndpoint": "string", "clusterName": "string", "createTime": "string", "kmsKeyId": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "shards": [ { "createTime": "string", "shardId": "string", "status": "string" } ], "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## 响应元素 如果此操作成功，则该服务将会发送回 HTTP 200 响应。 服务以 JSON 格式返回以下数据。 ** [cluster](#API_elastic_StopCluster_ResponseSyntax) ** 返回有关特定弹性集群的信息。 类型：[Cluster](API_elastic_Cluster.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** AccessDeniedException ** 没有足够权限执行某操作时出现的异常。 ** message ** 一条解释访问被拒绝原因的错误消息。 HTTP 状态代码：403 ** InternalServerException ** 出现内部服务器错误。 HTTP 状态代码：500 ** ResourceNotFoundException ** 不能定位指定的资源。 ** message ** 一条描述失败的错误消息。 ** resourceId ** 找不到的资源的 ID。 ** resourceType ** 找不到的资源的类型。 HTTP 状态代码：404 ** ThrottlingException ** ThrottlingException 当由于请求限制而导致请求被拒绝时，将抛出。 ** retryAfterSeconds ** 重试操作之前等待的秒数。 HTTP 状态代码：429 ** ValidationException ** 定义验证异常的结构。 ** fieldList ** 发生验证异常的字段列表。 ** message ** 一条描述验证异常的错误消息。 ** reason ** 发生验证异常的原因（`unknownOperation`、`cannotParse`、`fieldValidationFailed` 或 `other` 之一）。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/StopCluster) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/StopCluster) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/StopCluster) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StopCluster) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StopCluster) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/StopCluster) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/StopCluster) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StopCluster) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/StopCluster) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/StopCluster) # TagResource 将元数据标签添加到弹性集群资源中 ## 请求语法 ``` POST /tags/resourceArn HTTP/1.1 Content-type: application/json { "tags": { "string" : "string" } } ``` ## URI 请求参数 请求使用以下 URI 参数。 ** [resourceArn](#API_elastic_TagResource_RequestSyntax) ** 弹性集群资源的 ARN 标识符。 长度限制：最小长度为 1。最大长度为 1011。 是否必需：是 ## 请求体 请求接受采用 JSON 格式的以下数据。 ** [tags](#API_elastic_TagResource_RequestSyntax) ** 分配给弹性集群资源的标签。 类型：字符串到字符串映射 密钥长度限制：最小长度为 1。最大长度为 128。 键模式：`(?!aws:)[a-zA-Z+-=._:/]+` 值长度限制：最小长度为 0。最大长度为 256。 是否必需：是 ## 响应语法 ``` HTTP/1.1 200 ``` ## 响应元素 如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** InternalServerException ** 出现内部服务器错误。 HTTP 状态代码：500 ** ResourceNotFoundException ** 不能定位指定的资源。 ** message ** 一条描述失败的错误消息。 ** resourceId ** 找不到的资源的 ID。 ** resourceType ** 找不到的资源的类型。 HTTP 状态代码：404 ** ThrottlingException ** ThrottlingException 当由于请求限制而导致请求被拒绝时，将抛出。 ** retryAfterSeconds ** 重试操作之前等待的秒数。 HTTP 状态代码：429 ** ValidationException ** 定义验证异常的结构。 ** fieldList ** 发生验证异常的字段列表。 ** message ** 一条描述验证异常的错误消息。 ** reason ** 发生验证异常的原因（`unknownOperation`、`cannotParse`、`fieldValidationFailed` 或 `other` 之一）。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/TagResource) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/TagResource) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/TagResource) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/TagResource) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/TagResource) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/TagResource) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/TagResource) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/TagResource) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/TagResource) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/TagResource) # UntagResource 从弹性集群资源中移除元数据标签。 ## 请求语法 ``` DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1 ``` ## URI 请求参数 请求使用以下 URI 参数。 ** [resourceArn](#API_elastic_UntagResource_RequestSyntax) ** 弹性集群资源的 ARN 标识符。 长度限制：最小长度为 1。最大长度为 1011。 是否必需：是 ** [tagKeys](#API_elastic_UntagResource_RequestSyntax) ** 要从弹性集群资源移除的标签密钥。 数组成员：最少 0 个物品。最多 50 项。 长度限制：最小长度为 1。最大长度为 128。 模式：`(?!aws:)[a-zA-Z+-=._:/]+` 必需：是 ## 请求体 该请求没有请求正文。 ## 响应语法 ``` HTTP/1.1 200 ``` ## 响应元素 如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** InternalServerException ** 出现内部服务器错误。 HTTP 状态代码：500 ** ResourceNotFoundException ** 不能定位指定的资源。 ** message ** 一条描述失败的错误消息。 ** resourceId ** 找不到的资源的 ID。 ** resourceType ** 找不到的资源的类型。 HTTP 状态代码：404 ** ThrottlingException ** ThrottlingException 当由于请求限制而导致请求被拒绝时，将抛出。 ** retryAfterSeconds ** 重试操作之前等待的秒数。 HTTP 状态代码：429 ** ValidationException ** 定义验证异常的结构。 ** fieldList ** 发生验证异常的字段列表。 ** message ** 一条描述验证异常的错误消息。 ** reason ** 发生验证异常的原因（`unknownOperation`、`cannotParse`、`fieldValidationFailed` 或 `other` 之一）。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UntagResource) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UntagResource) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UntagResource) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UntagResource) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UntagResource) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UntagResource) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UntagResource) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UntagResource) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UntagResource) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UntagResource) # UpdateCluster 修改一个弹性集群。这包括更新管理员用户名/密码、升级 API 版本，以及设置备份时段和维护时段 ## 请求语法 ``` PUT /cluster/clusterArn HTTP/1.1 Content-type: application/json { "adminUserPassword": "string", "authType": "string", "backupRetentionPeriod": number, "clientToken": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } ``` ## URI 请求参数 请求使用以下 URI 参数。 ** [clusterArn](#API_elastic_UpdateCluster_RequestSyntax) ** 弹性集群的 ARN 标识符。 是否必需：是 ## 请求体 请求接受采用 JSON 格式的以下数据。 ** [adminUserPassword](#API_elastic_UpdateCluster_RequestSyntax) ** 与弹性集群管理员关联的密码。此密码可以包含除正斜杠 (/)、双引号 (") 或 @ 符号之外的任何可打印的 ASCII 字符。 *约束*：必须包含 8 到 100 个字符。 类型：字符串 必需：否 ** [authType](#API_elastic_UpdateCluster_RequestSyntax) ** 用于确定从何处获取用于访问弹性集群的密码的身份验证类型。有效的类型为 `PLAIN_TEXT` 或 `SECRET_ARN`。 类型：字符串 有效值：`PLAIN_TEXT | SECRET_ARN` 必需：否 ** [backupRetentionPeriod](#API_elastic_UpdateCluster_RequestSyntax) ** 自动快照的保留天数。 类型：整数 必需：否 ** [clientToken](#API_elastic_UpdateCluster_RequestSyntax) ** 弹性集群的客户端令牌。 类型：字符串 必需：否 ** [preferredBackupWindow](#API_elastic_UpdateCluster_RequestSyntax) ** 在启用自动备份的情况下每日执行自动备份的时间范围，如 `backupRetentionPeriod` 所规定。 类型：字符串 必需：否 ** [preferredMaintenanceWindow](#API_elastic_UpdateCluster_RequestSyntax) ** 可进行系统维护的每周时间范围（采用通用协调时间（UTC））。 *Format*: `ddd:hh24:mi-ddd:hh24:mi` *默认*：从每个 8 小时的时间段中随机选择一个 30 分钟的窗口 AWS 区域，发生在一周中的随机某一天。 *有效日*：Mon、Tue、Wed、Thu、Fri、Sat、Sun *约束*：至少为 30 分钟的时段。 类型：字符串 必需：否 ** [shardCapacity](#API_elastic_UpdateCluster_RequestSyntax) ** CPUs 分配给每个弹性集群分片的 v 数。最大值为 64。允许值为 2、4、8、16、32、64。 类型：整数 必需：否 ** [shardCount](#API_elastic_UpdateCluster_RequestSyntax) ** 分配给弹性集群的分片数目。最大值为 32。 类型：整数 必需：否 ** [shardInstanceCount](#API_elastic_UpdateCluster_RequestSyntax) ** 适用于弹性集群中所有分片的副本实例的数量。`shardInstanceCount` 值为 1 表示有一个写入器实例，其他任何实例都是可用于读取和提高可用性的副本。 类型：整数 必需：否 ** [subnetIds](#API_elastic_UpdateCluster_RequestSyntax) ** 弹性集群的 Amazon EC2 子网 IDs 。 类型：字符串数组 必需：否 ** [vpcSecurityGroupIds](#API_elastic_UpdateCluster_RequestSyntax) ** 要与弹性集群关联的 EC2 VPC 安全组的列表。 类型：字符串数组 必需：否 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "cluster": { "adminUserName": "string", "authType": "string", "backupRetentionPeriod": number, "clusterArn": "string", "clusterEndpoint": "string", "clusterName": "string", "createTime": "string", "kmsKeyId": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "shards": [ { "createTime": "string", "shardId": "string", "status": "string" } ], "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## 响应元素 如果此操作成功，则该服务将会发送回 HTTP 200 响应。 服务以 JSON 格式返回以下数据。 ** [cluster](#API_elastic_UpdateCluster_ResponseSyntax) ** 返回有关已更新弹性集群的信息。 类型：[Cluster](API_elastic_Cluster.md) 对象 ## 错误 有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** AccessDeniedException ** 没有足够权限执行某操作时出现的异常。 ** message ** 一条解释访问被拒绝原因的错误消息。 HTTP 状态代码：403 ** ConflictException ** 存在访问冲突。 ** resourceId ** 存在访问冲突的资源的 ID。 ** resourceType ** 存在访问冲突的资源的类型。 HTTP 状态代码：409 ** InternalServerException ** 出现内部服务器错误。 HTTP 状态代码：500 ** ResourceNotFoundException ** 不能定位指定的资源。 ** message ** 一条描述失败的错误消息。 ** resourceId ** 找不到的资源的 ID。 ** resourceType ** 找不到的资源的类型。 HTTP 状态代码：404 ** ThrottlingException ** ThrottlingException 当由于请求限制而导致请求被拒绝时，将抛出。 ** retryAfterSeconds ** 重试操作之前等待的秒数。 HTTP 状态代码：429 ** ValidationException ** 定义验证异常的结构。 ** fieldList ** 发生验证异常的字段列表。 ** message ** 一条描述验证异常的错误消息。 ** reason ** 发生验证异常的原因（`unknownOperation`、`cannotParse`、`fieldValidationFailed` 或 `other` 之一）。 HTTP 状态代码：400 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UpdateCluster) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UpdateCluster) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UpdateCluster) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UpdateCluster) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UpdateCluster) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UpdateCluster) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UpdateCluster) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UpdateCluster) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UpdateCluster) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UpdateCluster) # 数据类型 支持以下数据类型 Amazon DocumentDB (with MongoDB compatibility)： + [AvailabilityZone](API_AvailabilityZone.md) + [Certificate](API_Certificate.md) + [CertificateDetails](API_CertificateDetails.md) + [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md) + [ClusterMasterUserSecret](API_ClusterMasterUserSecret.md) + [DBCluster](API_DBCluster.md) + [DBClusterMember](API_DBClusterMember.md) + [DBClusterParameterGroup](API_DBClusterParameterGroup.md) + [DBClusterRole](API_DBClusterRole.md) + [DBClusterSnapshot](API_DBClusterSnapshot.md) + [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md) + [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) + [DBEngineVersion](API_DBEngineVersion.md) + [DBInstance](API_DBInstance.md) + [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md) + [DBSubnetGroup](API_DBSubnetGroup.md) + [Endpoint](API_Endpoint.md) + [EngineDefaults](API_EngineDefaults.md) + [Event](API_Event.md) + [EventCategoriesMap](API_EventCategoriesMap.md) + [EventSubscription](API_EventSubscription.md) + [FailoverState](API_FailoverState.md) + [Filter](API_Filter.md) + [GlobalCluster](API_GlobalCluster.md) + [GlobalClusterMember](API_GlobalClusterMember.md) + [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md) + [Parameter](API_Parameter.md) + [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md) + [PendingMaintenanceAction](API_PendingMaintenanceAction.md) + [PendingModifiedValues](API_PendingModifiedValues.md) + [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) + [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md) + [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) + [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md) + [Subnet](API_Subnet.md) + [Tag](API_Tag.md) + [UpgradeTarget](API_UpgradeTarget.md) + [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) Amazon DocumentDB 弹性集群支持以下数据类型： + [Cluster](API_elastic_Cluster.md) + [ClusterInList](API_elastic_ClusterInList.md) + [ClusterSnapshot](API_elastic_ClusterSnapshot.md) + [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md) + [PendingMaintenanceActionDetails](API_elastic_PendingMaintenanceActionDetails.md) + [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) + [Shard](API_elastic_Shard.md) + [ValidationExceptionField](API_elastic_ValidationExceptionField.md) # Amazon DocumentDB (with MongoDB compatibility) 支持以下数据类型 Amazon DocumentDB (with MongoDB compatibility)： + [AvailabilityZone](API_AvailabilityZone.md) + [Certificate](API_Certificate.md) + [CertificateDetails](API_CertificateDetails.md) + [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md) + [ClusterMasterUserSecret](API_ClusterMasterUserSecret.md) + [DBCluster](API_DBCluster.md) + [DBClusterMember](API_DBClusterMember.md) + [DBClusterParameterGroup](API_DBClusterParameterGroup.md) + [DBClusterRole](API_DBClusterRole.md) + [DBClusterSnapshot](API_DBClusterSnapshot.md) + [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md) + [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) + [DBEngineVersion](API_DBEngineVersion.md) + [DBInstance](API_DBInstance.md) + [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md) + [DBSubnetGroup](API_DBSubnetGroup.md) + [Endpoint](API_Endpoint.md) + [EngineDefaults](API_EngineDefaults.md) + [Event](API_Event.md) + [EventCategoriesMap](API_EventCategoriesMap.md) + [EventSubscription](API_EventSubscription.md) + [FailoverState](API_FailoverState.md) + [Filter](API_Filter.md) + [GlobalCluster](API_GlobalCluster.md) + [GlobalClusterMember](API_GlobalClusterMember.md) + [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md) + [Parameter](API_Parameter.md) + [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md) + [PendingMaintenanceAction](API_PendingMaintenanceAction.md) + [PendingModifiedValues](API_PendingModifiedValues.md) + [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) + [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md) + [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) + [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md) + [Subnet](API_Subnet.md) + [Tag](API_Tag.md) + [UpgradeTarget](API_UpgradeTarget.md) + [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) # AvailabilityZone 可用区信息。 ## 目录 **注意** 下表中首先描述了必需参数。 ** Name ** 可用区的名称。 类型：字符串 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/AvailabilityZone) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/AvailabilityZone) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/AvailabilityZone) # Certificate AWS 账户 的证书颁发机构 (CA) 证书。 ## 目录 **注意** 下表中，首先描述的是必需参数。 ** CertificateArn ** 证书的 Amazon 资源名称（ARN）。 示例：`arn:aws:rds:us-east-1::cert:rds-ca-2019` 类型：字符串 必需：否 ** CertificateIdentifier ** 标识证书的唯一密钥。 示例：`rds-ca-2019` 类型：字符串 必需：否 ** CertificateType ** 证书的类型。 示例：`CA` 类型：字符串 必需：否 ** Thumbprint ** 证书的指纹。 类型：字符串 必需：否 ** ValidFrom ** 证书生效的起始日期—时间。 示例：`2019-07-31T17:57:09Z` 类型：时间戳 必需：否 ** ValidTill ** 证书不再有效的日期—时间。 示例：`2024-07-31T17:57:09Z` 类型：时间戳 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Certificate) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Certificate) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Certificate) # CertificateDetails 返回数据库实例服务器证书的详细信息。 有关更多信息，请参阅 *Amazon DocumentDB 开发者指南*中的[更新 Amazon DocumentDB TLS 证书](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html)和[传输中数据加密](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html)。 ## 目录 **注意** 下表中，首先描述的是必需参数。 ** CAIdentifier ** 用于数据库实例的服务器证书的 CA 证书的 CA 标识符。 类型：字符串 必需：否 ** ValidTill ** 数据库实例的服务器证书的到期日期。 类型：时间戳 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CertificateDetails) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CertificateDetails) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CertificateDetails) # CloudwatchLogsExportConfiguration 要启用日志类型的配置设置，以便针对特定实例或集群导出到 Amazon CloudWatch Logs。 `EnableLogTypes` 和 `DisableLogTypes` 数组确定将哪些日志导出（或不导出）到 CloudWatch Logs。这些数组中的值取决于所使用的引擎。 ## 目录 **注意** 下表中，首先描述的是必需参数。 ** DisableLogTypes.member.N ** 要禁用的日志类型列表。 类型：字符串数组 必需：否 ** EnableLogTypes.member.N ** 要启用的日志类型的列表。 类型：字符串数组 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CloudwatchLogsExportConfiguration) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CloudwatchLogsExportConfiguration) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CloudwatchLogsExportConfiguration) # ClusterMasterUserSecret 包含 Amazon DocumentDB 在 AWS Secrets Manager 中管理的用于主用户密码的密钥。 ## 目录 **注意** 下表中首先描述了必需参数。 ** KmsKeyId ** 用于加密密钥的 AWS KMS 密钥标识符。 类型：字符串 必需：否 ** SecretArn ** 密钥的 Amazon 资源名称（ARN）。 类型：字符串 必需：否 ** SecretStatus ** 密钥的状态。 可能的状态值包括： + creating – 密钥正在创建中。 + active – 密钥可用于正常使用和轮换。 + rotating – 密钥正在轮换。 + impaired – 密钥可用于访问数据库凭证，但不能轮换。例如，如果权限发生了更改，使得 Amazon DocumentDB 无法再访问密钥或密钥的 KMS 密钥，则密钥可能具有此状态。 当密钥具有此状态时，您可以更正导致该状态的条件。或者，修改实例以关闭数据库凭证的自动管理，然后再次修改实例以启用数据库凭证的自动管理。 类型：字符串 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ClusterMasterUserSecret) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ClusterMasterUserSecret) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ClusterMasterUserSecret) # DBCluster 有关集群的详细信息。 ## 目录 **注意** 下表中，首先描述的是必需参数。 ** AssociatedRoles.DBClusterRole.N ** 提供与集群关联的 AWS Identity and Access Management（IAM）角色的列表。与集群关联的（IAM）角色授予集群代表您访问其他 AWS 服务的权限。 类型：[DBClusterRole](API_DBClusterRole.md) 对象数组 必需：否 ** AvailabilityZones.AvailabilityZone.N ** 提供可在其上创建集群中实例的 Amazon EC2 可用区的列表。 类型：字符串数组 必需：否 ** BackupRetentionPeriod ** 指定自动快照的保留天数。 类型：整数 必需：否 ** CloneGroupId ** 标识数据库集群与之关联的克隆组。 类型：字符串 必需：否 ** ClusterCreateTime ** 指定创建集群的时间，采用通用协调时间 (UTC)。 类型：时间戳 必需：否 ** DBClusterArn ** 集群的 Amazon 资源名称 (ARN)。 类型：字符串 必需：否 ** DBClusterIdentifier ** 包含用户提供的集群标识符。此标识符是识别集群的唯一键。 类型：字符串 必需：否 ** DBClusterMembers.DBClusterMember.N ** 提供组成集群的实例的列表。 类型：[DBClusterMember](API_DBClusterMember.md) 对象数组 必需：否 ** DBClusterParameterGroup ** 指定集群的集群参数组名称。 类型：字符串 必需：否 ** DbClusterResourceId ** 集群在 AWS 区域 中唯一的不可变标识符。每次访问集群的 AWS KMS 密钥时，可以在 AWS CloudTrail 日志条目中找到该标识符。 类型：字符串 必需：否 ** DBSubnetGroup ** 指定与集群关联的子网组的信息，包括名称、描述和子网组中的子网。 类型：字符串 必需：否 ** DeletionProtection ** 指定是否可以删除此集群。如果 `DeletionProtection` 启用，则无法删除集群，除非集群经修改并 `DeletionProtection` 禁用。`DeletionProtection` 防止意外删除集群。 类型：布尔值 必需：否 ** EarliestRestorableTime ** 数据库可以使用时间点还原的最早还原时间。 类型：时间戳 必需：否 ** EnabledCloudwatchLogsExports.member.N ** 此集群配置为导出到 Amazon CloudWatch Logs 的日志类型的列表。 类型：字符串数组 必需：否 ** Endpoint ** 指定集群的主实例的连接端点。 类型：字符串 必需：否 ** Engine ** 提供要用于此集群的数据库引擎的名称。 类型：字符串 必需：否 ** EngineVersion ** 指示数据库引擎版本。 类型：字符串 必需：否 ** HostedZoneId ** 指定在您创建托管区域时 Amazon Route 53 分配的 ID。 类型：字符串 必需：否 ** IOOptimizedNextAllowedModificationTime ** 下次您可以修改 Amazon DocumentDB 集群以使用 iopt1 存储类型。 类型：时间戳 必需：否 ** KmsKeyId ** 如果 `StorageEncrypted` 为 `true`，则为加密集群的 AWS KMS 密钥标识符。 类型：字符串 必需：否 ** LatestRestorableTime ** 指定数据库可以使用时间点还原的最新还原时间。 类型：时间戳 必需：否 ** MasterUsername ** 包含集群的主用户名。 类型：字符串 必需：否 ** MasterUserSecret ** Amazon DocumentDB 在 AWS Secrets Manager 中管理的用于主用户密码的密钥。 类型：[ClusterMasterUserSecret](API_ClusterMasterUserSecret.md) 对象 必需：否 ** MultiAZ ** 指定集群是否在多个可用区中有实例。 类型：布尔值 必需：否 ** NetworkType ** 集群的网络类型。 网络类型由为集群指定的 `DBSubnetGroup` 确定。`DBSubnetGroup` 只可以支持 IPv4 协议或 IPv4 和 IPv6 协议（`DUAL`）。 有关更多信息，请参阅《Amazon DocumentDB 开发人员指南》中 [VPC 中的 DocumentDB 集群](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html)。 有效值：`IPV4` \$1 `DUAL` 类型：字符串 必需：否 ** PercentProgress ** 指定操作的进度百分比。 类型：字符串 必需：否 ** Port ** 指定数据库引擎侦听的端口。 类型：整数 必需：否 ** PreferredBackupWindow ** 指定在启用自动备份时，自动执行备份的日常时间范围，如 `BackupRetentionPeriod` 所规定。 类型：字符串 必需：否 ** PreferredMaintenanceWindow ** 指定可进行系统维护的每周时间范围（采用通用协调时间 (UTC)）。 类型：字符串 必需：否 ** ReaderEndpoint ** 集群的读取器端点。集群的读取器端点负载均衡集群中可用的 Amazon DocumentDB 副本间的连接。当客户端请求与读取器端点的新连接时，Amazon DocumentDB 将在集群中的 Amazon DocumentDB 副本之间分配连接请求。该功能可帮助平衡集群中跨多个 Amazon DocumentDB 副本的读取工作负载。 如果发生了失效转移并且连接到的 Amazon DocumentDB 副本被提升为主实例，则将删除您的连接。要继续向集群中的其他 Amazon DocumentDB 副本发送读取工作负载，您可以随后重新连接到读取器端点。 类型：字符串 必需：否 ** ReadReplicaIdentifiers.ReadReplicaIdentifier.N ** 包含与此集群关联的辅助集群的一个或多个标识符。 类型：字符串数组 必需：否 ** ReplicationSourceIdentifier ** 包含源集群的标识符，如该集群是辅助集群。 类型：字符串 必需：否 ** ServerlessV2ScalingConfiguration ** Amazon DocumentDB 无服务器集群的扩缩配置。 类型：[ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md) 对象 必需：否 ** Status ** 指定此集群的当前状态。 类型：字符串 必需：否 ** StorageEncrypted ** 指定集群是否已加密。 类型：布尔值 必需：否 ** StorageType ** 与集群关联的存储类型 有关 Amazon DocumentDB 集群存储类型的信息，请参阅*《Amazon DocumentDB 开发人员指南》*中的集群存储配置。 存储类型的有效值 - `standard | iopt1` 默认值为 `standard ` 类型：字符串 必需：否 ** VpcSecurityGroups.VpcSecurityGroupMembership.N ** 提供集群从属的虚拟私有云（VPC）安全组的列表。 类型：[VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) 对象数组 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBCluster) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBCluster) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBCluster) # DBClusterMember 包含有关属于集群的实例的信息。 ## 目录 **注意** 下表中，首先描述的是必需参数。 ** DBClusterParameterGroupStatus ** 指定数据库集群的此成员的集群参数组状态。 类型：字符串 必需：否 ** DBInstanceIdentifier ** 指定集群的此成员的实例标识符。 类型：字符串 必需：否 ** IsClusterWriter ** 如果集群成员是集群的主实例，值为 `true`，否则为 `false`。 类型：布尔值 必需：否 ** PromotionTier ** 该值指定在现有主实例发生故障后将 Amazon DocumentDB 副本提升为主实例的顺序。 类型：整数 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterMember) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterMember) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterMember) # DBClusterParameterGroup 有关集群参数组的详细信息。 ## 目录 **注意** 下表中描述了必需参数： ** DBClusterParameterGroupArn ** 集群参数组的 Amazon 资源名称 (ARN)。 类型：字符串 必需：否 ** DBClusterParameterGroupName ** 提供集群参数组的名称。 类型：字符串 必需：否 ** DBParameterGroupFamily ** 提供此集群参数组兼容的参数组系列的名称。 类型：字符串 必需：否 ** Description ** 为此集群参数组提供客户指定的描述。 类型：字符串 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterParameterGroup) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterParameterGroup) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterParameterGroup) # DBClusterRole 描述与集群关联的 AWS Identity and Access Management（IAM）角色。 ## 目录 **注意** 下表中首先描述了必需参数： ** RoleArn ** 与数据库集群关联 IAMrole 的 Amazon 资源名称（ARN）。 类型：字符串 必需：否 ** Status ** 描述 IAMrole 与集群之间关联的状态。`Status` 属性返回以下值之一： + `ACTIVE` - 该 IAMrole ARN 已与集群关联，可用于代表您访问其他 AWS 服务。 + `PENDING` - 与集群关联的 IAMrole ARN。 + `INVALID` - IAMrole ARN 与集群关联，但集群无法代入 IAMrole 以代表您访问其他 AWS 服务。 类型：字符串 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterRole) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterRole) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterRole) # DBClusterSnapshot 有关集群快照的详细信息。 ## 目录 **注意** 下表中描述了必需参数： ** AvailabilityZones.AvailabilityZone.N ** 提供集群快照中的实例可以还原到的 Amazon EC2 可用区列表。 类型：字符串数组 必需：否 ** ClusterCreateTime ** 指定创建集群的时间，采用通用协调时间 (UTC)。 类型：时间戳 必需：否 ** DBClusterIdentifier ** 指定从中创建了此集群快照的集群的集群标识符。 类型：字符串 必需：否 ** DBClusterSnapshotArn ** 集群快照的 Amazon 资源名称 (ARN)。 类型：字符串 必需：否 ** DBClusterSnapshotIdentifier ** 指定集群快照的标识符。 类型：字符串 必需：否 ** Engine ** 指定数据库引擎的名称。 类型：字符串 必需：否 ** EngineVersion ** 提供此集群快照的数据库引擎的版本。 类型：字符串 必需：否 ** KmsKeyId ** 如果 `StorageEncrypted` 为 `true`，则为加密集群快照的 AWS KMS 密钥标识符。 类型：字符串 必需：否 ** MasterUsername ** 提供集群快照的主用户名。 类型：字符串 必需：否 ** PercentProgress ** 指定估计的已传输数据百分比。 类型：整数 必需：否 ** Port ** 指定获取快照时集群侦听的端口。 类型：整数 必需：否 ** SnapshotCreateTime ** 提供获取快照的时间，以 UTC 表示。 类型：时间戳 必需：否 ** SnapshotType ** 提供集群快照的类型。 类型：字符串 必需：否 ** SourceDBClusterSnapshotArn ** 如果集群快照复制自源集群快照，则为源集群快照的 ARN，否则为 null 值。 类型：字符串 必需：否 ** Status ** 指定此集群快照的状态。 类型：字符串 必需：否 ** StorageEncrypted ** 指定是否加密集群快照。 类型：布尔值 必需：否 ** StorageType ** 与集群快照关联的存储类型 有关 Amazon DocumentDB 集群存储类型的信息，请参阅*《Amazon DocumentDB 开发人员指南》*中的集群存储配置。 存储类型的有效值 - `standard | iopt1` 默认值为 `standard ` 类型：字符串 必需：否 ** VpcId ** 提供与集群快照关联的虚拟私有云（VPC）ID。 类型：字符串 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshot) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshot) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterSnapshot) # DBClusterSnapshotAttribute 包含手动集群快照属性的名称和值。 手动集群快照属性用于授权其他 AWS 账户 还原手动集群快照。 ## 目录 **注意** 下表中描述了必需参数： ** AttributeName ** 手动集群快照属性的名称。 名为 `restore` 的属性引用有权复制或还原手动集群快照的 AWS 账户 列表。 类型：字符串 必需：否 ** AttributeValues.AttributeValue.N ** 手动集群快照属性的值。 如果 `AttributeName` 字段设置为 `restore`，则此元素返回已授权复制或还原手动集群快照的 AWS 账户 列表。如果列表中有值 `all`，则手动集群快照为公有，可供任意 AWS 账户 复制或还原。 类型：字符串数组 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshotAttribute) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshotAttribute) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterSnapshotAttribute) # DBClusterSnapshotAttributesResult 有关集群快照关联属性的详细信息。 ## 目录 **注意** 下表中，首先描述的是必需参数。 ** DBClusterSnapshotAttributes.DBClusterSnapshotAttribute.N ** 集群快照的属性和值的列表。 类型：[DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md) 对象数组 必需：否 ** DBClusterSnapshotIdentifier ** 属性应用到的集群快照的标识符。 类型：字符串 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshotAttributesResult) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshotAttributesResult) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterSnapshotAttributesResult) # DBEngineVersion 有关引擎版本的详细信息。 ## 目录 **注意** 下表中，首先描述的是必需参数。 ** DBEngineDescription ** 数据库引擎的描述。 类型：字符串 必需：否 ** DBEngineVersionDescription ** 数据库引擎版本的描述。 类型：字符串 必需：否 ** DBParameterGroupFamily ** 用于数据库引擎的参数组系列的名称。 类型：字符串 必需：否 ** Engine ** 数据库引擎的名称。 类型：字符串 必需：否 ** EngineVersion ** 数据库引擎的版本号。 类型：字符串 必需：否 ** ExportableLogTypes.member.N ** 数据库引擎已可用于导出到 Amazon CloudWatch Logs 的日志类型。 类型：字符串数组 必需：否 ** ServerlessV2FeaturesSupport ** 指定 Amazon DocumentDB 引擎版本之间存在差异的任何 Amazon DocumentDB 无服务器属性或限制。在决定对新集群或升级后的集群使用哪个 Amazon DocumentDB 版本时，可以测试此属性的值。您还可以检索现有集群的版本，并检查该版本是否支持特定的 Amazon DocumentDB 无服务器功能，然后再尝试使用这些功能。 类型：[ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md) 对象 必需：否 ** SupportedCACertificateIdentifiers.member.N ** 受支持 CA 证书标识符列表。 有关更多信息，请参阅 *Amazon DocumentDB 开发者指南*中的[更新 Amazon DocumentDB TLS 证书](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html)和[传输中数据加密](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html)。 类型：字符串数组 必需：否 ** SupportsCertificateRotationWithoutRestart ** 表示引擎版本是否支持在不重启数据库实例的情况下轮换服务器证书。 类型：布尔值 必需：否 ** SupportsLogExportsToCloudwatchLogs ** 一个值，指示引擎版本是否支持将 `ExportableLogTypes` 指定的日志类型导出到 CloudWatch Logs。 类型：布尔值 必需：否 ** ValidUpgradeTarget.UpgradeTarget.N ** 此数据库引擎版本可以升级到的引擎版本列表。 类型：[UpgradeTarget](API_UpgradeTarget.md) 对象数组 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBEngineVersion) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBEngineVersion) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBEngineVersion) # DBInstance 有关实例的详细信息。 ## 目录 **注意** 下表中，首先描述的是必需参数。 ** AutoMinorVersionUpgrade ** 不适用。此参数不适用于 Amazon DocumentDB。无论设置的值如何，Amazon DocumentDB 都不会执行次要版本升级。 类型：布尔值 必需：否 ** AvailabilityZone ** 指定实例所在可用区域的名称。 类型：字符串 必需：否 ** BackupRetentionPeriod ** 指定自动快照的保留天数。 类型：整数 必需：否 ** CACertificateIdentifier ** 此数据库实例的 CA 证书的标识符。 类型：字符串 必需：否 ** CertificateDetails ** 数据库实例服务器证书的详细信息。 类型：[CertificateDetails](API_CertificateDetails.md) 对象 必需：否 ** CopyTagsToSnapshot ** 指示是否将标签从数据库实例复制到数据库实例快照的值。默认情况下，不复制标签。 类型：布尔值 必需：否 ** DBClusterIdentifier ** 如果实例属于某个集群，则包含实例所属的集群的名称。 类型：字符串 必需：否 ** DBInstanceArn ** 实例的 Amazon 资源名称（ARN）。 类型：字符串 必需：否 ** DBInstanceClass ** 包含实例的计算和内存容量级别名称。 类型：字符串 必需：否 ** DBInstanceIdentifier ** 包含用户提供的数据库标识符。此标识符是标识实例的唯一密钥。 类型：字符串 必需：否 ** DBInstanceStatus ** 指定此数据库的当前状态。 类型：字符串 必需：否 ** DbiResourceId ** 实例的 AWS 区域 唯一且不变的标识符。每次访问实例的 AWS CloudTrail 密钥时，可以在 AWS KMS 日志条目中找到该标识符。 类型：字符串 必需：否 ** DBSubnetGroup ** 指定与实例关联的子网组的信息，包括名称、描述和子网组中的子网。 类型：[DBSubnetGroup](API_DBSubnetGroup.md) 对象 必需：否 ** EnabledCloudwatchLogsExports.member.N ** 此实例配置为导出到 CloudWatch Logs 的日志类型的列表。 类型：字符串数组 必需：否 ** Endpoint ** 指定连接端点。 类型：[Endpoint](API_Endpoint.md) 对象 必需：否 ** Engine ** 提供要用于此实例的数据库引擎的名称。 类型：字符串 必需：否 ** EngineVersion ** 指示数据库引擎版本。 类型：字符串 必需：否 ** InstanceCreateTime ** 提供创建实例的日期和时间。 类型：时间戳 必需：否 ** KmsKeyId ** 如果 `StorageEncrypted` 为 `true`，则为加密的实例的 AWS KMS 密钥标识符。 类型：字符串 必需：否 ** LatestRestorableTime ** 指定数据库可以使用时间点还原的最新还原时间。 类型：时间戳 必需：否 ** PendingModifiedValues ** 指定对实例的更改待处理。仅在更改待处理时包含此元素。特定更改由子元素标识。 类型：[PendingModifiedValues](API_PendingModifiedValues.md) 对象 必需：否 ** PerformanceInsightsEnabled ** 如果为数据库实例启用了 Amazon RDS 性能详情，设置为 `true`，否则设置为 `false`。 类型：布尔值 必需：否 ** PerformanceInsightsKMSKeyId ** 用于加密 Performance Insights 数据的 AWS KMS 密钥标识符。AWS KMS 密钥 ID 是 Amazon 资源名称 (ARN)、AWS KMS 密钥标识符或 AWS KMS 加密密钥的 AWS KMS 密钥别名。 类型：字符串 必需：否 ** PreferredBackupWindow ** 指定在启用自动备份时，自动执行备份的日常时间范围，如 `BackupRetentionPeriod` 所规定。 类型：字符串 必需：否 ** PreferredMaintenanceWindow ** 指定可进行系统维护的每周时间范围（采用通用协调时间 (UTC)）。 类型：字符串 必需：否 ** PromotionTier ** 该值指定在现有主实例发生故障后将 Amazon DocumentDB 副本提升为主实例的顺序。 类型：整数 必需：否 ** PubliclyAccessible ** 不支持。Amazon DocumentDB 目前不支持公有端点。`PubliclyAccessible` 的值始终为 `false`。 类型：布尔值 必需：否 ** StatusInfos.DBInstanceStatusInfo.N ** 只读副本的状态。如果实例不是只读副本，则此项空白。 类型：[DBInstanceStatusInfo](API_DBInstanceStatusInfo.md) 对象数组 必需：否 ** StorageEncrypted ** 指定是否已对实例加密。 类型：布尔值 必需：否 ** VpcSecurityGroups.VpcSecurityGroupMembership.N ** 提供实例所属的 VPC 安全组元素的列表。 类型：[VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) 对象数组 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBInstance) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBInstance) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBInstance) # DBInstanceStatusInfo 提供实例状态信息的列表。 ## 目录 **注意** 下表中，首先描述的是必需参数。 ** Message ** 实例出现错误时，错误的详细信息。如果实例未处于出错状态，则此值为空白。 类型：字符串 必需：否 ** Normal ** 布尔值，如果实例正常运行则为 `true`，如果实例处于错误状态则为 `false`。 类型：布尔值 必需：否 ** Status ** 实例的状态。对于只读副本的 `StatusType`，这些值可以是 `replicating`、错误、`stopped` 或`terminated`。 类型：字符串 必需：否 ** StatusType ** 目前此值为“`read replication`”。 类型：字符串 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBInstanceStatusInfo) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBInstanceStatusInfo) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBInstanceStatusInfo) # DBSubnetGroup 有关子网组的详细信息。 ## 目录 **注意** 下表中，首先描述的是必需参数。 ** DBSubnetGroupArn ** 数据库子网组的 Amazon 资源名称 (ARN)。 类型：字符串 必需：否 ** DBSubnetGroupDescription ** 提供子网组的描述。 类型：字符串 必需：否 ** DBSubnetGroupName ** 子网组的名称。 类型：字符串 必需：否 ** SubnetGroupStatus ** 提供子网组的状态。 类型：字符串 必需：否 ** Subnets.Subnet.N ** 有关子网组内一个或多个子网的详细信息。 类型：[Subnet](API_Subnet.md) 对象数组 必需：否 ** SupportedNetworkTypes.member.N ** 数据库子网组的网络类型。 有效值：`IPV4` \$1 `DUAL` `DBSubnetGroup` 只可以支持 IPv4 协议或 IPv4 和 IPv6 协议（双）。 类型：字符串数组 必需：否 ** VpcId ** 提供子网组的虚拟私有云（VPC）ID。 类型：字符串 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBSubnetGroup) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBSubnetGroup) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBSubnetGroup) # Endpoint 用于访问集群或实例的网络信息。客户端程序必须指定访问这些 Amazon DocumentDB 资源的有效端点。 ## 目录 **注意** 下表中，首先描述的是必需参数。 ** Address ** 指定实例的 DNS 地址。 类型：字符串 必需：否 ** HostedZoneId ** 指定在您创建托管区域时 Amazon Route 53 分配的 ID。 类型：字符串 必需：否 ** Port ** 指定数据库引擎侦听的端口。 类型：整数 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Endpoint) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Endpoint) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Endpoint) # EngineDefaults 包含成功调用 `DescribeEngineDefaultClusterParameters` 操作的结果。 ## 目录 **注意** 下表中，首先描述的是必需参数。 ** DBParameterGroupFamily ** 要返回其引擎参数信息的集群参数组族的名称。 类型：字符串 必需：否 ** Marker ** 由之前的请求提供的可选分页标记。如果指定此参数，则响应仅包含标记之外的记录，最大数量为 `MaxRecords` 指定的值。 类型：字符串 必需：否 ** Parameters.Parameter.N ** 特定集群参数组系列的参数。 类型：[Parameter](API_Parameter.md) 对象数组 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EngineDefaults) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EngineDefaults) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/EngineDefaults) # Event 事件详细信息。 ## 目录 **注意** 下表中首先描述了必需参数。 ** Date ** 指定事件的日期和时间。 类型：时间戳 必需：否 ** EventCategories.EventCategory.N ** 指定事件的类别。 类型：字符串数组 必需：否 ** Message ** 提供此事件的文本。 类型：字符串 必需：否 ** SourceArn ** 事件的 Amazon 资源名称 (ARN)。 类型：字符串 必需：否 ** SourceIdentifier ** 提供事件的源的标识符。 类型：字符串 必需：否 ** SourceType ** 为此事件指定源类型。 类型：字符串 有效值：`db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot` 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Event) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Event) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Event) # EventCategoriesMap 事件源类型，附有一个或多个事件类别名称。 ## 目录 **注意** 下表中首先描述了必需参数。 ** EventCategories.EventCategory.N ** 指定源类型的事件类别。 类型：字符串数组 必需：否 ** SourceType ** 返回的类别所属的源类型。 类型：字符串 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EventCategoriesMap) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EventCategoriesMap) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/EventCategoriesMap) # EventSubscription 有关您已订阅事件的详细信息。 ## 目录 **注意** 下表中，首先描述的是必需参数。 ** CustomerAwsId ** 与 Amazon DocumentDB 事件通知订阅关联的 AWS 客户账户。 类型：字符串 必需：否 ** CustSubscriptionId ** Amazon DocumentDB 事件通知订阅 ID。 类型：字符串 必需：否 ** Enabled ** 指示是否启用订阅的布尔值。值为 `true` 表示已启用订阅。 类型：布尔值 必需：否 ** EventCategoriesList.EventCategory.N ** Amazon DocumentDB 事件通知订阅的事件类别列表。 类型：字符串数组 必需：否 ** EventSubscriptionArn ** 事件订阅的 Amazon 资源名称 (ARN)。 类型：字符串 必需：否 ** SnsTopicArn ** Amazon DocumentDB 事件通知订阅的主题 ARN。 类型：字符串 必需：否 ** SourceIdsList.SourceId.N ** Amazon DocumentDB 事件通知订阅的源 ID 列表。 类型：字符串数组 必需：否 ** SourceType ** Amazon DocumentDB 事件通知订阅的源类型。 类型：字符串 必需：否 ** Status ** Amazon DocumentDB 事件通知订阅的状态。 约束： 可以是以下值之一：`creating`，`modifying`，`deleting`，`active`，`no-permission`，`topic-not-exist` 状态 `no-permission` 表示 Amazon DocumentDB 不再有权发布到 SNS 主题。状态 `topic-not-exist` 表示主题在创建订阅之后删除。 类型：字符串 必需：否 ** SubscriptionCreationTime ** 建立 Amazon DocumentDB 事件通知訂閱的時間。 类型：字符串 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EventSubscription) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EventSubscription) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/EventSubscription) # FailoverState 包含 Amazon DocumentDB 全局群集上的计划或处理中操作的状态。除非已计划或正在全局群集上执行切换或故障转移操作，否则此数据类型为空。 ## 内容 **注意** 下表中首先描述了必需参数。 ** FromDbClusterArn ** 当前正在降级的 Amazon DocumentDB 集群的亚马逊资源名称 (ARN)，该名称与此状态相关联。 类型：字符串 必需：否 ** IsDataLossAllowed ** 表示操作是全局切换还是全局故障转移。如果允许数据丢失，则操作是全局故障转移。否则，就是切换。 类型：布尔值 必需：否 ** Status ** 全局群集的当前状态。可能值如下所示： + **pen** ding — 该服务收到了切换或故障切换全局群集的请求。操作开始之前，正在验证全局群集的主群集和指定的辅助群集。 + **failing-over** — 选定的辅助群集被提升为新的主群集，以便对全局群集进行故障切换。 + **cancelling** — 切换或故障切换全局群集的请求已取消，主群集和选定的辅助群集将恢复到以前的状态。 类型：字符串 有效值：`pending | failing-over | cancelling` 必需：否 ** ToDbClusterArn ** 当前正在升级且与此状态关联的 Amazon DocumentDB 集群的亚马逊资源名称 (ARN)。 类型：字符串 必需：否 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverState) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverState) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverState) # Filter 已命名的筛选器值组，用于返回更具体的结果列表。您可以使用筛选器按特定标准（例如 ID）匹配一组资源。 筛选器中不支持通配符。 ## 目录 **注意** 下表中首先描述了必需参数。 ** Name ** 筛选器的名称。筛选器名称区分大小写。 类型：字符串 必需：是 ** Values.Value.N ** 一个或多个筛选器值。筛选值区分大小写。 类型：字符串数组 必需：是 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Filter) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Filter) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Filter) # GlobalCluster 一种表示 Amazon DocumentDB 全局集群的数据类型。 ## 内容 **注意** 下表中，首先描述的是必需参数。 ** DatabaseName ** 新全局集群中的默认数据库名称。 类型：字符串 必需：否 ** DeletionProtection ** 新全局集群的删除保护设置。 类型：布尔值 必需：否 ** Engine ** 全局集群使用的 Amazon DocumentDB 数据库引擎。 类型：字符串 必需：否 ** EngineVersion ** 指示数据库引擎版本。 类型：字符串 必需：否 ** FailoverState ** 一个数据对象，包含此全局群集的正在处理或待处理的切换或故障转移进程的当前状态的所有属性。除非在此全局群集上调用了`SwitchoverGlobalCluster`或`FailoverGlobalCluster`操作，否则此对象为空。 类型：[FailoverState](API_FailoverState.md) 对象 必需：否 ** GlobalClusterArn ** 全局集群的 Amazon 资源名称 (ARN)。 类型：字符串 必需：否 ** GlobalClusterIdentifier ** 包含用户提供的全局集群标识符。此标识符是识别全局集群的唯一键。 类型：字符串 长度限制：最小长度为 1。最大长度为 255。 模式：`[A-Za-z][0-9A-Za-z-:._]*` 必需：否 ** GlobalClusterMembers.GlobalClusterMember.N ** 全局群集 IDs 中辅助群集的群集列表。目前仅限一项。 类型：[GlobalClusterMember](API_GlobalClusterMember.md) 对象数组 必需：否 ** GlobalClusterResourceId ** 全局 AWS 区域数据库集群的区域唯一、不可变的标识符。每当访问集群的 AWS KMS 客户主密钥 (CMK) 时，都会在 AWS CloudTrail 日志条目中找到此标识符。 类型：字符串 必需：否 ** Status ** 指定此全局集群的当前状态。 类型：字符串 必需：否 ** StorageEncrypted ** 全局集群的存储加密设置。 类型：布尔值 必需：否 ** TagList.Tag.N ** 全局集群标签列表。 类型：[Tag](API_Tag.md) 对象数组 必需：否 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/GlobalCluster) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/GlobalCluster) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/GlobalCluster) # GlobalClusterMember 一种数据结构，附带有关与 Amazon DocumentDB 全局集群关联的任何主集群和辅助集群的信息。 ## 内容 **注意** 下表中，首先描述的是必需参数。 ** DBClusterArn ** 每个 Amazon DocumentDB 集群的 Amazon 资源名称（ARN）。 类型：字符串 必需：否 ** IsWriter ** 指定 Amazon DocumentDB 集群是否为与该集群关联的 Amazon DocumentDB 全局集群的主集群（即具有读写能力）。 类型：布尔值 必需：否 ** Readers.member.N ** 与 Amazon DocumentDB 全局集群关联的每个只读辅助集群的 Amazon 资源名称（ARN）。 类型：字符串数组 必需：否 ** SynchronizationStatus ** 全局集群中每个 Amazon DocumentDB 集群的同步状态。 类型：字符串 有效值：`connected | pending-resync` 必需：否 ## 另请参阅 有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/GlobalClusterMember) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/GlobalClusterMember) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/GlobalClusterMember) # OrderableDBInstanceOption 可提供给实例的选项。 ## 目录 **注意** 下表中，首先描述的是必需参数。 ** AvailabilityZones.AvailabilityZone.N ** 实例的可用区域列表。 类型：[AvailabilityZone](API_AvailabilityZone.md) 对象数组 必需：否 ** DBInstanceClass ** 实例的实例类。 类型：字符串 必需：否 ** Engine ** 实例的引擎类型。 类型：字符串 必需：否 ** EngineVersion ** 实例的引擎版本。 类型：字符串 必需：否 ** LicenseModel ** 实例的许可模式 类型：字符串 必需：否 ** StorageType ** 与数据库集群关联的存储类型 类型：字符串 必需：否 ** Vpc ** 表示实例是否位于虚拟私有云（VPC）中。 类型：布尔值 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/OrderableDBInstanceOption) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/OrderableDBInstanceOption) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/OrderableDBInstanceOption) # Parameter 有关单个参数的详细信息。 ## 目录 **注意** 下表中，首先描述的是必需参数。 ** AllowedValues ** 指定参数值的有效范围。 类型：字符串 必需：否 ** ApplyMethod ** 指示何时应用参数更新。 类型：字符串 有效值：`immediate | pending-reboot` 必需：否 ** ApplyType ** 指定引擎特定的参数类型。 类型：字符串 必需：否 ** DataType ** 指定参数的有效数据类型。 类型：字符串 必需：否 ** Description ** 提供参数的说明。 类型：字符串 必需：否 ** IsModifiable ** 指示参数可以修改 (`true`) 还是不能修改 (`false`)。一些参数具有安全或操作影响，会阻止更改这些参数。 类型：布尔值 必需：否 ** MinimumEngineVersion ** 参数可以应用到的最早引擎版本。 类型：字符串 必需：否 ** ParameterName ** 指定参数的名称。 类型：字符串 必需：否 ** ParameterValue ** 指定参数的值。必须是一个或多个集群参数 `AllowedValues`（CSV 格式）： 有效值为： + `enabled`：集群接受使用 TLS 版本 1.0 到 1.3 的安全连接。 + `disabled`：此集群不接受使用 TLS 的安全连接。 + `fips-140-3`：集群仅接受符合联邦信息处理标准（FIPS）出版物 140-3 要求的安全连接。在以下区域，从 Amazon DocumentDB 5.0（引擎版本 3.0.3727）集群开始才支持此功能：ca-central-1、us-west-2、us-east-1、us-east-2、us-gov-east-1、us-gov-west-1。 + `tls1.2+`：集群接受使用 TLS 版本 1.2 及更高版本的安全连接。从 Amazon DocumentDB 4.0（引擎版本 2.0.10980）和 Amazon DocumentDB 5.0（引擎版本 3.0.11051）开始才支持此功能。 + `tls1.3+`：集群接受使用 TLS 版本 1.3 及更高版本的安全连接。从 Amazon DocumentDB 4.0（引擎版本 2.0.10980）和 Amazon DocumentDB 5.0（引擎版本 3.0.11051）开始才支持此功能。 类型：字符串 必需：否 ** Source ** 指示参数值的源。 类型：字符串 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Parameter) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Parameter) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Parameter) # PendingCloudwatchLogsExports 其配置仍处于待处理状态的日志类型的列表。这些日志类型正处于激活或停用过程中。 ## 目录 **注意** 下表中，首先描述的是必需参数。 ** LogTypesToDisable.member.N ** 处于启用过程中的日志类型。启用之后，这些日志类型会导出到 Amazon CloudWatch Logs。 类型：字符串数组 必需：否 ** LogTypesToEnable.member.N ** 处于停用过程中的日志类型。停用之后，这些日志类型不会导出到 CloudWatch Logs。 类型：字符串数组 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingCloudwatchLogsExports) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingCloudwatchLogsExports) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/PendingCloudwatchLogsExports) # PendingMaintenanceAction 提供有关资源的待处理维护操作的信息。 ## 目录 **注意** 下表中，首先描述的是必需参数。 ** Action ** 可用于资源的待处理维护操作的类型。 类型：字符串 必需：否 ** AutoAppliedAfterDate ** 应用操作时维护时段的日期。维护操作在此日期之后的第一个维护时段期间应用于资源。如果指定了此日期，则忽略任何 `next-maintenance` 加入请求。 类型：时间戳 必需：否 ** CurrentApplyDate ** 待处理维护操作应用于资源的生效日期。 类型：时间戳 必需：否 ** Description ** 提供有关维护操作的更多详细信息的描述。 类型：字符串 必需：否 ** ForcedApplyDate ** 自动应用维护操作时的日期。无论资源的维护时段如何，维护操作都将在此日期应用于资源。如果指定了此日期，则忽略任何 `immediate` 加入请求。 类型：时间戳 必需：否 ** OptInStatus ** 指示已为资源接收的加入请求的类型。 类型：字符串 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingMaintenanceAction) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingMaintenanceAction) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/PendingMaintenanceAction) # PendingModifiedValues 一个实例的一个或多个已修改设置。已请求这些修改的设置，但尚未应用。 ## 目录 **注意** 下表中首先描述了必需参数。 ** AllocatedStorage ** 包含将要应用或当前正在应用的当时实例的新 `AllocatedStorage` 大小。 类型：整数 必需：否 ** BackupRetentionPeriod ** 指定保留自动备份的挂起天数。 类型：整数 必需：否 ** CACertificateIdentifier ** 指定数据库实例的证书机构（CA）证书的标识符。 类型：字符串 必需：否 ** DBInstanceClass ** 包含将要应用或当前正在应用的实例的新 `DBInstanceClass`。 类型：字符串 必需：否 ** DBInstanceIdentifier ** 包含将要应用或当前正在应用的实例的新 `DBInstanceIdentifier`。 类型：字符串 必需：否 ** DBSubnetGroupName ** 实例的新子网组。 类型：字符串 必需：否 ** EngineVersion ** 指示数据库引擎版本。 类型：字符串 必需：否 ** Iops ** 指定将应用或当前正在应用的实例的新预配置 IOPS 值。 类型：整数 必需：否 ** LicenseModel ** 实例的许可模式。 有效值: `license-included`, `bring-your-own-license`, `general-public-license` 类型：字符串 必需：否 ** MasterUserPassword ** 包含数据库实例的主凭证的待处理或当前正在进行的更改。 类型：字符串 必需：否 ** MultiAZ ** 指示单可用区实例将更改为多可用区部署。 类型：布尔值 必需：否 ** PendingCloudwatchLogsExports ** 其配置仍处于待处理状态的日志类型的列表。这些日志类型正处于激活或停用过程中。 类型：[PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md) 对象 必需：否 ** Port ** 指定实例的挂起端口。 类型：整数 必需：否 ** StorageType ** 指定要与实例关联的存储类型。 类型：字符串 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingModifiedValues) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingModifiedValues) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/PendingModifiedValues) # ResourcePendingMaintenanceActions 表示 [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md) 的输出。 ## 目录 **注意** 下表中，首先描述的是必需参数。 ** PendingMaintenanceActionDetails.PendingMaintenanceAction.N ** 一个列表，提供有关资源的待处理维护操作的详细信息。 类型：[PendingMaintenanceAction](API_PendingMaintenanceAction.md) 对象数组 必需：否 ** ResourceIdentifier ** 有待处理维护操作的资源的 Amazon 资源名称（ARN）。 类型：字符串 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ResourcePendingMaintenanceActions) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ResourcePendingMaintenanceActions) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ResourcePendingMaintenanceActions) # ServerlessV2FeaturesSupport 指定 Amazon DocumentDB 引擎版本之间存在差异的任何 Amazon DocumentDB 无服务器属性或限制。在决定对新集群或升级后的集群使用哪个 Amazon DocumentDB 版本时，可以测试此属性的值。您还可以检索现有集群的版本，并检查该版本是否支持特定的 Amazon DocumentDB 无服务器功能，然后再尝试使用这些功能。 ## 目录 **注意** 下表中首先描述了必需参数。 ** MaxCapacity ** Amazon DocumentDB 无服务器集群中实例的最大 Amazon DocumentDB 容量单位（DCU）数量。您能够以半步增量指定 DCU 值，如 32、32.5、33，以此类推。 类型：双精度 必需：否 ** MinCapacity ** Amazon DocumentDB 无服务器集群中实例的最小 Amazon DocumentDB 容量单位（DCU）数量。您能够以半步增量指定 DCU 值，如 8、8.5、9，以此类推。 类型：双精度 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2FeaturesSupport) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2FeaturesSupport) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2FeaturesSupport) # ServerlessV2ScalingConfiguration 设置 Amazon DocumentDB 无服务器集群的扩缩配置。 ## 目录 **注意** 下表中首先描述了必需参数。 ** MaxCapacity ** Amazon DocumentDB 无服务器集群中实例的最大 Amazon DocumentDB 容量单位（DCU）数量。您能够以半步增量指定 DCU 值，如 32、32.5、33，以此类推。 类型：双精度 必需：否 ** MinCapacity ** Amazon DocumentDB 无服务器集群中实例的最小 Amazon DocumentDB 容量单位（DCU）数量。您能够以半步增量指定 DCU 值，如 8、8.5、9，以此类推。 类型：双精度 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2ScalingConfiguration) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2ScalingConfiguration) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2ScalingConfiguration) # ServerlessV2ScalingConfigurationInfo 检索 Amazon DocumentDB 无服务器集群的扩缩配置。 ## 目录 **注意** 下表中首先描述了必需参数。 ** MaxCapacity ** Amazon DocumentDB 无服务器集群中实例的最大 Amazon DocumentDB 容量单位（DCU）数量。您能够以半步增量指定 DCU 值，如 32、32.5、33，以此类推。 类型：双精度 必需：否 ** MinCapacity ** Amazon DocumentDB 无服务器集群中实例的最小 Amazon DocumentDB 容量单位（DCU）数量。您能够以半步增量指定 DCU 值，如 8、8.5、9，以此类推。 类型：双精度 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo) # Subnet 有关子网的详细信息。 ## 目录 **注意** 下表中，首先描述的是必需参数。 ** SubnetAvailabilityZone ** 指定子网的可用区。 类型：[AvailabilityZone](API_AvailabilityZone.md) 对象 必需：否 ** SubnetIdentifier ** 指定子网的标识符。 类型：字符串 必需：否 ** SubnetStatus ** 指定子网的状态。 类型：字符串 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Subnet) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Subnet) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Subnet) # Tag 分配给包含键值对的 Amazon DocumentDB 资源的元数据。 ## 目录 **注意** 下表中首先描述了必需参数。 ** Key ** 标签的必填名称。该字符串值的长度可以在 1 到 128 个 Unicode 字符之间，并且不能带有前缀“`aws:`”或“`rds:`”。该字符串只能包含 Unicode 字母、数字、空格、“\$1”、“.”、“/”、“=”、“\$1”、“-”的集合（Java 正则表达式：“^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1”)。 类型：字符串 必需：否 ** Value ** 标签的可选值。该字符串值的长度可以在 1 到 256 个 Unicode 字符之间，并且不能带有前缀“`aws:`”或“`rds:`”。该字符串只能包含 Unicode 字母、数字、空格、“\$1”、“.”、“/”、“=”、“\$1”、“-”的集合（Java 正则表达式：“^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1”)。 类型：字符串 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Tag) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Tag) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Tag) # UpgradeTarget 实例可以升级到的数据库引擎的版本。 ## 目录 **注意** 下表中首先描述了必需参数。 ** AutoUpgrade ** 一个值，指示目标版本是否应用于`AutoMinorVersionUpgrade`设置为 `true` 的任何源数据库实例。 类型：布尔值 必需：否 ** Description ** 实例可以升级到的数据库引擎的版本。 类型：字符串 必需：否 ** Engine ** 升级目标数据库引擎的名称。 类型：字符串 必需：否 ** EngineVersion ** 升级目标数据库引擎的版本号。 类型：字符串 必需：否 ** IsMajorVersionUpgrade ** 一个值，用于指示数据库引擎是否已升级到主要版本。 类型：布尔值 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/UpgradeTarget) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/UpgradeTarget) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/UpgradeTarget) # VpcSecurityGroupMembership 用作查询虚拟私有云（VPC）安全组成员资格的响应元素。 ## 目录 **注意** 下表中首先描述了必需参数。 ** Status ** VPC 安全组的状态。 类型：字符串 必需：否 ** VpcSecurityGroupId ** VPC 安全组的名称。 类型：字符串 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/VpcSecurityGroupMembership) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/VpcSecurityGroupMembership) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/VpcSecurityGroupMembership) # Amazon DocumentDB Elastic Clusters Amazon DocumentDB 弹性集群支持以下数据类型： + [Cluster](API_elastic_Cluster.md) + [ClusterInList](API_elastic_ClusterInList.md) + [ClusterSnapshot](API_elastic_ClusterSnapshot.md) + [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md) + [PendingMaintenanceActionDetails](API_elastic_PendingMaintenanceActionDetails.md) + [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) + [Shard](API_elastic_Shard.md) + [ValidationExceptionField](API_elastic_ValidationExceptionField.md) # Cluster 返回有关特定静态集群的信息。 ## 目录 **注意** 下表中首先描述了必需参数。 ** adminUserName ** 弹性集群管理员的名称。 类型：字符串 必需：是 ** authType ** 弹性集群的身份验证类型。 类型：字符串 有效值：`PLAIN_TEXT | SECRET_ARN` 必需：是 ** clusterArn ** 弹性集群的 ARN 标识符。 类型：字符串 必需：是 ** clusterEndpoint ** 用于连接到弹性集群的 URL。 类型：字符串 必需：是 ** clusterName ** 弹性集群的名称。 类型：字符串 必需：是 ** createTime ** 创建弹性集群的时间，采用通用协调时间 (UTC)。 类型：字符串 必需：是 ** kmsKeyId ** 用于弹性集群加密的 KMS 密钥标识符。 类型：字符串 必需：是 ** preferredMaintenanceWindow ** 可进行系统维护的每周时间范围（采用通用协调时间（UTC））。 *格式*：`ddd:hh24:mi-ddd:hh24:mi` 类型：字符串 必需：是 ** shardCapacity ** 分配给每个弹性集群分片的 vCPU 数目。最大值为 64。允许值为 2、4、8、16、32、64。 类型：整数 必需：是 ** shardCount ** 分配给弹性集群的分片数目。最大值为 32。 类型：整数 必需：是 ** status ** 弹性集群的状态。 类型：字符串 有效值：`CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE` 必需：是 ** subnetIds ** 弹性集群的 Amazon EC2 子网 ID。 类型：字符串数组 必需：是 ** vpcSecurityGroupIds ** 与此集群关联的 EC2 VPC 安全组的列表。 类型：字符串数组 必需：是 ** backupRetentionPeriod ** 自动快照的保留天数。 类型：整数 必需：否 ** preferredBackupWindow ** 在启用自动备份的情况下每日执行自动备份的时间范围，如 `backupRetentionPeriod` 所规定。 类型：字符串 必需：否 ** shardInstanceCount ** 适用于此集群中所有分片的副本实例数量。`shardInstanceCount` 值为 1 表示有一个写入器实例，其他任何实例都是可用于读取和提高可用性的副本。 类型：整数 必需：否 ** shards ** 集群中的分片总数。 类型：[Shard](API_elastic_Shard.md) 对象数组 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/Cluster) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/Cluster) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/Cluster) # ClusterInList Amazon DocumentDB Elastic Clusters 列表。 ## 目录 **注意** 下表中首先描述了必需参数。 ** clusterArn ** 弹性集群的 ARN 标识符。 类型：字符串 必需：是 ** clusterName ** 弹性集群的名称。 类型：字符串 必需：是 ** status ** 弹性集群的状态。 类型：字符串 有效值：`CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE` 必需：是 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterInList) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterInList) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ClusterInList) # ClusterSnapshot 返回有关特定弹性集群快照的信息。 ## 目录 **注意** 下表中首先描述了必需参数。 ** adminUserName ** 弹性集群管理员的名称。 类型：字符串 必需：是 ** clusterArn ** 弹性集群的 ARN 标识符。 类型：字符串 必需：是 ** clusterCreationTime ** 创建弹性集群的时间，采用通用协调时间 (UTC)。 类型：字符串 必需：是 ** kmsKeyId ** KMS 密钥标识符是 KMS 加密密钥的 Amazon 资源名称 (ARN)。如果使用拥有此 KMS 加密密钥的同一 Amazon 账户创建集群，则可以使用 KMS 密钥别名而不是 ARN 作为 KMS 加密密钥。如果此处未指定加密密钥，Amazon DocumentDB 将使用 KMS 为您的账户创建的默认加密密钥。您的账户在每个 Amazon 区域都有一个不同的默认加密密钥。 类型：字符串 必需：是 ** snapshotArn ** 弹性集群快照的 ARN 标识符。 类型：字符串 必需：是 ** snapshotCreationTime ** 创建弹性集群快照的时间，采用通用协调时间 (UTC)。 类型：字符串 必需：是 ** snapshotName ** 弹性集群快照的名称。 类型：字符串 必需：是 ** status ** 弹性集群快照的状态。 类型：字符串 有效值：`CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE` 必需：是 ** subnetIds ** 弹性集群的 Amazon EC2 子网 ID。 类型：字符串数组 必需：是 ** vpcSecurityGroupIds ** 要与弹性集群关联的 EC2 VPC 安全组的列表。 类型：字符串数组 必需：是 ** snapshotType ** 要返回的集群快照的类型。可以指定以下值之一： + `automated` - 返回 Amazon DocumentDB 已为您的 AWS 账户自动创建的所有集群快照。 + `manual` - 返回您已为自身 AWS 账户手动创建的所有集群快照。 类型：字符串 有效值：`MANUAL | AUTOMATED` 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterSnapshot) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterSnapshot) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ClusterSnapshot) # ClusterSnapshotInList 弹性集群快照的列表。 ## 目录 **注意** 下表中首先描述了必需参数。 ** clusterArn ** 弹性集群的 ARN 标识符。 类型：字符串 必需：是 ** snapshotArn ** 弹性集群快照的 ARN 标识符。 类型：字符串 必需：是 ** snapshotCreationTime ** 创建弹性集群快照的时间，采用通用协调时间 (UTC)。 类型：字符串 必需：是 ** snapshotName ** 弹性集群快照的名称。 类型：字符串 必需：是 ** status ** 弹性集群快照的状态。 类型：字符串 有效值：`CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE` 必需：是 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterSnapshotInList) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterSnapshotInList) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ClusterSnapshotInList) # PendingMaintenanceActionDetails 检索待处理的维护操作的详细信息。 ## 目录 **注意** 下表中首先描述了必需参数。 ** action ** 显示待处理维护操作的具体操作。 类型：字符串 必需：是 ** autoAppliedAfterDate ** 显示应用操作时维护时段的日期。维护操作在此日期之后的第一个维护时段期间应用于资源。如果指定了此日期，则忽略任何 `NEXT_MAINTENANCE` `optInType` 请求。 类型：字符串 必需：否 ** currentApplyDate ** 显示待处理维护操作应用于资源的生效日期。 类型：字符串 必需：否 ** description ** 显示有关维护操作的更多详细信息的描述。 类型：字符串 必需：否 ** forcedApplyDate ** 显示自动应用维护操作时的日期。无论资源的维护时段如何，维护操作都将在此日期应用于资源。如果指定了此日期，则忽略任何 `IMMEDIATE` `optInType` 请求。 类型：字符串 必需：否 ** optInStatus ** 显示已为资源接收的 `optInType` 请求的类型。 类型：字符串 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails) # ResourcePendingMaintenanceAction 提供有关资源的待处理维护操作的信息。 ## 目录 **注意** 下表中首先描述了必需参数。 ** pendingMaintenanceActionDetails ** 提供有关资源的待处理维护操作的信息。 类型：[PendingMaintenanceActionDetails](API_elastic_PendingMaintenanceActionDetails.md) 对象数组 必需：否 ** resourceArn ** 待处理的维护操作应用于的资源的 Amazon DocumentDB Amazon 资源名称（ARN）。 类型：字符串 必需：否 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction) # Shard 分片的名称。 ## 目录 **注意** 下表中首先描述了必需参数。 ** createTime ** 创建分片的时间，采用通用协调时间 (UTC)。 类型：字符串 必需：是 ** shardId ** 分片的 ID。 类型：字符串 必需：是 ** status ** 分片的当前状态。 类型：字符串 有效值：`CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE` 必需：是 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/Shard) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/Shard) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/Shard) # ValidationExceptionField 其中出现给定验证异常的特定字段。 ## 目录 **注意** 下表中首先描述了必需参数。 ** message ** 描述此字段中验证异常的错误消息。 类型：字符串 必需：是 ** name ** 其中发生验证异常的字段的名称。 类型：字符串 必需：是 ## 另请参阅 有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容： + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ValidationExceptionField) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ValidationExceptionField) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ValidationExceptionField) # 常见错误 本部分列出了所有 AWS 服务的常见 API 操作错误。对于特定于此服务的 API 操作的错误，请参阅该 API 操作的主题。 **AccessDeniedException** 您没有足够的访问权限，无法执行该操作。 HTTP 状态代码：400 **IncompleteSignature** 请求签名不符合 AWS 标准。 HTTP 状态代码：400 **InternalFailure** 由于未知错误、异常或故障，请求处理失败。 HTTP 状态代码：500 **InvalidAction** 所请求的操作无效。确认正确键入了操作。 HTTP 状态代码：400 **InvalidClientTokenId** 在我们的记录中没有所提供的 X.509 证书或 AWS 访问密钥 ID。 HTTP 状态代码：403 **NotAuthorized** 您无权执行此操作。 HTTP 状态代码：400 **OptInRequired** AWS 访问密钥 ID 需要订阅服务。 HTTP 状态代码：403 **RequestExpired** 请求到达服务的时间超过请求上的日期戳 15 分钟或超过请求到期日期 15 分钟（例如，对于预签名 URL），或者请求上的日期戳比当前时间晚了 15 分钟以上。 HTTP 状态代码：400 **ServiceUnavailable** 由于服务器发生临时故障而导致请求失败。 HTTP 状态代码：503 **ThrottlingException** 由于请求限制而导致请求被拒绝。 HTTP 状态代码：400 **ValidationError** 输入未能满足 AWS 服务指定的约束。 HTTP 状态代码：400 # 常见参数 以下列表包含所有操作用于使用查询字符串对 Signature Version 4 请求进行签名的参数。任何特定于操作的参数都列在该操作的主题中。有关 Signature Version 4 的更多信息，请参阅《IAM 用户指南》**中的[签署 AWS API 请求](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)。 **Action** 要执行的操作。 类型：字符串。 必需：是 **Version** 编写请求所针对的 API 版本，格式为 YYYY-MM-DD。 类型：字符串。 必需：是 **X-Amz-Algorithm** 您用于创建请求签名的哈希算法。 条件：当您在查询字符串中而不是 HTTP 授权标头中包括身份验证信息时，请指定此参数。 类型：字符串 有效值：`AWS4-HMAC-SHA256` 必需：有条件 **X-Amz-Credential** 凭证范围值，该值是一个字符串，其中包含您的访问密钥、日期、您要定位的区域、您请求的服务以及终止字符串（“aws4\$1request”）。值采用以下格式表示：*access\$1key*/*YYYYMMDD*/*region*/*service*/aws4\$1request。 有关更多信息，请参阅《IAM 用户指南》**中的[创建已签名的 AWS API 请求](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html)。 条件：当您在查询字符串中而不是 HTTP 授权标头中包括身份验证信息时，请指定此参数。 类型：字符串 必需：有条件 **X-Amz-Date** 用于创建签名的日期。格式必须为 ISO 8601 基本格式 (YYYYMMDD'T'HHMMSS'Z')。例如，以下日期时间是有效的 X-Amz-Date 值：`20120325T120000Z`。 条件：X-Amz-Date 对于所有请求都是可选的；它可以用于覆盖对请求签名所使用的日期。如果以 ISO 8601 基本格式指定 Date 标头，则不需要 X-Amz-Date。使用 X-Amz-Date 时，它始终会覆盖 Date 标头的值。有关更多信息，请参阅《IAM 用户指南》**中的 [AWS API 请求签名的元素](https://docs.aws.amazon.com/IAM/latest/UserGuide/signing-elements.html)。 类型：字符串 必需：有条件 **X-Amz-Security-Token** 通过调用 AWS Security Token Service（AWS STS）获得的临时安全令牌。有关支持来自 AWS STS 的临时安全凭证的服务列表，请参阅《IAM 用户指南》**中的[使用 IAM 的 AWS 服务](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html)。 条件：如果您使用来自 AWS STS 的临时安全凭证，则必须包含安全令牌。 类型：字符串 必需：有条件 **X-Amz-Signature** 指定从要签名的字符串和派生的签名密钥计算的十六进制编码签名。 条件：当您在查询字符串中而不是 HTTP 授权标头中包括身份验证信息时，请指定此参数。 类型：字符串 必需：有条件 **X-Amz-SignedHeaders** 指定作为规范请求的一部分包含的所有 HTTP 标头。有关指定已签名标头的更多信息，请参阅《IAM 用户指南》**中的[创建已签名的 AWS API 请求](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html)。 条件：当您在查询字符串中而不是 HTTP 授权标头中包括身份验证信息时，请指定此参数。 类型：字符串 必需：有条件