本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。 # 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)