Menggunakan CreateShardingDBInstance untuk membuat atau mengkloning instans kluster terbagi - ApsaraDB untuk MongoDB

Membuat atau mengkloning instans kluster sharded MongoDB.

Deskripsi operasi

Sebelum memanggil operasi ini, pastikan Anda memahami metode penagihan dan harga ApsaraDB for MongoDB.
Untuk informasi selengkapnya tentang tipe instans ApsaraDB for MongoDB, lihat Tipe instans.
Untuk membuat instans standalone atau instans set replika, Anda dapat memanggil operasi CreateDBInstance.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

dds:CreateShardingDBInstance

create

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah. Anda dapat memanggil operasi DescribeRegions untuk menanyakan ID wilayah.	cn-hangzhou
ZoneId	string	No	ID zona. Anda dapat memanggil operasi DescribeRegions untuk menanyakan ID zona.	cn-hangzhou-g
Engine	string	Yes	Engine database. Tetapkan nilainya ke MongoDB.	MongoDB
EngineVersion	string	Yes	Versi database. Nilai yang valid: 8.0 7.0 6.0 5.0 4.4 4.2 4.0 Catatan Untuk informasi selengkapnya tentang batasan mesin penyimpanan dan versi database, lihat Versi dan mesin penyimpanan. Saat Anda mengkloning instans dengan memanggil operasi ini, nilai parameter ini harus sama dengan instans sumber.	4.4
DBInstanceDescription	string	No	Nama instans. Nama harus memenuhi persyaratan berikut: Harus diawali dengan karakter Tionghoa atau huruf. Dapat berisi angka, karakter Tionghoa, huruf, garis bawah (_), titik (.), dan tanda hubung (-). Panjangnya harus antara 2 hingga 256 karakter.	test
SecurityIPList	string	No	Daftar putih alamat IP instans. Pisahkan beberapa alamat IP dengan koma (,). Setiap alamat IP dalam daftar putih harus unik. Format yang didukung: 0.0.0.0/0 Alamat IP, seperti 10.23.12.24. Blok CIDR, seperti 10.23.12.0/24. Bagian /24 menunjukkan panjang awalan blok CIDR. Panjang awalan berkisar antara 1 hingga 32. Catatan Anda dapat menambahkan maksimal 1.000 alamat IP atau blok CIDR ke semua daftar putih alamat IP. Entri 0.0.0.0/0 mengizinkan akses dari semua alamat IP. Ini adalah pengaturan berisiko tinggi. Konfigurasikan dengan hati-hati.	192.168.xx.xx,192.168.xx.xx
AccountPassword	string	No	Password akun root. Password harus memenuhi persyaratan berikut: Harus berisi minimal tiga dari jenis karakter berikut: huruf kapital, huruf kecil, angka, dan karakter khusus. Karakter khusus meliputi !@#$%^&()_+-= Panjangnya harus antara 8 hingga 32 karakter. Catatan* Untuk informasi tentang cara mengatasi kegagalan koneksi yang disebabkan oleh karakter khusus dalam password, lihat Bagaimana cara memperbaiki kegagalan koneksi yang disebabkan oleh karakter khusus dalam password?.	123456Aa
ChargeType	string	No	Metode penagihan instans. Nilai yang valid: PostPaid: pay-as-you-go. Ini adalah nilai default. PrePaid: subscription. Catatan Jika Anda menetapkan parameter ini ke PrePaid, Anda juga harus menentukan parameter Period.	PrePaid
Period	integer	No	Durasi langganan instans. Satuan: bulan. Nilai yang valid: 1 hingga 9 (bilangan bulat), 12, 24, 36, dan 60. Catatan Parameter ini wajib dan hanya berlaku jika Anda menetapkan parameter ChargeType ke PrePaid.	1
NetworkType	string	No	Jenis jaringan instans. Nilai yang valid: VPC: virtual private cloud.	VPC
VpcId	string	No	ID virtual private cloud (VPC).	vpc-bp1n3i15v90el48nx****
VSwitchId	string	No	ID virtual switch.	vsw-bp1vj604nj5a9zz74****
SrcDBInstanceId	string	No	ID instans sumber. Catatan Parameter ini wajib hanya saat Anda mengkloning instans dengan memanggil operasi ini. Anda juga harus menentukan parameter RestoreTime.	dds-bp11483712c1****
RestoreTime	string	No	Titik waktu yang ingin Anda pulihkan datanya. Anda dapat menentukan titik waktu apa pun dalam tujuh hari terakhir. Waktu dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu dalam Coordinated Universal Time (UTC). Catatan Parameter ini wajib hanya saat Anda mengkloning instans dengan memanggil operasi ini. Anda juga harus menentukan parameter SrcDBInstanceId.	2022-03-08T02:30:25Z
ClientToken	string	No	Token client yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan client untuk menghasilkan token, tetapi Anda harus memastikan bahwa token tersebut unik di antara permintaan yang berbeda. Token hanya boleh berisi karakter ASCII dan tidak boleh melebihi 64 karakter.	ETnLKlblzczshOTUbOCz****
StorageEngine	string	No	Mesin penyimpanan instans. Tetapkan nilainya ke WiredTiger. Catatan Saat Anda mengkloning instans dengan memanggil operasi ini, nilai parameter ini harus sama dengan instans sumber. Untuk informasi selengkapnya tentang batasan mesin penyimpanan dan versi database, lihat Versi dan mesin penyimpanan.	WiredTiger
AutoRenew	string	No	Menentukan apakah perpanjangan otomatis untuk instans diaktifkan. Nilai yang valid: true: Perpanjangan otomatis diaktifkan. false: Perpanjangan otomatis dinonaktifkan. Anda harus memperpanjang instans secara manual. Ini adalah nilai default. Catatan Parameter ini opsional dan hanya berlaku jika Anda menetapkan parameter ChargeType ke PrePaid.	true
ProtocolType	string	No	Jenis protokol instans. Nilai yang valid: mongodb: Protokol MongoDB. dynamodb: Protokol DynamoDB.	mongodb
Mongos	array<object>	Yes	Informasi node Mongos.
	object	Yes	Informasi node Mongos.
