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

Membuat atau mengkloning instans kluster sharded MongoDB.

Deskripsi operasi

Before you call this operation, make sure that you understand the billing methods and pricing of ApsaraDB for MongoDB.
For more information about the instance types of ApsaraDB for MongoDB, see Instance types.
To create a standalone or replica set instance, you can call the CreateDBInstance operation.

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 mengkueri ID wilayah.	cn-hangzhou
ZoneId	string	No	ID zona. Anda dapat memanggil operasi DescribeRegions untuk mengkueri ID zona.	cn-hangzhou-g
Engine	string	Yes	Mesin database. Atur nilainya menjadi MongoDB.	MongoDB
EngineVersion	string	Yes	Versi database. Nilai valid: 8.0 7.0 6.0 5.0 4.4 4.2 4.0 Catatan Untuk informasi lebih lanjut tentang batasan mesin penyimpanan dan versi database, lihat Versions and storage engines. Saat Anda mengkloning instans dengan memanggil operasi ini, nilai parameter ini harus sama dengan nilai instans sumber.	4.4
DBInstanceDescription	string	No	Nama instans. Nama harus memenuhi persyaratan berikut: Harus diawali dengan huruf. Dapat berisi digit, huruf, garis bawah (_), titik (.), dan tanda hubung (-). Harus memiliki panjang 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 berikut 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 dari 1 hingga 32. Catatan Anda dapat menambahkan maksimum 1.000 alamat IP atau Blok CIDR ke seluruh 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	Kata sandi akun root. Kata sandi harus memenuhi persyaratan berikut: Harus berisi setidaknya tiga jenis karakter berikut: huruf besar, huruf kecil, digit, dan karakter khusus. Karakter khusus meliputi !@#$%^&()_+-= Harus memiliki panjang 8 hingga 32 karakter. Catatan* Untuk informasi tentang cara mengatasi kegagalan koneksi yang disebabkan oleh karakter khusus dalam kata sandi, lihat How do I fix connection failures caused by special characters in a password?.	123456Aa
ChargeType	string	No	Metode penagihan Instans. Nilai valid: PostPaid: pay-as-you-go. Ini adalah nilai default. PrePaid: langganan. Catatan Jika Anda mengatur parameter ini menjadi PrePaid, Anda juga harus menentukan parameter Period.	PrePaid
Period	integer	No	Durasi langganan Instans. Unit: bulan. Nilai valid: 1 hingga 9 (integer), 12, 24, 36, dan 60. Catatan Parameter ini wajib dan berlaku hanya jika Anda mengatur parameter ChargeType menjadi PrePaid.	1
NetworkType	string	No	Jenis jaringan Instans. Nilai valid: VPC: virtual private cloud.	VPC
VpcId	string	No	ID virtual private cloud (VPC).	vpc-bp1n3i15v90el48nx****
VSwitchId	string	No	ID vSwitch.	vsw-bp1vj604nj5a9zz74****
SrcDBInstanceId	string	No	ID Instans sumber. Catatan Parameter ini wajib hanya jika Anda mengkloning Instans dengan memanggil operasi ini. Anda juga harus menentukan parameter RestoreTime.	dds-bp11483712c1****
RestoreTime	string	No	Pengatur waktu yang ingin Anda gunakan untuk memulihkan data. Anda dapat menentukan pengatur waktu apa pun dalam tujuh hari terakhir. Tentukan waktu dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu harus dalam Coordinated Universal Time (UTC). Catatan Parameter ini wajib hanya jika Anda mengkloning Instans dengan memanggil operasi ini. Anda juga harus menentukan parameter SrcDBInstanceId.	2022-03-08T02:30:25Z
ClientToken	string	No	token Klien yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan Klien untuk menghasilkan token, tetapi Anda harus memastikan bahwa token unik di antara permintaan yang berbeda. token hanya dapat berisi karakter ASCII dan tidak boleh melebihi 64 karakter.	ETnLKlblzczshOTUbOCz****
StorageEngine	string	No	Mesin penyimpanan instans. Atur nilainya menjadi WiredTiger. Catatan Saat Anda mengkloning instans dengan memanggil operasi ini, nilai parameter ini harus sama dengan nilai instans sumber. Untuk informasi lebih lanjut tentang batasan Mesin penyimpanan dan versi database, lihat Versions and storage engines.	WiredTiger
AutoRenew	string	No	Apakah akan mengaktifkan perpanjangan otomatis untuk Instans. Nilai valid: true: perpanjangan otomatis diaktifkan. false: perpanjangan otomatis dinonaktifkan. Anda harus memperpanjang Instans secara manual. Ini adalah nilai default. Catatan Parameter ini opsional dan berlaku hanya jika Anda mengatur parameter ChargeType menjadi PrePaid.	true
ProtocolType	string	No	Jenis Protokol Instans. Nilai valid: mongodb: protokol MongoDB. dynamodb: protokol DynamoDB.	mongodb
Mongos	array<object>	Yes	Informasi node Mongos (Proxy Layanan).
	object	Yes	The information of Mongos nodes.
