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

Membuat atau mengkloning instans kluster sharded Database Apsara for MongoDB.

Deskripsi operasi

Sebelum memanggil operasi ini, pastikan Anda sepenuhnya memahami metode penagihan dan harga Database Apsara for MongoDB.
Untuk informasi selengkapnya tentang spesifikasi instans Database Apsara for MongoDB, lihat Spesifikasi instans.
Untuk membuat instans standalone atau set replika, panggil 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

*Instans.

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 nilai menjadi MongoDB. Valid values: MongoDB : Mesin database MongoDB.	MongoDB
EngineVersion	string	Yes	Nomor versi database. Nilai valid: 8.0 7.0 6.0 5.0 4.4 4.2 4.0 Catatan Untuk informasi selengkapnya tentang batasan pada mesin penyimpanan dan versi, lihat Versi mesin database dan mesin penyimpanan. Saat memanggil operasi ini untuk mengkloning instans, atur parameter ini ke nilai yang sama dengan instans sumber.	4.4
DBInstanceDescription	string	No	Nama instans. Nilai valid: Nama harus diawali dengan huruf. Nama dapat berisi angka, huruf, garis bawah (_), titik (.), dan tanda hubung (-). Panjang nama harus 2 hingga 256 karakter.	test
SecurityIPList	string	No	Daftar putih alamat IP instans. Pisahkan beberapa alamat IP dengan koma (,). Alamat IP tidak boleh duplikat. Tiga format berikut didukung: 0.0.0.0/0 Alamat IP, misalnya 10.23.12.24. Blok CIDR, misalnya 10.23.12.0/24, di mana 24 menunjukkan panjang awalan dalam alamat IP dan nilainya berkisar dari 1 hingga 32. Catatan Anda dapat menambahkan hingga 1.000 alamat IP atau Blok CIDR ke semua kelompok daftar putih alamat IP instans. Jika Anda mengatur parameter ini ke 0.0.0.0/0, semua alamat IP dapat mengakses instans. Gunakan pengaturan ini dengan hati-hati.	192.168.xx.xx,192.168.xx.xx
AccountPassword	string	No	Kata sandi akun root. Nilai valid: Kata sandi harus mengandung setidaknya tiga dari jenis karakter berikut: huruf besar, huruf kecil, angka, dan karakter khusus. Karakter khusus meliputi !@#$%^&()_+-= Panjang kata sandi harus 8 hingga 32 karakter. Catatan* Untuk informasi selengkapnya tentang cara memecahkan masalah kegagalan koneksi database yang disebabkan oleh karakter khusus dalam string koneksi, lihat Bagaimana cara memecahkan masalah kegagalan koneksi yang disebabkan oleh karakter khusus dalam kata sandi akun string koneksi?.	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 ke PrePaid, Anda juga harus mengonfigurasi parameter Period. Valid values: PostPaid : Pay-as-you-go. PrePaid : Langganan.	PrePaid
Period	integer	No	Periode langganan instans. Unit: bulan. Nilai valid: 1 hingga 9 (bilangan bulat), 12, 24, 36, dan 60. Catatan Parameter ini tersedia dan wajib hanya ketika Anda mengatur ChargeType ke PrePaid.	1
NetworkType	string	No	Jenis jaringan instans. Nilai valid: VPC: virtual private cloud (VPC).	VPC
VpcId	string	No	ID VPC.	vpc-bp1n3i15v90el48nx****
VSwitchId	string	No	ID vSwitch.	vsw-bp1vj604nj5a9zz74****
SrcDBInstanceId	string	No	ID instans sumber. Catatan Parameter ini wajib hanya ketika Anda memanggil operasi ini untuk mengkloning instans. Anda juga harus mengonfigurasi parameter RestoreTime.	dds-bp11483712c1****
RestoreTime	string	No	Titik waktu tertentu untuk memulihkan data. Anda dapat menentukan titik waktu apa pun dalam tujuh hari terakhir. Tentukan waktu dalam format yyyy-MM-ddTHH:mm:ssZ (UTC). Catatan Parameter ini wajib hanya ketika Anda memanggil operasi ini untuk mengkloning instans. Anda juga harus mengonfigurasi 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 pastikan token tersebut unik di antara permintaan yang berbeda. Token hanya dapat berisi karakter ASCII dan panjangnya tidak boleh melebihi 64 karakter.	ETnLKlblzczshOTUbOCz****
StorageEngine	string	No	Mesin penyimpanan instans. Atur nilai menjadi WiredTiger. Catatan Saat memanggil operasi ini untuk mengkloning instans, atur parameter ini ke nilai yang sama dengan instans sumber. Untuk informasi selengkapnya tentang batasan pada mesin penyimpanan dan versi, lihat Versi mesin database dan mesin penyimpanan.	WiredTiger
AutoRenew	string	No	Apakah akan mengaktifkan perpanjangan otomatis untuk instans. Nilai valid: true: Mengaktifkan perpanjangan otomatis. false: Menonaktifkan perpanjangan otomatis. Anda harus memperpanjang instans secara manual. Ini adalah nilai default. Catatan Parameter ini tersedia dan opsional hanya ketika Anda mengatur ChargeType ke PrePaid.	true
ProtocolType	string	No	Tipe protokol akses. Nilai valid: mongodb: Protokol MongoDB. dynamodb: Protokol DynamoDB. Valid values: mongodb : Protokol MongoDB. dynamodb : Protokol DynamoDB.	mongodb
Mongos	array<object>	Yes	Informasi tentang node Mongos.
	object	Yes	Informasi tentang node Mongos.