Class	string	Yes	Tipe instans node Mongos. Untuk informasi selengkapnya, lihat Tipe instans kluster sharded. Catatan N dalam nama parameter menentukan nomor seri node Mongos. Misalnya, Mongos.2.Class menentukan tipe instans node Mongos kedua. Nilai N berkisar dari 2 hingga 32.	mdb.shard.2x.xlarge.d
ReplicaSet	array<object>	Yes	Informasi node shard.
	object	No	Informasi node shard.
Class	string	Yes	Tipe instans node shard. Untuk informasi selengkapnya, lihat Tipe instans kluster sharded. Catatan N dalam nama parameter menentukan nomor seri node shard. Misalnya, ReplicaSet.2.Class menentukan tipe instans node shard kedua. Nilai N berkisar dari 2 hingga 32.	dds.shard.standard
Storage	integer	Yes	Storage space node shard. Satuan: GB. Catatan Nilai parameter ini dibatasi oleh tipe instans. Untuk informasi selengkapnya, lihat Tipe instans kluster sharded. N dalam nama parameter menentukan nomor seri node shard. Misalnya, ReplicaSet.2.Storage menentukan storage space node shard kedua.	10
ReadonlyReplicas	integer	No	Jumlah node read-only dalam node shard. Nilai yang valid: 0 hingga 5. Nilai default adalah 0. Catatan N dalam nama parameter menentukan nomor seri node shard. Misalnya, ReplicaSet.2.ReadonlyReplicas menentukan jumlah node read-only dalam node shard kedua.	0
ConfigServer	array<object>	Yes	Informasi node Configserver.
	object	No	Informasi node Configserver.
