本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。 # 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 Resource Name (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`、`fieldValidationFailed`、 `cannotParse`或之一`other`)。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS 適用於 Python 的 SDK](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 Resource Name (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 是 Amazon Resource Name (ARN)、 AWS KMS 金鑰識別符或 AWS KMS 加密金鑰的 AWS KMS 金鑰別名。如果您從 AWS 帳戶複製加密的彈性叢集快照，您可以指定的值`KmsKeyId`，以使用新的 AWS S KMS 加密金鑰來加密複本。如果您未指定的值`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`、`fieldValidationFailed`、 `cannotParse`或之一`other`)。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS 適用於 Python 的 SDK](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 個字元。 + 不能包含正斜線 (/)、雙引號 (") 或 "at" 符號 (@)。類型：字串必要：是 ** [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) ** 指派給每個彈性叢集碎片vCPUs 數目。上限為 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 Resource Name (ARN)。如果您使用擁有此 KMS 加密金鑰的相同 Amazon 帳戶建立叢集，您可以使用 KMS 金鑰別名，而非 ARN 做為 KMS 加密金鑰。如果未指定加密金鑰，Amazon DocumentDB 會使用 KMS 為您的帳戶建立的預設加密金鑰。您的帳戶在每個 Amazon 區域都有不同的預設加密金鑰。類型：字串必要：否 ** [preferredBackupWindow](#API_elastic_CreateCluster_RequestSyntax) ** 如果啟用自動備份，則建立自動備份的每日時間範圍，由決定`backupRetentionPeriod`。類型：字串必要：否 ** [preferredMaintenanceWindow](#API_elastic_CreateCluster_RequestSyntax) ** 每週可能進行系統維護的時段，以國際標準時間 (UTC) 表示。 *格式*：`ddd:hh24:mi-ddd:hh24:mi` *預設*：從每個 8 小時的時段中隨機選取的 30 分鐘時段 AWS 區域，發生在一週中的隨機一天。 *有效天數*：週一、週二、週三、週四、週五、週六、週日 *限制條件*：必須至少是 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`、`fieldValidationFailed`、 `cannotParse`或之一`other`)。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CreateCluster) + [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateCluster) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateCluster) + [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateCluster) + [AWS 適用於 Python 的 SDK](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`、`fieldValidationFailed`、 `cannotParse`或之一`other`)。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS 適用於 Python 的 SDK](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`、`fieldValidationFailed`、 `cannotParse`或之一`other`)。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/DeleteCluster) + [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteCluster) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteCluster) + [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteCluster) + [AWS 適用於 Python 的 SDK](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`、`fieldValidationFailed`、 `cannotParse`或之一`other`)。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS 適用於 Python 的 SDK](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`、`fieldValidationFailed`、 `cannotParse`或之一`other`)。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetCluster) + [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetCluster) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetCluster) + [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetCluster) + [AWS 適用於 Python 的 SDK](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) ** 彈性叢集快照的 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_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`、`fieldValidationFailed`、 `cannotParse`或之一`other`)。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS 適用於 Python 的 SDK](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 Resource Name (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`、`fieldValidationFailed`、 `cannotParse`或之一`other`)。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS 適用於 Python 的 SDK](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`、`fieldValidationFailed`、 `cannotParse`或之一`other`)。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusters) + [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusters) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusters) + [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusters) + [AWS 適用於 Python 的 SDK](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`、`fieldValidationFailed`、 `cannotParse`或之一`other`)。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS 適用於 Python 的 SDK](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`、`fieldValidationFailed`、 `cannotParse`或之一`other`)。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS 適用於 Python 的 SDK](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`、`fieldValidationFailed`、 `cannotParse`或之一`other`)。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS 適用於 Python 的 SDK](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) ** 彈性叢集快照的 ARN 識別符。必要：是 ## 請求主體請求接受採用 JSON 格式的下列資料。 ** [clusterName](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** 彈性叢集的名稱。類型：字串必要：是 ** [kmsKeyId](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** 用來加密新 Amazon DocumentDB 彈性叢集的 KMS 金鑰識別符。 KMS 金鑰識別符是 KMS 加密金鑰的 Amazon Resource Name (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`、`fieldValidationFailed`、 `cannotParse`或之一`other`)。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS 適用於 Java V2 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS 適用於 Python 的 SDK](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`、`fieldValidationFailed`、 `cannotParse`或之一`other`)。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/StartCluster) + [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StartCluster) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StartCluster) + [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StartCluster) + [AWS 適用於 Python 的 SDK](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`、`fieldValidationFailed`、 `cannotParse`或之一`other`)。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/StopCluster) + [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StopCluster) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StopCluster) + [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StopCluster) + [AWS 適用於 Python 的 SDK](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`、`fieldValidationFailed`、 `cannotParse`或之一`other`)。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/TagResource) + [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/TagResource) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/TagResource) + [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/TagResource) + [AWS 適用於 Python 的 SDK](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`、`fieldValidationFailed`、 `cannotParse`或之一`other`)。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UntagResource) + [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UntagResource) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UntagResource) + [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UntagResource) + [AWS 適用於 Python 的 SDK](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 修改彈性叢集。這包括更新 admin-username/password、升級 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 字元，但斜線 (/)、雙引號 (") 或 "at" 符號 (@) 則除外。 *限制條件*：必須包含 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) 表示。 *格式*：`ddd:hh24:mi-ddd:hh24:mi` *預設*：從每個 8 小時的時段中隨機選取的 30 分鐘時段 AWS 區域，發生在一週中的隨機一天。 *有效天數*：週一、週二、週三、週四、週五、週六、週日 *限制條件*：必須至少是 30 分鐘的時段。類型：字串必要：否 ** [shardCapacity](#API_elastic_UpdateCluster_RequestSyntax) ** 指派給每個彈性叢集碎片vCPUs 數目。上限為 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`、`fieldValidationFailed`、 `cannotParse`或之一`other`)。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UpdateCluster) + [AWS 適用於 .NET V4 的 SDK](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 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UpdateCluster) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UpdateCluster) + [AWS 適用於 JavaScript V3 的 SDK](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 V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UpdateCluster) + [AWS 適用於 Python 的 SDK](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)