Class	string	Yes	Spesifikasi node Mongos. Untuk informasi selengkapnya, lihat Spesifikasi instans kluster sharded. Catatan N dalam nama parameter menunjukkan nomor urut node Mongos. Misalnya, Mongos.2.Class menunjukkan spesifikasi node Mongos kedua. Nilai valid untuk N: 2 hingga 32.	mdb.shard.2x.xlarge.d
ReplicaSet	array<object>	Yes	Informasi tentang node Shard.
	object	No	Informasi tentang node Shard.
Class	string	Yes	Spesifikasi node Shard. Untuk informasi selengkapnya, lihat Spesifikasi instans kluster sharded. Catatan N dalam nama parameter menunjukkan nomor urut node Shard. Misalnya, Set Replika.2.Class menunjukkan spesifikasi node Shard kedua. Nilai valid untuk N: 2 hingga 32.	dds.shard.standard
Storage	integer	Yes	Kapasitas penyimpanan node Shard. Unit: GB. Catatan Nilai valid bergantung pada spesifikasi instans. Untuk informasi selengkapnya, lihat Spesifikasi instans kluster sharded. N dalam nama parameter menunjukkan nomor urut node Shard. Misalnya, Set Replika.2.Storage menunjukkan kapasitas penyimpanan node Shard kedua.	10
ReadonlyReplicas	integer	No	Jumlah node baca-saja untuk node Shard. Nilai valid: 0 hingga 5 (bilangan bulat). Nilai default: 0. Catatan N dalam nama parameter menunjukkan nomor urut node Shard. Misalnya, Set Replika.2.ReadonlyReplicas menunjukkan jumlah node baca-saja untuk node Shard kedua.	0
ConfigServer	array<object>	Yes	Informasi tentang node Configserver.
	object	No	Informasi tentang node Configserver.