Class	string	Yes	Tipe instans node Configserver. Nilai yang valid: mdb.shard.2x.xlarge.d: 4-core 8 GB (dedicated). Tipe instans ini hanya tersedia untuk instans yang menjalankan MongoDB 4.4 atau versi lebih baru. dds.cs.mid: 1-core 2 GB (general-purpose). Tipe instans ini hanya tersedia untuk instans yang menjalankan MongoDB 4.2 atau versi sebelumnya.	mdb.shard.2x.xlarge.d
Storage	integer	Yes	Storage space node Configserver. Satuan: GB. Catatan Nilai parameter ini dibatasi oleh tipe instans. Untuk informasi selengkapnya, lihat Tipe instans kluster sharded.	20
SecondaryZoneId	string	No	Zona sekunder 1 untuk penerapan multi-zona. Nilai yang valid: cn-hangzhou-g: Hangzhou Zona G. cn-hangzhou-h: Hangzhou Zona H. cn-hangzhou-i: Hangzhou Zona I. cn-hongkong-b: Hong Kong (Tiongkok) Zona B. cn-hongkong-c: Hong Kong (Tiongkok) Zona C. cn-hongkong-d: Hong Kong (Tiongkok) Zona D. cn-wulanchabu-a: Ulanqab Zona A. cn-wulanchabu-b: Ulanqab Zona B. cn-wulanchabu-c: Ulanqab Zona C. ap-southeast-1a: Singapura Zona A. ap-southeast-1b: Singapura Zona B. ap-southeast-1c: Singapura Zona C. ap-southeast-5a: Jakarta Zona A. ap-southeast-5b: Jakarta Zona B. ap-southeast-5c: Jakarta Zona C. eu-central-1a: Frankfurt Zona A. eu-central-1b: Frankfurt Zona B. eu-central-1c: Frankfurt Zona C. Catatan Parameter ini tersedia untuk instans berbasis disk. Nilai parameter ini tidak boleh sama dengan nilai ZoneId atau HiddenZoneId. Untuk informasi selengkapnya tentang kebijakan penerapan multi-zona untuk instans kluster sharded, lihat Buat instans kluster sharded multi-zona.	cn-hangzhou-h
HiddenZoneId	string	No	Zona sekunder 2 untuk penerapan multi-zona. Nilai yang valid: cn-hangzhou-g: Hangzhou Zona G. cn-hangzhou-h: Hangzhou Zona H. cn-hangzhou-i: Hangzhou Zona I. cn-hongkong-b: Hong Kong (Tiongkok) Zona B. cn-hongkong-c: Hong Kong (Tiongkok) Zona C. cn-hongkong-d: Hong Kong (Tiongkok) Zona D. cn-wulanchabu-a: Ulanqab Zona A. cn-wulanchabu-b: Ulanqab Zona B. cn-wulanchabu-c: Ulanqab Zona C. ap-southeast-1a: Singapura Zona A. ap-southeast-1b: Singapura Zona B. ap-southeast-1c: Singapura Zona C. ap-southeast-5a: Jakarta Zona A. ap-southeast-5b: Jakarta Zona B. ap-southeast-5c: Jakarta Zona C. eu-central-1a: Frankfurt Zona A. eu-central-1b: Frankfurt Zona B. eu-central-1c: Frankfurt Zona C. Catatan Parameter ini tersedia untuk instans berbasis disk. Nilai parameter ini tidak boleh sama dengan nilai ZoneId atau SecondaryZoneId. Untuk informasi selengkapnya tentang kebijakan penerapan multi-zona untuk instans kluster sharded, lihat Buat instans kluster sharded multi-zona.	cn-hangzhou-i
StorageType	string	No	Jenis penyimpanan. Nilai yang valid: cloud_essd1: enhanced SSD (ESSD) PL1. cloud_essd2: ESSD PL2. cloud_essd3: ESSD PL3. local_ssd: local SSD. Catatan Instans yang menjalankan MongoDB 4.4 atau versi lebih baru hanya mendukung disk. Jika Anda tidak menentukan parameter ini, cloud_essd1 akan digunakan. Instans yang menjalankan MongoDB 4.2 atau versi sebelumnya hanya mendukung disk lokal. Jika Anda tidak menentukan parameter ini, local_ssd akan digunakan.	cloud_essd1
GlobalSecurityGroupIds	string	No	Templat daftar putih alamat IP global instans. Pisahkan beberapa templat dengan koma (,). Setiap templat harus unik.	g-qxieqf40xjst1ngpr3jz
Tag	array<object>	No	Tag kustom.
	object	No	Tag kustom yang ditambahkan ke instans.