Class	string	Yes	The instance type of the Mongos node. For more information, see Sharded cluster instance types. Catatan N in the parameter name specifies the serial number of the Mongos node. For example, Mongos.2.Class specifies the instance type of the second Mongos node. The value of N ranges from 2 to 32.	mdb.shard.2x.xlarge.d
ReplicaSet	array<object>	Yes	Informasi node shard.
	object	No	The information of shard nodes.
Class	string	Yes	The instance type of the shard node. For more information, see Sharded cluster instance types. Catatan N in the parameter name specifies the serial number of the shard node. For example, ReplicaSet.2.Class specifies the instance type of the second shard node. The value of N ranges from 2 to 32.	dds.shard.standard
Storage	integer	Yes	The storage space of the shard node. Unit: GB. Catatan The value of this parameter is constrained by the instance type. For more information, see Sharded cluster instance types. N in the parameter name specifies the serial number of the shard node. For example, ReplicaSet.2.Storage specifies the storage space of the second shard node.	10
ReadonlyReplicas	integer	No	The number of read-only nodes in the shard node. Valid values: 0 to 5. The default value is 0. Catatan N in the parameter name specifies the serial number of the shard node. For example, ReplicaSet.2.ReadonlyReplicas specifies the number of read-only nodes in the second shard node.	0
ConfigServer	array<object>	Yes	Informasi node Configserver.
	object	No	The information of Configserver nodes.
Class	string	Yes	The instance type of the Configserver node. Valid values: mdb.shard.2x.xlarge.d: 4-core 8 GB (dedicated). This instance type is available only for instances that run MongoDB 4.4 or later. dds.cs.mid: 1-core 2 GB (general-purpose). This instance type is available only for instances that run MongoDB 4.2 or earlier.	mdb.shard.2x.xlarge.d
Storage	integer	Yes	The storage space of the Configserver node. Unit: GB. Catatan The value of this parameter is constrained by the instance type. For more information, see Sharded cluster instance types.	20
SecondaryZoneId	string	No	Zona sekunder 1 untuk penerapan multi-zona. Nilai 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 lebih lanjut tentang kebijakan penerapan multi-zona untuk instans kluster sharded, lihat Create a multi-zone sharded cluster instance.	cn-hangzhou-h
HiddenZoneId	string	No	Zona sekunder 2 untuk penerapan multi-zona. Nilai 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 lebih lanjut tentang kebijakan penerapan multi-zona untuk instans kluster sharded, lihat Create a multi-zone sharded cluster instance.	cn-hangzhou-i
StorageType	string	No	Jenis penyimpanan. Nilai valid: cloud_essd1: SSD Enhanced (ESSD) PL1. cloud_essd2: ESSD PL2. cloud_essd3: ESSD PL3. local_ssd: SSD lokal. Catatan Instans yang menjalankan MongoDB 4.4 atau yang lebih baru hanya mendukung cloud disk. Jika Anda tidak menentukan parameter ini, cloud_essd1 akan digunakan. Instans yang menjalankan MongoDB 4.2 atau yang lebih lama 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	No	tag kustom.
Encrypted	boolean	No	Apakah akan mengaktifkan Enkripsi disk.
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 jika Anda membuat ulang Instans yang telah dirilis dari cadangan. Parameter ini wajib jika Anda mengkloning Instans dari cadangan geo-redundan.	cn-beijing
BackupId	string	No	ID cadangan Kluster. Catatan Parameter ini wajib hanya jika RestoreType diatur ke 2 atau 3.	cb-xxx
RestoreType	string	No	Metode pemulihan instans berbasis cadangan. Nilai valid: 1: memulihkan instans ke pengatur waktu tertentu. 2: memulihkan instans yang telah dirilis dari set cadangan tertentu. 3: memulihkan instans dari set cadangan geo-redundan tertentu.	1
DestRegion	string	No	Wilayah tempat cadangan geo-redundan disimpan.	cn-hangzhou
DestRegion	string	No	异地备份所在地域。	cn-hangzhou

Elemen respons

Element	Type	Description	Example
	object	The returned information.
RequestId	string	The request ID.	D8F1D721-6439-4257-A89C-F1E8E9C9****
DBInstanceId	string	The instance ID.	dds-bp114f14849d****
OrderId	string	The order ID.	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.