CreateClusterSnapshot - Amazon DocumentDB
請求語法URI 請求參數請求主體回應語法回應元素錯誤另請參閱

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

CreateClusterSnapshot

建立彈性叢集的快照。

請求語法

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

{
   "clusterArn": "string",
   "snapshotName": "string",
   "tags": { 
      "string" : "string" 
   }
}

URI 請求參數

請求不會使用任何 URI 參數。

請求主體

請求接受採用 JSON 格式的下列資料。

clusterArn

您要建立快照之彈性叢集的 ARN 識別碼。

類型：字串

必要：是

snapshotName

新彈性叢集快照的名稱。

類型：字串

長度限制：長度下限為 1。長度上限為 63。

必要：是

tags

要指派給新彈性叢集快照的標籤。

類型：字串到字串映射

索引鍵長度限制：長度下限為 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

當沒有足夠的權限執行動作時，就會發生例外狀況。

HTTP 狀態碼：403

ConflictException

發生存取衝突。

HTTP 狀態碼：409

InternalServerException

發生內部伺服器錯誤。

HTTP 狀態碼：500

ResourceNotFoundException

找不到指定的資源。

HTTP 狀態碼：404

ServiceQuotaExceededException

超出動作的服務配額。

狀態碼：

ThrottlingException

ThrottlingException 當請求被拒絕時，由於請求限制將被拋出。

HTTP 狀態碼：429

ValidationException

定義驗證例外狀況的結構。

HTTP 狀態碼：400

另請參閱

如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊，請參閱下列內容：