Key	string	No	Kunci tag. Catatan N menentukan nomor seri tag. Misalnya, Tag.1.Key menentukan kunci tag pertama, dan Tag.2.Key menentukan kunci tag kedua.	testdatabase
Value	string	No	Nilai tag. Catatan N menentukan nomor seri tag. Misalnya, Tag.1.Value menentukan nilai tag pertama, dan Tag.2.Value menentukan nilai tag kedua.	apitest
Encrypted	boolean	No	Menentukan apakah enkripsi disk diaktifkan.	true
EncryptionKey	string	No	ID kunci kustom.	2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ProvisionedIops	integer	No	IOPS yang disediakan.	1960
SrcRegion	string	No	Wilayah instans sumber. Catatan Parameter ini wajib saat Anda membuat ulang instans yang telah dirilis dari backup. Parameter ini wajib saat Anda mengkloning instans dari backup geo-redundant.	cn-beijing
BackupId	string	No	ID backup kluster. Catatan Parameter ini wajib hanya jika RestoreType diatur ke 2 atau 3.	cb-xxx
RestoreType	string	No	Metode pemulihan instans berdasarkan backup. 1: Pulihkan instans ke titik waktu tertentu. 2: Pulihkan instans yang telah dirilis dari set backup tertentu. 3: Pulihkan instans dari set backup geo-redundant tertentu.	1
DestRegion	string	No	Wilayah tempat backup geo-redundant disimpan.	cn-hangzhou

Elemen respons

Element	Type	Description	Example
	object	Informasi yang dikembalikan.
RequestId	string	ID permintaan.	D8F1D721-6439-4257-A89C-F1E8E9C9****
DBInstanceId	string	ID instans.	dds-bp114f14849d****
OrderId	string	ID pesanan.	21010996721****

Contoh

Respons sukses

JSONformat

{
  "RequestId": "D8F1D721-6439-4257-A89C-F1E8E9C9****",
  "DBInstanceId": "dds-bp114f14849d****",
  "OrderId": "21010996721****"
}

Kode kesalahan

HTTP status code	Error code	Error message
400	SecurityRisk.AuthVerification	we have detected a risk with your default payment method. An email and notification has been sent to you. Please re-submit your order before after verificaiton.
400	InvaliadParameter.ShardsCount.LessThanSrc	The specified number of shards is less than that of source instance.
400	ORDER.ACCOUNT_INFORMATION_INCOMPLETE	Your information is incomplete. Complete your information before ordering.
400	InvalidRegion.Format	Specified Region is not valid.
400	Zone.Closed	The specified zone is closed.
400	TokenServiceError	The request token is duplicated.
400	InvalidParam	Param not valid.
400	InvalidEngineVersion.Malformed	Specified engine version is not valid.
400	InvalidParameters.Format	Specified parameters is not valid.
400	RestoreTypeNotSupported	The specified restoreType is not supported for the instance, check the input parameters 'RestoreType/BackupID/RestoreTime'.
500	VpcServiceError	Invoke vpc service error.
403	InvalidBackupLogStatus	Current backup log enable status does not support this operation.
403	ReduceDiskNotSupport	Reduce disk size is not supported in clone/restore.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.