Class	string	Yes	Spesifikasi node Configserver. Nilai valid: mdb.shard.2x.xlarge.d: 4 vCPU, memori 8 GB (khusus). Nilai ini hanya didukung untuk instans yang menjalankan versi 4.4 atau yang lebih baru. dds.cs.mid: 1 vCPU, memori 2 GB (serbaguna). Nilai ini hanya didukung untuk instans yang menjalankan versi 4.2 atau yang lebih lama.	mdb.shard.2x.xlarge.d
Storage	integer	Yes	Kapasitas penyimpanan node Configserver. Unit: GB. Catatan Nilai valid bergantung pada spesifikasi instans. Untuk informasi selengkapnya, lihat Spesifikasi instans kluster sharded.	20
SecondaryZoneId	string	No	ID kelompok sumber daya. Untuk informasi selengkapnya, lihat Melihat informasi dasar kelompok sumber daya.	rg-acfmyiu4ekp****
HiddenZoneId	string	No	Zona sekunder 1 untuk penerapan multi-zona. Nilai valid: cn-hangzhou-g: Zona G Hangzhou. cn-hangzhou-h: Zona H Hangzhou. cn-hangzhou-i: Zona I Hangzhou. cn-hongkong-b: Zona B Hong Kong (Tiongkok). cn-hongkong-c: Zona C Hong Kong (Tiongkok). cn-hongkong-d: Zona D Hong Kong (Tiongkok). cn-wulanchabu-a: Zona A Ulanqab. cn-wulanchabu-b: Zona B Ulanqab. cn-wulanchabu-c: Zona C Ulanqab. ap-southeast-1a: Zona A Singapura. ap-southeast-1b: Zona B Singapura. ap-southeast-1c: Zona C Singapura. ap-southeast-5a: Zona A Jakarta. ap-southeast-5b: Zona B Jakarta. ap-southeast-5c: Zona C Jakarta. eu-central-1a: Zona A Frankfurt. eu-central-1b: Zona B Frankfurt. eu-central-1c: Zona C Frankfurt. Catatan Parameter ini tersedia hanya ketika instans menggunakan cloud disk. Nilai parameter ini tidak boleh sama dengan nilai ZoneId atau HiddenZoneId. Untuk informasi selengkapnya tentang strategi penerapan multi-zona untuk instans kluster sharded, lihat Membuat instans kluster sharded multi-zona.	cn-hangzhou-h
StorageType	string	No	Zona sekunder 2 untuk penerapan multi-zona. Nilai valid: cn-hangzhou-g: Zona G Hangzhou. cn-hangzhou-h: Zona H Hangzhou. cn-hangzhou-i: Zona I Hangzhou. cn-hongkong-b: Zona B Hong Kong (Tiongkok). cn-hongkong-c: Zona C Hong Kong (Tiongkok). cn-hongkong-d: Zona D Hong Kong (Tiongkok). cn-wulanchabu-a: Zona A Ulanqab. cn-wulanchabu-b: Zona B Ulanqab. cn-wulanchabu-c: Zona C Ulanqab. ap-southeast-1a: Zona A Singapura. ap-southeast-1b: Zona B Singapura. ap-southeast-1c: Zona C Singapura. ap-southeast-5a: Zona A Jakarta. ap-southeast-5b: Zona B Jakarta. ap-southeast-5c: Zona C Jakarta. eu-central-1a: Zona A Frankfurt. eu-central-1b: Zona B Frankfurt. eu-central-1c: Zona C Frankfurt. Catatan Parameter ini tersedia hanya ketika instans menggunakan cloud disk. Nilai parameter ini tidak boleh sama dengan nilai ZoneId atau SecondaryZoneId. Untuk informasi selengkapnya tentang strategi penerapan multi-zona untuk instans kluster sharded, lihat Membuat instans kluster sharded multi-zona.	cn-hangzhou-i
GlobalSecurityGroupIds	string	No	Tipe penyimpanan. Nilai valid: cloud_essd1: ESSD PL1. cloud_essd2: ESSD PL2. cloud_essd3: ESSD PL3. local_ssd: SSD lokal. Catatan Instans yang menjalankan versi 4.4 atau yang lebih baru hanya mendukung cloud disk. Jika Anda tidak menentukan parameter ini, cloud_essd1 akan digunakan secara default. Instans yang menjalankan versi 4.2 atau yang lebih lama hanya mendukung disk lokal. Jika Anda tidak menentukan parameter ini, local_ssd akan digunakan secara default.	cloud_essd1
Tag	array<object>	No	Template daftar putih alamat IP global instans. Pisahkan beberapa template dengan koma (,). Template tidak boleh duplikat.	g-qxieqf40xjst1ngpr3jz
	object	No	The custom tags added to the instance.
Key	string	No	The key of the tag. Catatan N specifies the serial number of the tag. For example, Tag.1.Key specifies the key of the first tag, and Tag.2.Key specifies the key of the second tag.	testdatabase
Value	string	No	The value of the tag. Catatan N specifies the serial number of the tag. For example, Tag.1.Value specifies the value of the first tag, and Tag.2.Value specifies the value of the second tag.	apitest
Encrypted	boolean	No	Tag kustom.	true
EncryptionKey	string	No	Apakah akan mengaktifkan enkripsi disk.	true
ProvisionedIops	integer	No	ID kunci enkripsi kustom.	2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
SrcRegion	string	No	IOPS yang disediakan.	1960
BackupId	string	No	Wilayah tempat instans sumber berada. Catatan Parameter ini wajib ketika tipe pemulihan cadangan adalah membangun ulang instans yang dihapus. Parameter ini wajib ketika tipe pemulihan cadangan adalah mengkloning dari cadangan geo-redundansi.	cn-beijing
RestoreType	string	No	ID cadangan kluster. Catatan Parameter ini wajib hanya ketika RestoreType diatur ke 2 atau 3.	cb-xxx
DestRegion	string	No	Tipe pemulihan cadangan. Nilai valid: 1: Memulihkan instans ke titik waktu tertentu yang ditentukan. 2: Memulihkan instans yang telah dirilis dari set cadangan tertentu. 3: Memulihkan instans dari set cadangan geo-redundansi tertentu.	1

Elemen respons

Element	Type	Description	Example
	object	Parameter tanggapan.
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	Description
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.	Parameter input tidak valid.
400	RestoreTypeNotSupported	The specified restoreType is not supported for the instance, check the input parameters 'RestoreType/BackupID/RestoreTime'.	Tipe instans pemulihan yang ditentukan tidak didukung. Periksa parameter input RestoreType, BackupID, dan RestoreTime.
500	VpcServiceError	Invoke vpc service error.	Terjadi error saat memanggil layanan VPC.
403	InvalidBackupLogStatus	Current backup log enable status does not support this operation.
403	ReduceDiskNotSupport	Reduce disk size is not supported in clone/restore.	Pengurangan ruang cloud disk tidak didukung untuk kloning atau pemulihan instans.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.