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

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

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

Amazon DocumentDB 彈性叢集管理員的名稱。

限制條件：

  • 必須為 1 到 63 個字母或數字。

  • 第一個字元必須是字母。

  • 不能是保留字。

類型：字串

必要：是

adminUserPassword

Amazon DocumentDB 彈性叢集管理員的密碼。密碼可以包含任何可列印的 ASCII 字元。

限制條件：

  • 必須包含 8 至 100 個字元。

  • 不能包含正斜線 (/)、雙引號 (「) 或「at」符號 (@)。

類型：字串

必要：是

authType

用來決定從何處擷取用於存取彈性叢集之密碼的驗證類型。有效類型為PLAIN_TEXT或SECRET_ARN。

類型：字串

有效值:PLAIN_TEXT | SECRET_ARN

必要：是

clusterName

新彈性叢集的名稱。此參數是以小寫字母字串的形式儲存。

限制條件：

  • 必須包含 1 到 63 個字母、數字或連字號。

  • 第一個字元必須是字母。

  • 不能以連字號結尾或連續包含兩個連字號。

範例：my-cluster

類型：字串

必要：是

shardCapacity

指派給每個彈性叢集碎片的 vCPUs 數目。最大值為 64 個。允許的值為 2、4、8、16、32、64。

類型：整數

必要：是

shardCount

指派給彈性叢集的碎片數目。最大值為 32。

類型：整數

必要：是

backupRetentionPeriod

自動快照的保留天數。

類型：整數

必要：否

clientToken

彈性叢集的用戶端權杖。

類型：字串

必要：否

kmsKeyId

用來加密新彈性叢集的 KMS 金鑰識別碼。

KMS 金鑰識別符是 KMS 加密金鑰的 Amazon Resource Name (ARN)。如果您使用擁有此 KMS 加密金鑰的相同 Amazon 帳戶建立叢集，則可以使用 KMS 金鑰別名而非 ARN 做為 KMS 加密金鑰。

如果未指定加密金鑰，Amazon DocumentDB 會使用 KMS 為您的帳戶建立的預設加密金鑰。您的帳戶對每個 Amazon 區域都有不同的預設加密金鑰。

類型：字串

必要：否

preferredBackupWindow

如果啟用了自動備份，則會建立自動備份的每日時間範圍 (由決定) backupRetentionPeriod。

類型：字串

必要：否

preferredMaintenanceWindow

每週可能進行系統維護的時段，以國際標準時間 (UTC) 表示。

格式：ddd:hh24:mi-ddd:hh24:mi

預設值：從每個 8 小時的時間段中隨機選取 30 分鐘的視窗 AWS 區域，發生在一週中的隨機日期。

有效日期：星期一，星期二，星期三，星期四，星期五，星期六，星期日

限制條件：必須至少是 30 分鐘的時段。

類型：字串

必要：否

shardInstanceCount

套用至彈性叢集中所有碎片的複本執行個體數目。shardInstanceCount值 1 表示有一個寫入器執行個體，而任何其他執行個體都是可用於讀取和改善可用性的複本。

類型：整數

必要：否

subnetIds

新彈性叢集的 Amazon EC2 子網路 ID。

類型：字串陣列

必要：否

tags

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

類型：字串到字串映射

索引鍵長度限制：長度下限為 1。長度上限為 128。

金鑰模式：^(?!aws:)[a-zA-Z+-=._:/]+$

值長度限制：最小長度為 0。長度上限為 256。

必要：否

vpcSecurityGroupIds

要與新彈性叢集關聯的 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

已建立的新彈性叢集。

類型：Cluster 物件

錯誤

如需所有動作常見錯誤的資訊，請參閱常見錯誤。

AccessDeniedException

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

HTTP 狀態碼：403

ConflictException

發生存取衝突。

HTTP 狀態碼：409

InternalServerException

發生內部伺服器錯誤。

HTTP 狀態碼：500

ServiceQuotaExceededException

超出動作的服務配額。

狀態碼：

ThrottlingException

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

HTTP 狀態碼：429

ValidationException

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

HTTP 狀態碼：400

另請參閱

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