翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # 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 リソースネーム (ARN) です。KMS 暗号化キーを所有する Amazon アカウントと同じアカウントを使用して DB クラスターを作成する場合、KMS 暗号化キーの ARN の代わりに KMS キーのエイリアスを使用できます。ここで暗号化キーが指定されていない場合、Amazon DocumentDB は KMS がアカウント用に作成したデフォルトの暗号化キーを使用します。各アカウントは Amazon のリージョンごとにデフォルトの暗号化キーを持ちます。タイプ: 文字列必須: いいえ ** [shardCapacity](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** 新しく復元された Elastic クラスター内の各シャードの容量。タイプ: 整数必須: いいえ ** [shardInstanceCount](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** Elastic クラスター内のすべてのシャードに適用されるレプリカインスタンスの数。`shardInstanceCount` 値が 1 の場合、ライターインスタンスが 1 つあり、それ以外の追加のインスタンスはすべてレプリカであり、読み取りや可用性の向上に使用できます。タイプ: 整数必須: いいえ ** [subnetIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** エラスティッククラスターの Amazon EC2 サブネット ID。型: 文字列の配列必須: いいえ ** [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 ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot)