CopyClusterSnapshot - Amazon DocumentDB
リクエストの構文URI リクエストパラメータリクエストボディレスポンスの構文レスポンス要素エラー以下の資料も参照してください。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

CopyClusterSnapshot

Elastic クラスターのスナップショットをコピーします。

リクエストの構文

POST /cluster-snapshot/snapshotArn/copy HTTP/1.1
Content-type: application/json

{
   "copyTags": boolean,
   "kmsKeyId": "string",
   "tags": { 
      "string" : "string" 
   },
   "targetSnapshotName": "string"
}

URI リクエストパラメータ

リクエストでは、次の URI パラメータを使用します。

snapshotArn

Elastic クラスタースナップショットの Amazon リソースネーム (ARN) 識別子。

必須: はい

リクエストボディ

リクエストは以下の JSON 形式のデータを受け入れます。

targetSnapshotName

コピー元のクラスタースナップショットから作成される新しい Elastic クラスタースナップショットの識別子。このパラメータは大文字と小文字が区別されません。

制約:

  • 1 ～ 63 の文字、数字またはハイフンを使用する必要があります。

  • 1 字目は文字である必要があります。

  • ハイフンを、文字列の最後に使用したり、2 つ続けて使用したりすることはできません。

例:elastic-cluster-snapshot-5

タイプ: 文字列

長さの制約: 最小長は 1 です。最大長は 63 です。

必須: はい

copyTags

コピー元のクラスタースナップショットからコピー先のクラスタースナップショットにすべてのタグをコピーする場合は true に設定します。デフォルトは false です。

型: ブール値

必須: いいえ

kmsKeyId

暗号化された Elastic クラスタースナップショットの AWS KMS キー ID。AWS KMS キー ID は、その AWS KMS 暗号化キーの Amazon リソースネーム (ARN)、AWS KMS キー識別子、または AWS KMS キーエイリアスのいずれかとなります。

お使いの AWS アカウントから暗号化された Elastic クラスタースナップショットをコピーする場合、 KmsKeyId の値を指定して新しい AWS KMS 暗号化キーでコピーを暗号化できます。KmsKeyId の値を指定しない場合、Elastic クラスタースナップショットのコピーはコピー元の Elastic クラスタースナップショットと同じ AWS KMS キーで暗号化されます。

暗号化されていない Elastic クラスタースナップショットをコピーして KmsKeyId パラメータに値を指定すると、エラーが返されます。

タイプ: 文字列

必須: いいえ

tags

Elastic クラスタースナップショットに割り当てるタグ。

型: 文字列間のマッピング

キーの長さ制限: 最小長は 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

特定のエラスティッククラスタースナップショットに関する情報を返します。

型: ClusterSnapshot オブジェクト

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

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 SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。