All Products
Search
Document Center

ApsaraDB for OceanBase (Deprecated):Ikhtisar API

Last Updated:Jul 02, 2026

Standar API dan SDK siap pakai dalam berbagai bahasa

Spesifikasi OpenAPI produk ini (OceanBasePro/2019-09-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

Daftar API

API

Judul

Deskripsi

BatchKillProcessList Menghentikan Sesi dalam Batch Menghentikan tugas sesi secara asinkron dalam batch. Anda harus memanggil operasi DescribeProcessStatsComposition untuk mengonfirmasi hasilnya.
BatchKillSessionList Tutup Daftar Sesi Secara Batch Menutup Sesi secara Batch antara layanan cloud OceanBase dan aplikasi bisnis. API ini dieksekusi secara asinkron. Anda perlu memanggil operasi DescribeSessionList untuk memverifikasi apakah Sesi berhasil ditutup.
CreateBackupSetDownloadLink Membuat Tautan Unduhan untuk Tugas Cadangan Membuat tautan unduhan untuk tugas cadangan OceanBase.
CreateDatabase Create Database Membuat database baru pada penyewa tertentu.
CreateInstance MessageBox チャンネル署名を生成します 人工知能クラウドコールサービス (AICCS) インスタンス ID とエージェントアカウント名に基づいて、メッセージチャネルアクセス署名を生成します。
CreateOasOutlineTask Memulai tugas pengikatan outline Memulai tugas pengikatan outline.
CreateSecurityIpGroup CreateSecurityIpGroup You can call this operation to create an IP address whitelist group.
CreateTag Membuat kelompok label Membuat kelompok label.
CreateTagValue Membuat Label Membuat label.
CreateTenant CreateTenant Membuat penyewa.
CreateTenantReadOnlyConnection Membuat Alamat Read-Only Membuat alamat read-only untuk penyewa tertentu.
CreateTenantSecurityIpGroup Membuat Informasi Daftar Putih Keamanan Penyewa Membuat informasi daftar putih keamanan penyewa.
CreateTenantUser Membuat Pengguna Penyewa Membuat akun database di bawah penyewa tertentu.
DeleteDatabases Hapus Database Menghapus satu atau beberapa database yang telah dibuat.
DeleteInstances Melepas Instans OceanBase Melepas instans OceanBase.
DeleteSecurityIpGroup Hapus Kelompok Daftar Putih Menghapus kelompok daftar putih alamat IP dari Kluster OceanBase.
DeleteTag Hapus Kelompok Tag Menghapus kelompok tag.
DeleteTagValue DeleteTag Menghapus tag.
DeleteTenantSecurityIpGroup Menghapus Informasi Kelompok Daftar Putih Penyewa Menghapus informasi kelompok daftar putih penyewa.
DeleteTenantUsers Hapus Pengguna Penyewa Menghapus satu atau beberapa akun database.
DeleteTenants Hapus Penyewa Menghapus satu atau beberapa penyewa dari Kluster OceanBase tertentu.
DescribeAvailableCpuResource Mengkueri Informasi Sumber Daya CPU yang Tersedia Mengkueri informasi sumber daya CPU yang diizinkan untuk pembuatan penyewa.
DescribeAvailableMemResource Mengkueri informasi sumber daya memori Mengkueri informasi sumber daya memori dari tenant OceanBase.
DescribeAvailableSpec Kueri Konfigurasi yang Tersedia untuk Perubahan Spesifikasi Kluster Mengkueri konfigurasi yang tersedia untuk perubahan spesifikasi Kluster OceanBase.
DescribeAvailableZone Kueri Konfigurasi Tersedia untuk Pembuatan Kluster Mengkueri konfigurasi yang tersedia di halaman pembelian untuk kluster OceanBase.
DescribeBackupEncryptedString Informasi Cadangan Terenkripsi Keseluruhan Mengambil informasi cadangan terenkripsi keseluruhan OceanBase.
DescribeBackupSetDownloadLink DescribeBackupSetDownloadLink You can call this operation to query the link for downloading a backup set of OceanBase Database.
DescribeCharset Mengambil Set Karakter Mengkueri informasi set karakter penyewa OceanBase.
DescribeDataBackupSet Kueri Informasi Set Cadangan Mengkueri informasi set cadangan kluster OceanBase.
DescribeDatabases Kueri Daftar Database Mengkueri daftar database pada penyewa.
DescribeInstance Kueri Informasi Kluster Mengkueri detail kluster OceanBase.
DescribeInstanceAvailableZones Kueri Informasi Zona Mengkueri informasi zona utama tempat kluster dapat dibuat.
DescribeInstanceCreatableZone Kueri Informasi Zona Mengkueri informasi zona dari zona utama tempat kluster dapat dibuat.
DescribeInstanceSSL Query cluster SSL Mengkueri detail SSL Kluster OceanBase.
DescribeInstanceSecurityConfigs Pemeriksaan Konfigurasi Keamanan Kluster Melakukan pemeriksaan konfigurasi keamanan pada kluster.
DescribeInstanceSummary Kueri Informasi Ikhtisar Instans Mengkueri informasi ikhtisar instans OceanBase.
DescribeInstanceTags Kueri Nilai Tag Kluster Mengkueri nilai tag kluster.
DescribeInstanceTenantModes Kueri Informasi Daftar Mode Penyewa Mengkueri daftar informasi mode penyewa.
DescribeInstanceTopology Kueri Informasi Topologi Kluster Mengkueri informasi topologi Kluster OceanBase tertentu.
DescribeInstances Kueri Daftar Kluster Mengkueri informasi daftar Kluster OceanBase.
DescribeMetricsData Mengkueri Data Metrik Pemantauan Mengkueri data metrik Pemantauan dimensi tunggal atau multi-dimensi untuk Kluster OceanBase.
DescribeMetricsDataV2 Mengkueri data metrik pemantauan Mengembalikan data pemantauan untuk pengguna.
DescribeNodeMetrics Mengkueri Informasi Data Deret Waktu Node Mengkueri informasi data deret waktu node OceanBase.
DescribeOasAnomalySQLList Kueri Daftar SQL Mencurigakan Mengkueri daftar pernyataan SQL yang diidentifikasi oleh sistem diagnosis berpotensi mengalami masalah performa.
DescribeOasSQLDetails Detail Kueri SQL Mengkueri informasi SQL detail, termasuk teks SQL dan nama tabel yang terlibat.
DescribeOasSQLHistoryList Kueri Riwayat Eksekusi SQL Mengkueri informasi riwayat eksekusi SQL.
DescribeOasSQLPlans Kueri Rencana Eksekusi SQL Mengkueri informasi rencana eksekusi SQL yang disimpan dalam sistem diagnostik berdasarkan ID SQL.
DescribeOasSlowSQLList DescribeOasSlowSQLList You can call this API to view a list of slow queries.
DescribeOasTopSQLList Kueri Daftar TopSQL Mengkueri daftar data performa eksekusi SQL yang dikumpulkan oleh sistem diagnostik.
DescribeOutlineBinding Mengkueri Informasi Binding Outline Mengkueri informasi binding Outline atau informasi pembatasan kecepatan untuk pernyataan SQL dalam database berdasarkan SQLID-nya.
DescribeParameters Kueri Daftar Informasi Parameter Mengkueri daftar informasi parameter.
DescribeParametersHistory Lihat Riwayat Modifikasi Parameter Melihat riwayat modifikasi parameter kluster atau penyewa.
DescribeProcessStatsComposition Kueri Informasi Sesi Mengkueri informasi sesi.
DescribeProxyService DescribeProxyService You can call this operation to query proxy service information of OceanBase Database.
DescribeRecommendIndex Mengkueri informasi rekomendasi indeks SQL Mengkueri informasi rekomendasi indeks dari mesin diagnostik untuk pernyataan SQL berdasarkan ID SQL.
DescribeRestorableTenants Kueri Tenant yang Dapat Dipulihkan Kueri tenant OceanBase yang dapat dipulihkan.
DescribeSQLSamples Mengkueri Data Pengambilan Sampel Detail Eksekusi SQL Lambat Mengkueri data pengambilan sampel detail eksekusi SQL lambat.
DescribeSQLTuningAdvices Kueri Saran Optimasi SQL Mengkueri saran optimasi SQL, yang mencakup dua jenis: saran pembuatan indeks dan saran pengikatan rencana eksekusi.
DescribeSampleSqlRawTexts Mengkueri Teks Asli Pernyataan SQL yang Disampel Mengkueri teks asli pernyataan SQL yang disampel.
DescribeSecurityIpGroups Kueri Kelompok Daftar Putih IP Mengkueri daftar kelompok daftar putih IP.
DescribeSessionList Daftar Sesi Kueri Menampilkan informasi Sesi antara OceanBase Cloud dan layanan Anda.
DescribeSqlAuditStat Mengumpulkan Statistik Eksekusi SQL Mengumpulkan statistik eksekusi SQL berdasarkan IP klien, nama pengguna, dan ID SQL.
DescribeStandbyCreateMode Mengambil mode pembuatan kluster standby Mengambil mode pembuatan kluster standby untuk OceanBase.
DescribeTagValues Kueri Label Mengkueri label.
DescribeTenant Mengkueri Informasi Penyewa Tertentu di Kluster Tertentu Menampilkan informasi penyewa tertentu di kluster tertentu.
DescribeTenantAddressProxyInfo Mengkueri Informasi Layanan Proxy Alamat Penyewa Mengambil informasi layanan proxy untuk alamat penyewa.
DescribeTenantEncryption Kueri Informasi Enkripsi Penyewa Mengkueri informasi enkripsi penyewa.
DescribeTenantMetrics Kueri informasi data deret waktu penyewa Mengkueri informasi data deret waktu penyewa OceanBase tertentu.
DescribeTenantReadableScn Mengkueri SCN Maksimum yang Dapat Dibaca Penyewa Mengkueri SCN (System Change Number) maksimum yang dapat dibaca penyewa.
DescribeTenantSecurityConfigs DescribeTenantSecurityConfigs You can call this operation to query security check items of an OceanBase Database tenant.
DescribeTenantSecurityIpGroups Melihat Daftar Kelompok Daftar Putih Penyewa Melihat daftar kelompok daftar putih penyewa.
DescribeTenantTags Mengkueri Nilai Tag Penyewa Mengkueri nilai tag penyewa.
DescribeTenantUserRoles Mengambil Konfigurasi Izin Pengguna Reguler Mengambil konfigurasi izin pengguna reguler.
DescribeTenantUsers Kueri Daftar Akun Penyewa Mengkueri daftar akun akses database di bawah penyewa.
DescribeTenantZonesRead Mengkueri Informasi Zona Ketersediaan Read-Only Penyewa Mengkueri informasi zona ketersediaan read-only penyewa.
DescribeTenants Kueri Informasi Daftar Penyewa pada Kluster Mengkueri informasi daftar penyewa pada Kluster OceanBase tertentu.
DescribeTimeZones Daftar Zona Pengatur Waktu Mengkueri informasi zona pengatur waktu penyewa OceanBase.
DescribeZones Mengkueri informasi zona yang tersedia Mengkueri informasi tentang zona yang tersedia tempat kluster dapat dibuat di region Alibaba Cloud.
KillProcessList Menutup Sesi Tertentu Menutup sesi tertentu.
ModifyDatabaseDescription Ubah Deskripsi Database Mengubah deskripsi database.
ModifyDatabaseUserRoles Mengubah Peran Pengguna Database Mengubah izin akun database.
ModifyInstanceName Ubah Nama Kluster Mengubah nama kluster OceanBase.
ModifyInstanceNodeNum Mengubah jumlah node klaster Mengubah jumlah node cluster.
ModifyInstanceSSL Modify SSL Configuration Mengubah konfigurasi SSL instans.
ModifyInstanceSpec Mengubah Spesifikasi dan Kapasitas Penyimpanan Kluster Mengubah spesifikasi dan kapasitas penyimpanan kluster.
ModifyInstanceTags Mengubah Nilai Label Kluster Mengubah nilai Label Kluster.
ModifyInstanceTemporaryCapacity Mengubah Kapasitas Sementara Kluster Mengubah kapasitas sementara Kluster OceanBase.
ModifyParameters Ubah Parameter Mengubah parameter kluster atau penyewa.
ModifySecurityIps Ubah Daftar IP Mengubah daftar IP dalam grup keamanan.
ModifyTagName Ubah Nama Kelompok Tag Mengubah nama kelompok tag.
ModifyTagValueName Ubah Nama Label Mengubah nama label.
ModifyTenantEncryption Mengaktifkan TDE untuk Penyewa Mengaktifkan Enkripsi Data Transparan (TDE) untuk penyewa.
ModifyTenantPrimaryZone Mengalihkan Zona Utama Penyewa Mengalihkan zona utama penyewa.
ModifyTenantResource Mengubah resource penyewa Mengubah spesifikasi penyewa di Kluster OceanBase tertentu.
ModifyTenantSecurityIpGroup Mengubah Informasi Kelompok Daftar Putih Penyewa Mengubah informasi kelompok daftar putih penyewa.
ModifyTenantTags Ubah Nilai Label Penyewa Mengubah nilai label penyewa.
ModifyTenantUserDescription Mengubah Deskripsi Akun Penyewa Mengubah deskripsi akun database tertentu pada penyewa.
ModifyTenantUserPassword Mengubah Kata Sandi Pengguna Penyewa Mengubah kata sandi logon akun database tertentu di bawah penyewa.
ModifyTenantUserRoles Mengubah Peran Pengguna Penyewa Mengubah informasi izin database yang dapat diakses oleh akun tertentu di bawah penyewa.
ModifyTenantUserStatus Mengunci atau Membuka Kunci Akun Database Tertentu Mengunci atau membuka kunci akun database tertentu.
RemoveStandbyInstance Melepaskan Instans Sekunder Melepaskan instans sekunder dari instans utama.
SwitchoverInstance Mengalihkan Instans Utama dan Sekunder Mengalihkan instans utama dan sekunder OceanBase.