Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
CreateCluster
Membuat cluster elastis Amazon DocumentDB baru dan mengembalikan struktur klasternya.
Minta Sintaks
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" ]
}Parameter Permintaan URI
Permintaan tidak menggunakan parameter URI apa pun.
Isi Permintaan
Permintaan menerima data berikut dalam format JSON.
- adminUserName
-
Nama administrator cluster elastis Amazon DocumentDB.
Kendala:
-
Harus dari 1 hingga 63 huruf atau angka.
-
Karakter pertama harus berupa huruf.
-
Tidak dapat berupa kata yang dicadangkan.
Tipe: String
Diperlukan: Ya
-
- adminUserPassword
-
Kata sandi untuk administrator cluster elastis Amazon DocumentDB. Kata sandi dapat berisi karakter ASCII yang dapat dicetak.
Kendala:
-
Harus berisi 8 hingga 100 karakter.
-
Tidak dapat berisi garis miring (/), tanda kutip ganda (“), atau simbol “at” (@).
Tipe: String
Diperlukan: Ya
-
- authType
-
Jenis otentikasi yang digunakan untuk menentukan di mana untuk mengambil password yang digunakan untuk mengakses cluster elastis. Jenis yang valid adalah
PLAIN_TEXTatauSECRET_ARN.Jenis: String
Nilai yang Valid:
PLAIN_TEXT | SECRET_ARNWajib: Ya
- clusterName
-
Nama cluster elastis baru. Parameter ini disimpan sebagai string huruf kecil.
Kendala:
-
Harus berisi 1 hingga 63 huruf, angka, atau tanda hubung.
-
Karakter pertama harus berupa huruf.
-
Tidak dapat diakhiri dengan tanda hubung atau mengandung dua tanda hubung berturut-turut.
Contoh:
my-clusterTipe: String
Diperlukan: Ya
-
- shardCapacity
-
Jumlah vCPU yang ditetapkan untuk setiap pecahan cluster elastis. Maksimal adalah 64. Nilai yang diizinkan adalah 2, 4, 8, 16, 32, 64.
Jenis: Integer
Wajib: Ya
- shardCount
-
Jumlah pecahan yang ditugaskan ke cluster elastis. Maksimal adalah 32.
Jenis: Integer
Wajib: Ya
- backupRetentionPeriod
-
Jumlah hari di mana snapshot otomatis dipertahankan.
Tipe: Integer
Wajib: Tidak
- clientToken
-
Token klien untuk cluster elastis.
Tipe: String
Wajib: Tidak
- kmsKeyId
-
Pengidentifikasi kunci KMS yang digunakan untuk mengenkripsi cluster elastis baru.
Pengidentifikasi kunci KMS adalah Amazon Resource Name (ARN) untuk kunci enkripsi KMS. Jika Anda membuat cluster menggunakan akun Amazon yang sama yang memiliki kunci enkripsi KMS ini, Anda dapat menggunakan alias kunci KMS alih-alih ARN sebagai kunci enkripsi KMS.
Jika kunci enkripsi tidak ditentukan, Amazon DocumentDB menggunakan kunci enkripsi default yang dibuat KMS untuk akun Anda. Akun Anda memiliki kunci enkripsi default yang berbeda untuk setiap Wilayah Amazon.
Tipe: String
Wajib: Tidak
- preferredBackupWindow
-
Rentang waktu harian di mana pencadangan otomatis dibuat jika pencadangan otomatis diaktifkan, sebagaimana ditentukan oleh.
backupRetentionPeriodTipe: String
Wajib: Tidak
- preferredMaintenanceWindow
-
Rentang waktu mingguan selama pemeliharaan sistem dapat terjadi, dalam Waktu Universal Terkoordinasi (UTC).
Format:
ddd:hh24:mi-ddd:hh24:miDefault: jendela 30 menit yang dipilih secara acak dari blok waktu 8 jam untuk masing-masing Wilayah AWS, terjadi pada hari acak dalam seminggu.
Hari yang berlaku: Senin, Sel, Rabu, Kam, Jumat, Sabtu, Minggu
Kendala: Jendela minimum 30 menit.
Tipe: String
Wajib: Tidak
- shardInstanceCount
-
Jumlah contoh replika yang berlaku untuk semua pecahan di cluster elastis.
shardInstanceCountNilai 1 berarti ada satu contoh penulis, dan setiap contoh tambahan adalah replika yang dapat digunakan untuk membaca dan untuk meningkatkan ketersediaan.Tipe: Integer
Wajib: Tidak
- subnetIds
-
ID subnet Amazon EC2 untuk cluster elastis baru.
Tipe: Array string
Wajib: Tidak
-
Tag yang akan ditetapkan ke cluster elastis baru.
Tipe: Peta string ke string
Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 128.
Pola Kunci:
^(?!aws:)[a-zA-Z+-=._:/]+$Batasan Panjang Nilai: Panjang minimum 0. Panjang maksimum 256.
Wajib: Tidak
- vpcSecurityGroupIds
-
Daftar grup keamanan VPC EC2 untuk diasosiasikan dengan cluster elastis baru.
Tipe: Array string
Wajib: Tidak
Sintaksis Respons
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" ]
}
}Elemen Respons
Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.
Layanan mengembalikan data berikut dalam format JSON.
Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.
- AccessDeniedException
-
Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.
Kode Status HTTP: 403
- ConflictException
-
Terjadi konflik akses.
Kode Status HTTP: 409
- InternalServerException
-
Ada kesalahan server internal.
Kode Status HTTP: 500
- ServiceQuotaExceededException
-
Kuota layanan untuk tindakan terlampaui.
Kode Status HTTP: 402
- ThrottlingException
-
ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.
Kode Status HTTP: 429
- ValidationException
-
Struktur yang mendefinisikan pengecualian validasi.
Kode Status HTTP: 400
Lihat Juga
Untuk informasi selengkapnya tentang penggunaan API ini di salah satu AWS SDK khusus bahasa, lihat berikut ini:
