Standar API dan SDK siap pakai dalam berbagai bahasa
Spesifikasi OpenAPI produk ini (Dds/2015-12-01) mematuhi standar RPC. Alibaba Cloud menyediakan SDK siap pakai untuk berbagai bahasa pemrograman populer guna mengabstraksi kompleksitas tingkat rendah seperti request signing. Hal ini memungkinkan developer untuk memanggil API menggunakan sintaks khusus tanpa perlu menangani detail HTTP secara langsung.
Signature kustom
Jika SDK tidak mendukung kebutuhan spesifik Anda, seperti signature kustom, Anda harus menandatangani request secara manual menggunakan signature mechanism. Perhatikan bahwa proses penandatanganan manual memerlukan upaya yang signifikan (estimasi 5 hari kerja). Untuk mendapatkan dukungan, bergabunglah dengan grup DingTalk kami (ID: 147535001692).
Sebelum Anda mulai
Akun Alibaba Cloud memiliki hak administratif penuh. Jika pasangan AccessKey dikompromikan, semua resource terkait dapat terekspos terhadap akses tidak sah, sehingga menimbulkan risiko keamanan yang signifikan. Buat Resource Access Management (RAM) user dengan akses khusus API dan gunakan kebijakan RAM untuk menerapkan principle of least privilege (PoLP). Gunakan akun Alibaba Cloud hanya jika benar-benar diperlukan.
Untuk memanggil API secara aman, konfigurasikan hal berikut:
Akun RAM user
Pasangan AccessKey untuk akun tersebut
Membuat atau mengkloning instans
|
API |
Judul |
Deskripsi |
| CreateDBInstance | CreateDBInstance | Membuat atau mengkloning instans replica set Database Apsara for MongoDB. |
| CreateShardingDBInstance | CreateShardingDBInstance | Membuat atau mengkloning instans kluster sharded MongoDB. |
Mengubah konfigurasi instans
|
API |
Judul |
Deskripsi |
| CreateNode | Menambahkan node ke instans kluster sharded | Menambahkan node shard atau node Mongos (Proxy Layanan) ke instans kluster sharded Database Apsara for MongoDB. |
| CreateNodeBatch | CreateNodeBatch | Menambahkan node Mongos (Proxy Layanan) atau shard secara batch untuk instans kluster sharded. |
| DeleteNode | Hapus node dari instans kluster sharded | Menghapus node shard atau Mongos (Proxy Layanan) dari instans kluster sharded Database Apsara for MongoDB. |
| ModifyDBInstanceSpec | ModifyDBInstanceSpec | Mengubah tipe instans atau ruang penyimpanan untuk instans mandiri, replica set, atau arsitektur tanpa server Database Apsara for MongoDB. Instans arsitektur tanpa server eksklusif untuk situs Alibaba Cloud China. |
| ModifyNodeSpec | ModifyNodeSpec | Mengubah tipe instans dan ruang penyimpanan node dalam instans cluster sharded MongoDB. |
| ModifyNodeSpecBatch | ModifyNodeSpecBatch | Mengubah konfigurasi satu atau beberapa node Mongos atau shard dalam instans kluster sharded Database Apsara for MongoDB. |
| ModifyDBInstanceDiskType | ModifyDBInstanceDiskType | Mengubah tipe disk instans Database Apsara for MongoDB. |
Manajemen instans
|
API |
Judul |
Deskripsi |
| DeleteDBInstance | Hapus instans | Melepaskan instans MongoDB pay-as-you-go. |
| ModifyDBInstanceMaintainTime | Mengubah jendela pemeliharaan | Mengubah jendela pemeliharaan instans Database Apsara untuk MongoDB. |
| ModifyDBInstanceDescription | Mengubah nama instans Database Apsara untuk MongoDB | Mengubah nama instans Database Apsara untuk MongoDB. |
| ModifyDBInstanceNetExpireTime | ModifyDBInstanceNetExpireTime | Memperpanjang periode retensi titik akhir jaringan klasik instans Database Apsara for MongoDB. |
| UpgradeDBInstanceEngineVersion | UpgradeDBInstanceEngineVersion | Meningkatkan versi database instans ApsaraDB for MongoDB. |
| UpgradeDBInstanceKernelVersion | UpgradeDBInstanceKernelVersion | Mengupgrade versi minor dari instans ApsaraDB for MongoDB. |
| SwitchDBInstanceHA | Mengalihkan node primer dan sekunder | Mengalihkan node primer dan sekunder untuk instans Database Apsara untuk MongoDB. |
| RestartDBInstance | RestartDBInstance | Memulai ulang instance ApsaraDB for MongoDB. |
| DestroyInstance | DestroyInstance | Menghancurkan instans Database Apsara untuk MongoDB. |
| RestartNode | RestartNode | Memulai ulang satu node dari instans MongoDB. |
Manajemen perpanjangan
|
API |
Judul |
Deskripsi |
| ModifyInstanceAutoRenewalAttribute | Mengonfigurasi perpanjangan otomatis untuk sebuah instans | Mengaktifkan atau menonaktifkan perpanjangan otomatis untuk instans Database Apsara for MongoDB. |
| TransformInstanceChargeType | TransformInstanceChargeType | Mengubah metode penagihan instans dari pay-as-you-go menjadi langganan, atau dari langganan menjadi pay-as-you-go. |
| DescribePrice | DescribePrice | Mengkueri harga. |
| DescribeRenewalPrice | Kueri harga perpanjangan instans | Mengkueri harga untuk memperpanjang instans ApsaraDB for MongoDB tertentu selama satu bulan. |
| TransformToPrePaid | TransformToPrePaid | Mengubah metode penagihan instans Database Apsara for MongoDB dari pay-as-you-go menjadi langganan. |
| RenewDBInstance | RenewDBInstance | Melakukan perpanjangan secara manual Instansi langganan Database Apsara for MongoDB. |
Mengkueri instans
|
API |
Judul |
Deskripsi |
| DescribeDBInstanceSpecInfo | DescribeDBInstanceSpecInfo | Mendapatkan detail tipe instans. |
| DescribeReplicaSetRole | Describe replica set role | Mengambil informasi peran dan detail koneksi untuk instans MongoDB. |
| DescribeKernelReleaseNotes | DescribeKernelReleaseNotes | Menanyakan catatan rilis versi minor instans ApsaraDB for MongoDB. |
| DescribeAvailableEngineVersion | DescribeAvailableEngineVersion | Menanyakan versi engine yang dapat digunakan untuk meningkatkan instance ApsaraDB for MongoDB. |
| DescribeDBInstances | DescribeDBInstances | Mengkueri daftar instans MongoDB. |
| DescribeDBInstanceSwitchLog | DescribeDBInstanceSwitchLog | Mengkueri log peralihan primer/sekunder dari instans ApsaraDB for MongoDB. |
| DescribeDBInstanceAttribute | DescribeDBInstanceAttribute | Mengkueri informasi tentang instance ApsaraDB for MongoDB. |
| DescribeRoleZoneInfo | Mengkueri peran dan zona node | Mengkueri peran dan zona setiap node dalam instans Database Apsara for MongoDB. |
| DescribeInstanceAutoRenewalAttribute | DescribeInstanceAutoRenewalAttribute | Mengkueri status pembaruan otomatis instans MongoDB. |
| DescribeActiveOperationTaskCount | DescribeActiveOperationTaskCount | Mengkueri jumlah tugas operasi dan pemeliharaan pada instans ApsaraDB for MongoDB. |
| DescribeActiveOperationTasks | DescribeActiveOperationTasks | Mengkueri detail tugas O&M untuk instans MongoDB. |
| DescribeActiveOperationTaskType | DescribeActiveOperationTaskType | Mengkueri tipe tugas operasi dan pemeliharaan (O&M) serta jumlah tugas dari setiap tipe untuk instans Database Apsara for MongoDB. |
| DescribeDBInstancesOverview | DescribeDBInstancesOverview | Mengkueri Tampilan satu atau beberapa instans Database Apsara untuk MongoDB. |
| DescribeHistoryTasks | DescribeHistoryTasks | Memuat daftar tugas di pusat tugas. |
| DescribeHistoryTasksStat | Kueri ringkasan tugas pusat tugas | Mengueri ringkasan tugas di pusat tugas. |
| ModifyTaskInfo | Mengubah informasi tugas | Mengubah informasi tugas di pusat tugas untuk instans Database Apsara for MongoDB. |
| ModifyActiveOperationTasks | Mengubah pengatur waktu alih bencana tugas pemeliharaan aktif | Mengubah pengatur waktu alih bencana Tugas pemeliharaan terjadwal untuk Instans Database Apsara for MongoDB. |
Manajemen resource
|
API |
Judul |
Deskripsi |
| DescribeAvailableResource | Mengkueri sumber daya yang tersedia | Mengkueri sumber daya yang tersedia di zona tertentu. |
| EvaluateResource | Mengevaluasi ketersediaan resource | Mengevaluasi ketersediaan Sumber daya sebelum Anda membeli instans baru atau mengubah konfigurasi instans yang sudah ada. |
| DescribeAvailabilityZones | Mengkueri zona yang didukung | Mengkueri daftar zona yang didukung oleh instans Database Apsara untuk MongoDB. |
| ModifyResourceGroup | ModifyResourceGroup | Memindahkan instans Database Apsara for MongoDB ke kelompok sumber daya tertentu. |
Manajemen wilayah
|
API |
Judul |
Deskripsi |
| DescribeRegions | DescribeRegions | Mengkueri semua wilayah dan zona yang didukung untuk instans Database Apsara for MongoDB. |
| MigrateToOtherZone | MigrateToOtherZone | Memigrasikan instans ApsaraDB for MongoDB ke zona lain. |
| MigrateAvailableZone | MigrateAvailableZone | Memigrasikan instans Database Apsara for MongoDB ke zona tertentu. |
Manajemen koneksi
|
API |
Judul |
Deskripsi |
| ModifyInstanceVpcAuthMode | ModifyInstanceVpcAuthMode | Menonaktifkan akses tanpa kata sandi melalui Virtual Private Cloud (VPC) untuk instans Database Apsara for MongoDB. |
| ModifyDBInstanceNetworkType | Mengubah Jenis Jaringan Instans | Mengubah jenis jaringan instans MongoDB. |
| ModifyDBInstanceConnectionString | ModifyDBInstanceConnectionString | Mengubah alamat koneksi dan port instans MongoDB. |
| DescribeShardingNetworkAddress | DescribeShardingNetworkAddress | Mengambil informasi koneksi untuk instans kluster sharded MongoDB. |
| AllocatePublicNetworkAddress | AllocatePublicNetworkAddress | Mengalokasikan endpoint publik ke sebuah instans. |
| ReleasePublicNetworkAddress | Merilis titik akhir publik | Merilis titik akhir publik instans Database Apsara untuk MongoDB. |
| AllocateNodePrivateNetworkAddress | AllocateNodePrivateNetworkAddress | Mengajukan permohonan titik akhir internal untuk node shard atau Configserver dalam instans kluster sharded Database Apsara for MongoDB. |
| ReleaseNodePrivateNetworkAddress | ReleaseNodePrivateNetworkAddress | Melepaskan titik akhir internal shard atau node Configserver untuk instans sharded cluster. |
Manajemen tag
|
API |
Judul |
Deskripsi |
| ListTagResources | ListTagResources | Mengkueri hubungan antara instans Database Apsara untuk MongoDB dan tag. |
| DescribeTags | DescribeTags | Mengkueri semua tag di Wilayah tertentu. |
| TagResources | Mengikat tag ke instans | Mengikat tag ke instans Database Apsara for MongoDB. |
| UntagResources | UntagResources | Menghapus tag jika tag tidak ditambahkan ke instans lain. |
Manajemen akun
|
API |
Judul |
Deskripsi |
| CreateAccount | CreateAccount | Membuat akun yang diberikan izin hanya-baca untuk node shard dalam instans kluster sharded Database Apsara for MongoDB yang menggunakan cloud disk. |
| ResetAccountPassword | ResetAccountPassword | Mengatur ulang kata sandi akun root di instans Database Apsara for MongoDB. |
| ModifyAccountDescription | ModifyAccountDescription | Mengubah deskripsi akun root di instans Database Apsara for MongoDB. |
| DescribeAccounts | DescribeAccounts | Mengkueri akun database instans ApsaraDB for MongoDB. |
Daftar putih dan grup keamanan
|
API |
Judul |
Deskripsi |
| ModifySecurityIps | ModifySecurityIps | Mengubah daftar putih alamat IP dari instance ApsaraDB for MongoDB. |
| ModifySecurityGroupConfiguration | ModifySecurityGroupConfiguration | Mengubah grup keamanan ECS yang terikat ke instans Database Apsara for MongoDB. |
| DescribeSecurityIps | DescribeSecurityIps | Mengambil daftar putih IP dari sebuah instans ApsaraDB for MongoDB. |
| DescribeSecurityGroupConfiguration | DescribeSecurityGroupConfiguration | Mengkueri grup keamanan Elastic Compute Service (ECS) yang terkait dengan instans Database Apsara untuk MongoDB. |
| ModifyGlobalSecurityIPGroup | ModifyGlobalSecurityIPGroup | Mengubah template daftar putih IP global yang terkait dengan instance ApsaraDB for MongoDB. |
| DescribeGlobalSecurityIPGroup | DescribeGlobalSecurityIPGroup | Menanyakan template whitelist IP global dari instance ApsaraDB for MongoDB. |
| ModifyGlobalSecurityIPGroupName | ModifyGlobalSecurityIPGroupName | Mengubah nama templat daftar putih IP global yang terkait dengan instans Database Apsara untuk MongoDB. |
| DescribeGlobalSecurityIPGroupRelation | DescribeGlobalSecurityIPGroupRelation | Mengkueri pemetaan antara instans dan templat daftar putih alamat IP global. |
| CreateGlobalSecurityIPGroup | Membuat templat daftar putih IP global | Membuat templat daftar putih IP global. |
| ModifyGlobalSecurityIPGroupRelation | ModifyGlobalSecurityIPGroupRelation | Mengubah pemetaan antara templat daftar putih global dan instans Database ApsaraDB for MongoDB. |
| DeleteGlobalSecurityIPGroup | DeleteGlobalSecurityIPGroup | Menghapus templat daftar putih alamat IP global. |
Kunci
|
API |
Judul |
Deskripsi |
| ModifyDBInstanceTDE | ModifyDBInstanceTDE | Mengubah status Transparent Data Encryption (TDE) instans MongoDB. |
| CheckCloudResourceAuthorized | CheckCloudResourceAuthorized | Memeriksa apakah kunci Key Management Service (KMS) diotorisasi untuk instans ApsaraDB for MongoDB. |
| DescribeUserEncryptionKeyList | DescribeUserEncryptionKeyList | Mengkueri kunci kustom untuk sebuah instans. |
| DescribeDBInstanceEncryptionKey | DescribeDBInstanceEncryptionKey | Mengkueri kunci enkripsi instans MongoDB. |
| DescribeDBInstanceTDEInfo | Mengkueri Apakah TDE Diaktifkan untuk Instans MongoDB | Mengkueri apakah Enkripsi Data Transparan (TDE) diaktifkan untuk instans Database Apsara for MongoDB. |
| DescribeKmsKeys | DescribeKmsKeys | Mengkueri kunci Key Management Service (KMS) yang tersedia untuk enkripsi disk. |
Enkripsi SSL
|
API |
Judul |
Deskripsi |
| ModifyDBInstanceSSL | ModifyDBInstanceSSL | Mengubah konfigurasi SSL instans MongoDB. |
| DescribeDBInstanceSSL | Kueri konfigurasi SSL instans mongoDB | Mengkueri detail konfigurasi SSL instans Database Apsara for MongoDB. |
Log audit
|
API |
Judul |
Deskripsi |
| ModifyAuditLogFilter | ModifyAuditLogFilter | Mengubah tipe log audit yang dikumpulkan untuk instans MongoDB. |
| ModifyAuditPolicy | ModifyAuditPolicy | Mengaktifkan atau menonaktifkan log audit untuk instans MongoDB, atau mengubah periode retensi log. |
| DescribeAuditRecords | DescribeAuditRecords | Mengkueri entri log audit untuk instans MongoDB. |
| DescribeAuditPolicy | DescribeAuditPolicy | Memeriksa apakah pencatatan log audit diaktifkan untuk instans MongoDB. |
| DescribeAuditLogFilter | DescribeAuditLogFilter | Mengkueri tipe Log audit yang dikumpulkan untuk Instans MongoDB. |
| DescribeMongoDBLogConfig | Menampilkan konfigurasi layanan log MongoDB | Menampilkan konfigurasi MongoDB Log Service. |
Manajemen log
|
API |
Judul |
Deskripsi |
| DescribeSlowLogRecords | Mengkueri entri log kueri lambat | Mengkueri entri log kueri lambat untuk instans MongoDB. |
| DescribeErrorLogRecords | Mengkueri entri log error | Mengkueri entri log error untuk instans MongoDB. |
| DescribeRunningLogRecords | Kueri log yang sedang berjalan dari instans MongoDB | Mengkueri log yang sedang berjalan dari instans MongoDB. |
Pemantauan kinerja
|
API |
Judul |
Deskripsi |
| ModifyDBInstanceMonitor | ModifyDBInstanceMonitor | Mengatur granularitas pengumpulan Pemantauan untuk instans MongoDB. |
| DescribeDBInstancePerformance | DescribeDBInstancePerformance | Membuat kueri data performa instans MongoDB. |
| DescribeDBInstanceMonitor | Mengkueri frekuensi pengumpulan data pemantauan | Mengkueri frekuensi pengumpulan data pemantauan untuk instans Database Apsara for MongoDB. |
Manajemen parameter
|
API |
Judul |
Deskripsi |
| ModifyParameters | ModifyParameters | Mengubah parameter instans Database Apsara for MongoDB. |
| DescribeParameterModificationHistory | Mengkueri riwayat modifikasi parameter | Mengkueri catatan modifikasi parameter instans Database Apsara untuk MongoDB. |
| DescribeParameterTemplates | DescribeParameterTemplates | Mengkueri template parameter default untuk instans MongoDB. |
| DescribeParameters | Mengkueri pengaturan parameter instans | Mengkueri pengaturan parameter instans Database Apsara untuk MongoDB. |
Pencadangan dan pemulihan
|
API |
Judul |
Deskripsi |
| CreateBackup | CreateBackup | Membuat cadangan untuk instance MongoDB. |
| ModifyBackupPolicy | ModifyBackupPolicy | Mengubah kebijakan cadangan instans MongoDB. |
| DescribeBackupPolicy | DescribeBackupPolicy | Mengkueri kebijakan cadangan instans MongoDB. |
| DescribeBackups | DescribeBackups | Mengkueri cadangan instans MongoDB. |
| DescribeBackupDBs | DescribeBackupDBs | Mengkueri basis data pada waktu tertentu atau basis data dalam set cadangan tertentu sebelum Anda memulihkan basis data untuk instance ApsaraDB for MongoDB. |
| DescribeRestoreDBInstanceList | DescribeRestoreDBInstanceList | Mengkueri Instans Database Apsara untuk MongoDB yang cadangannya dipulihkan dalam tujuh hari. |
| CheckRecoveryCondition | Check recovery condition | Memeriksa apakah data instans Database Apsara for MongoDB dapat dipulihkan. |
| TransferClusterBackup | TransferClusterBackup | Mengalihkan mode pencadangan instans kluster sharded Database Apsara for MongoDB ke mode pencadangan kluster. Setelah instans dialihkan ke mode pencadangan kluster, instans mendukung pencadangan Frekuensi tinggi. |
| DescribeClusterBackups | DescribeClusterBackups | Mengkueri set cadangan kluster untuk instans kluster sharded Database Apsara for MongoDB yang menggunakan cloud disk. |
| DescribeClusterRecoverTime | Kueri Rentang Pengatur Waktu Pemulihan Kluster Sharded | Mengkueri rentang pengatur waktu yang dapat dipulihkan dari instans kluster sharded yang menggunakan cloud disk di Database Apsara for MongoDB. |
| DescribeBackupStorage | DescribeBackupStorage | Mengkueri penggunaan cadangan untuk instans replica set MongoDB atau kluster sharded yang menggunakan cloud disk. |
| DescribeBackupTasks | DescribeBackupTasks | Mengkueri pekerjaan cadangan yang sedang berlangsung untuk instans Set Replika atau kluster sharded MongoDB yang menggunakan cloud disk. |
| DescribeInstanceRecoverTime | Kueri Rentang Waktu yang Dapat Dipulihkan dari Instans Replika Set | Mengkueri rentang pengatur waktu yang dapat dipulihkan dari instans replika set Database Apsara for MongoDB dengan cloud disk. |
Lainnya
|
API |
Judul |
Deskripsi |
| DescribeActiveOperationTask | DescribeActiveOperationTask | Mengkueri informasi detail tentang tugas instans Database Apsara for MongoDB. |
| AllocateDBInstanceSrvNetworkAddress | AllocateDBInstanceSrvNetworkAddress | Mengajukan string koneksi SRV untuk instans Database Apsara for MongoDB. |
| DescribeActiveOperationTaskRegion | Mengkueri tipe tugas pemeliharaan dan jumlah tugas. | Mengkueri tipe dan jumlah tugas O&M untuk instans MongoDB. |
| DescribeActiveOperationMaintenanceConfig | DescribeActiveOperationMaintenanceConfig | Menanyakan konfigurasi tugas Operasi dan Pemeliharaan (O&M) untuk instans MongoDB. |
| CheckServiceLinkedRole | Memeriksa peran tertaut layanan | Memeriksa apakah peran tertaut layanan (SLR) telah dibuat untuk suatu Instans. |
| ModifyDBInstanceConfig | ModifyDBInstanceConfig | Mengubah konfigurasi instans. |
| ModifyDBInstanceAttribute | ModifyDBInstanceAttribute | Mengubah konfigurasi perlindungan rilis instans. |
| ModifySrvNetworkAddress | ModifySrvNetworkAddress | Mengubah alamat koneksi SRV dari instance MongoDB. |
| CancelActiveOperationTasks | CancelActiveOperationTasks | Membatalkan event Operations and Maintenance (O&M) secara batch. |
| CreateNodeRoleTag | CreateNodeRoleTag | Membuat tag peran untuk node instans. |
| DescribeRdsVSwitchs | Mengambil daftar vSwitch | Mengambil daftar vSwitch. |
| DescribeRdsVpcs | DescribeRdsVpcs | Mengambil daftar VPC. |
| DescribeRoleTagStatus | Mendeskripsikan status tag peran | Mendeskripsikan status tag untuk sebuah node. |
| DescribeVpcsForMongoDB | DescribeVpcsForMongoDB | Membuat kueri daftar VPC dengan paginasi. |
| ModifyActiveOperationMaintenanceConfig | ModifyActiveOperationMaintenanceConfig | Mengubah konfigurasi tugas Operasi dan Pemeliharaan (O&M) untuk instans MongoDB. |
| DescribeBinlogFiles | Kueri file backup log | Mengkueri file backup log untuk instans ApsaraDB for MongoDB. |
| ModifyBackupExpireTime | ModifyBackupExpireTime | Mengubah pengatur waktu time-to-live (TTL) set cadangan MongoDB. |
| DeleteBackup | DeleteBackup | Menghapus set cadangan MongoDB. |