Standar API dan SDK siap pakai dalam berbagai bahasa
Spesifikasi OpenAPI produk ini (dataworks-public/2020-05-18) 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
Penyewa
|
API |
Judul |
Deskripsi |
| AddProjectMemberToRole | AddProjectMemberToRole | Menetapkan peran ke anggota workspace DataWorks. Sebelum Anda memanggil operasi ini, Anda harus menambahkan akun Anda ke workspace DataWorks sebagai anggota. |
| RemoveProjectMemberFromRole | RemoveProjectMemberFromRole | Menghapus peran dari pengguna di ruang kerja DataWorks. |
| ListProjectIds | ListProjectIds | Melakukan kueri ID ruang kerja yang menjadi tempat akun Alibaba Cloud atau pengguna RAM tertentu memiliki izin di wilayah tertentu. |
| ChangeResourceManagerResourceGroup | ChangeResourceManagerResourceGroup | Mengubah grup sumber daya dari sebuah sumber daya. |
| ListMeasureData | ListMeasureData | Mengkueri statistik jumlah alert berbasis panggilan telepon atau alert berbasis pesan teks yang dilaporkan dalam penyewa tempat akun Anda berada selama 30 hari terakhir. |
Metadata
|
API |
Judul |
Deskripsi |
| GetMetaDBInfo | GetMetaDBInfo | Mengkueri informasi metadata dasar tentang instans mesin komputasi. |
| GetMetaDBTableList | GetMetaDBTableList | Mengambil semua tabel di instans engine yang ditentukan. |
| CheckMetaTable | CheckMetaTable | Memeriksa apakah metatable ada. |
| CheckMetaPartition | CheckMetaPartition | Memeriksa apakah partisi di metatable MaxCompute ada. |
| SearchMetaTables | SearchMetaTables | Mengueri metatable berdasarkan kondisi tertentu. |
| GetMetaTableBasicInfo | GetMetaTableBasicInfo | Meng-query informasi dasar tentang metatable. |
| GetMetaTableColumn | GetMetaTableColumn | Mengkueri informasi field dari sebuah metatable. |
| GetMetaTablePartition | Mendapatkan Partisi Tabel | Mengambil daftar partisi untuk tabel. |
| GetMetaTableOutput | GetMetaTableOutput | Menanyakan informasi output dari metatable. |
| GetMetaTableChangeLog | GetMetaTableChangeLog | Mengkueri log perubahan metatable. |
| GetMetaTableIntroWiki | GetMetaTableIntroWiki | Menanyakan instruksi tentang cara menggunakan tabel. |
| CreateMetaCategory | CreateMetaCategory | Membuat kategori. |
| DeleteMetaCategory | DeleteMetaCategory | Menghapus kategori. |
| UpdateMetaCategory | UpdateMetaCategory | Memperbarui kategori. |
| GetMetaCategory | GetMetaCategory | Mengkueri informasi tentang pohon kategori. |
| GetMetaTableListByCategory | GetMetaTableListByCategory | Mengkueri metatabel dalam kategori yang ditentukan. |
| AddToMetaCategory | AddToMetaCategory | Menambahkan metatable ke kategori tertentu. |
| DeleteFromMetaCategory | DeleteFromMetaCategory | Menghapus tabel dari kategori yang ditentukan. |
| UpdateMetaTable | UpdateMetaTable | Memperbarui metadata tabel. |
| UpdateMetaTableIntroWiki | UpdateMetaTableIntroWiki | Memperbarui petunjuk penggunaan tabel. Jika belum ada petunjuk penggunaan tabel, petunjuk yang dikonfigurasi melalui operasi ini akan ditambahkan. |
| ListMetaDB | ListMetaDB | Mengkueri daftar metadatabase. |
| UpdateTableModelInfo | UpdateTableModelInfo | Mengubah informasi tentang tabel, seperti folder tabel, level, dan kategori. |
| CreateTableTheme | CreateTableTheme | Membuat tema tabel. Operasi ini akan segera digantikan. Jangan panggil operasi ini. |
| DeleteTableTheme | DeleteTableTheme | Menghapus tema tabel. Operasi ini akan segera digantikan. Kami menyarankan Anda untuk tidak memanggil operasi ini. |
| UpdateTableTheme | UpdateTableTheme | Memperbarui tema tabel. Operasi ini akan segera digantikan. Kami menyarankan agar Anda tidak memanggil operasi ini. |
| ListTableTheme | Daftar Tema Tabel | Mendaftar tema tabel. Operasi ini akan segera digantikan. Jangan panggil operasi ini. |
| GetMetaTableThemeLevel | Metadata Topik Tingkat Tabel | Mengambil metadata topik dan hierarki untuk tabel. |
| CreateTableLevel | CreateTableLevel | Membuat level hierarki. Operasi ini akan segera digantikan. Kami menyarankan Anda untuk tidak memanggil operasi ini. |
| UpdateTableLevel | UpdateTableLevel | Memperbarui tingkat hierarki. Operasi ini akan segera digantikan. Kami menyarankan Anda untuk tidak memanggil operasi ini. |
| DeleteTableLevel | DeleteTableLevel | Menghapus level hierarki. Operasi ini akan segera digantikan. Kami menyarankan agar Anda tidak memanggil operasi ini. |
| ListTableLevel | ListTableLevel | Menampilkan daftar level hierarki. Operasi ini akan segera diganti. Kami menyarankan agar Anda tidak memanggil operasi ini. |
| ListMetaCollectionEntities | ListMetaCollectionEntities | Mengkueri entitas dalam koleksi. |
| GetMetaCollectionDetail | GetMetaCollectionDetail | Mengkueri informasi tentang koleksi. |
| DeleteMetaCollectionEntity | DeleteMetaCollectionEntity | Menghapus entitas dari koleksi. |
| AddMetaCollectionEntity | AddMetaCollectionEntity | Menambahkan entitas ke koleksi. |
| ListLineage | ListLineage | Mengkueri lineage leluhur atau keturunan dari sebuah entitas. |
| DeleteLineageRelation | DeleteLineageRelation | Hapus silsilah, mendukung penghapusan hubungan silsilah yang ditentukan pengguna |
| RegisterLineageRelation | RegisterLineageRelation | Mendaftarkan silsilah (lineage) antara entitas yang dikelola sendiri ke DataWorks. |
| GetMetaTableLineage | GetMetaTableLineage | Mengkueri lineage metatable. |
| GetMetaColumnLineage | GetMetaColumnLineage | Mengkueri lineage bidang dalam metatable. |
Integrasi data
|
API |
Judul |
Deskripsi |
| CreateDISyncTask | CreateDISyncTask | Membuat tugas sinkronisasi data. |
| DeleteDISyncTask | DeleteDISyncTask | Menghapus tugas sinkronisasi real-time. |
| UpdateDISyncTask | UpdateDISyncTask | Memperbarui tugas sinkronisasi data. |
| TestNetworkConnection | TestNetworkConnection | Menguji konektivitas jaringan antara sumber data dan grup sumber daya. |
| GetDataSourceMeta | GetDataSourceMeta | Menanyakan metadata dari sumber data yang ditentukan. |
| ListDIProjectConfig | ListDIProjectConfig | Mengkueri konfigurasi global default solusi sinkronisasi di ruang kerja DataWorks tertentu. |
| UpdateDIProjectConfig | UpdateDIProjectConfig | Mengubah konfigurasi global default solusi sinkronisasi di ruang kerja DataWorks. |
| GetDISyncTask | GetDISyncTask | Mengambil detail tugas sinkronisasi atau solusi sinkronisasi data. |
| DeployDISyncTask | DeployDISyncTask | Men-deploy tugas sinkronisasi real-time. |
| GetDISyncInstanceInfo | GetDISyncInstanceInfo | Mengkueri status tugas sinkronisasi pengatur waktu atau solusi sinkronisasi data. |
| TerminateDISyncInstance | TerminateDISyncInstance | Membatalkan penyebaran tugas sinkronisasi waktu nyata. |
| GenerateDISyncTaskConfigForCreating | GenerateDISyncTaskConfigForCreating | Menghasilkan ID untuk thread asinkron yang digunakan untuk membuat tugas sinkronisasi di Data Integration. |
| GenerateDISyncTaskConfigForUpdating | GenerateDISyncTaskConfigForUpdating | Menghasilkan konfigurasi untuk memperbarui tugas sinkronisasi waktu nyata di Data Integration. |
| StartDISyncInstance | StartDISyncInstance | Memulai tugas sinkronisasi pengatur waktu nyata atau solusi sinkronisasi. |
| StopDISyncInstance | Menghentikan Tugas Sinkronisasi Pengatur Waktu | Menghentikan tugas sinkronisasi pengatur waktu. |
| QueryDISyncTaskConfigProcessResult | QueryDISyncTaskConfigProcessResult | Mengkueri hasil tugas asinkron untuk menghasilkan konfigurasi tugas sinkronisasi. |
| GetDIAlarmRule | GetDIAlarmRule | Mengambil detail aturan peringatan yang dikonfigurasi untuk tugas sinkronisasi. |
Pemodelan data
|
API |
Judul |
Deskripsi |
| QueryPublicModelEngine | QueryPublicModelEngine | Mengambil informasi tentang objek Pemodelan Data yang dibuat menggunakan pernyataan fast modeling language (FML). |
Pusat operasi
|
API |
Judul |
Deskripsi |
| GetAlertMessage | GetAlertMessage | Menanyakan informasi peringatan berdasarkan ID peringatan yang ditentukan oleh parameter AlertId. |
| ListAlertMessages | ListAlertMessages | Mengkueri daftar peringatan. |
| GetBaselineConfig | GetBaselineConfig | Mengkueri konfigurasi garis dasar. |
| ListNodesByBaseline | ListNodesByBaseline | Membuat kueri node dalam baseline. |
| ListBaselineConfigs | ListBaselineConfigs | Mengkueri daftar garis dasar. |
| GetBaselineKeyPath | GetBaselineKeyPath | Informasi tentang acara yang terkait dengan instans. |
| GetBaselineStatus | GetBaselineStatus | Mengambil status instans baseline. |
| ListBaselineStatuses | Daftar Status Garis Dasar | Mengkueri daftar instans garis dasar. |
| DeleteRemind | DeleteRemind | Menghapus aturan peringatan pemantauan kustom. |
| UpdateRemind | UpdateRemind | Mengubah aturan peringatan kustom. |
| CreateRemind | CreateRemind | Membuat aturan peringatan kustom. |
| GetRemind | GetRemind | Mengkueri informasi tentang aturan peringatan kustom. |
| ListReminds | ListReminds | Mengambil daftar aturan peringatan kustom. |
| GetTopicInfluence | GetTopicInfluence | Membuat kueri instance baseline yang terpengaruh oleh suatu acara. |
| ListNodeInputOrOutput | ListNodeInputOrOutput | Meminta informasi input dan output tentang sebuah node. Hanya node leluhur atau turunan pada level terdekat yang dapat diminta setiap kali. |
| GetNodeCode | GetNodeCode | Mengkueri kode node. |
| GetInstanceLog | GetInstanceLog | Menanyakan log instance. |
| SetSuccessInstance | SetSuccessInstance | Mengatur status instans yang gagal menjadi berhasil. |
| SuspendInstance | SuspendInstance | Menangguhkan instans. |
| RunCycleDagNodes | RunCycleDagNodes | Membuat alur kerja untuk pengisian ulang data. |
| RunSmokeTest | RunSmokeTest | Membuat alur kerja untuk melakukan pengujian asap. |
| ListSuccessInstanceAmount | ListSuccessInstanceAmount | Mengkueri tren jumlah instance node yang dipicu otomatis yang berhasil dijalankan setiap jam tepat waktu pada hari ini. |
| ListInstanceAmount | ListInstanceAmount | Mengkueri tren jumlah instans node yang dipicu otomatis dalam periode pengatur waktu tertentu. |
| TopTenElapsedTimeInstance | Sepuluh Instans Teratas Berdasarkan Waktu Berjalan | Mengkueri peringkat durasi berjalan instans. |
| TopTenErrorTimesInstance | TopTenErrorTimesInstance | Mengkueri peringkat node yang mengalami error dalam satu bulan terakhir. |
| GetFileTypeStatistic | GetFileTypeStatistic | Mengkueri distribusi tipe node. |
| GetInstanceStatusStatistic | GetInstanceStatusStatistic | Mengkueri jumlah instans di setiap status. |
| ListFileType | ListFileType | Mengkueri informasi tentang tipe node, seperti kode dan nama. |
| RunManualDagNodes | RunManualDagNodes | Menjalankan node dalam alur kerja yang dipicu secara manual. Sebelum Anda memanggil operasi ini, pastikan alur kerja yang dipicu secara manual telah di-commit dan di-deploy. Anda dapat menemukan alur kerja yang dipicu secara manual di Operation Center hanya setelah alur kerja yang dipicu secara manual di-commit dan di-deploy. |
| ListManualDagInstances | ListManualDagInstances | Mengkueri informasi tentang instans dalam alur kerja yang dipicu secara manual. |
| GetDag | GetDag | Mengkueri informasi tentang graf asiklik terarah (DAG). Anda dapat memanggil operasi GetDag untuk mengkueri informasi DAG untuk alur kerja yang dipicu secara manual, node yang dipicu secara manual, atau instans pengisian ulang data. Namun, Anda tidak dapat mengkueri informasi DAG untuk node yang dipicu secara otomatis atau alur kerja yang dipicu secara otomatis. |
| ListDags | ListDags | Mengambil daftar graf asiklik berarah (DAG) untuk instans isi ulang data berdasarkan nomor urut operasi (OpSeq). |
| ListNodesByOutput | ListNodesByOutput | Melakukan kueri node berdasarkan output dari node. |
| RunTriggerNode | RunTriggerNode | Menjalankan node yang dipicu secara manual. |
| GetNodeParents | GetNodeParents | Mengkueri daftar node leluhur dari sebuah node. |
| GetNodeChildren | GetNodeChildren | Mengkueri daftar instans. |
| UpdateNodeRunMode | UpdateNodeRunMode | Membekukan atau mencairkan node. |
| UpdateNodeOwner | UpdateNodeOwner | Mengubah pemilik node. |
| UpdateWorkbenchEventResult | UpdateWorkbenchEventResult | Mengembalikan hasil pemrosesan yang dikirim oleh sebuah ekstensi setelah suatu proses di Operation Center diblokir oleh ekstensi tersebut. |
| ListShiftPersonnels | ListShiftPersonnels | Meminta daftar insinyur yang bertugas dalam jadwal shift. |
| ListShiftSchedules | ListShiftSchedules | Mengkueri daftar jadwal shift di Operation Center. |
| ListInstanceHistory | Daftar Riwayat Instans | Mengambil riwayat eksekusi instans. Setiap eksekusi ulang menghasilkan catatan riwayat baru. |
| ListInnerNodes | ListInnerNodes | Mengambil daftar node internal dalam grup node atau node do-while. Operasi ini tidak mendukung kueri node internal dari node PAI. |
| OfflineNode | Melepas deployment node | Melepas deployment node. |
| GetBaseline | GetBaseline | Menanyakan informasi tentang baseline berdasarkan ID-nya. |
| DeleteBaseline | DeleteBaseline | Menghapus garis dasar berdasarkan ID. Anda hanya dapat menghapus garis dasar jika node di garis dasar tersebut tidak memiliki node induk. Anda dapat memanggil operasi UpdateBaseline untuk menghapus hubungan antara node dan node induknya. |
| ListBaselines | ListBaselines | Mengambil daftar garis dasar. |
| CreateBaseline | CreateBaseline | Membuat garis dasar. |
| UpdateBaseline | UpdateBaseline | Memperbarui garis dasar. |
Kualitas data
|
API |
Judul |
Deskripsi |
| UpdateQualityFollower | UpdateQualityFollower | Memperbarui langganan. |
| UpdateQualityRule | UpdateQualityRule | Memperbarui aturan kualitas tertentu. |
| DeleteQualityFollower | DeleteQualityFollower | Menghapus Follower dari ekspresi partisi. |
| GetQualityFollower | GetQualityFollower | Mengambil pengikut ekspresi partisi. |
| CreateQualityFollower | CreateQualityFollower | Menambahkan pengikut ke ekspresi partisi untuk menerima peringatan kualitas data. |
| DeleteQualityEntity | DeleteQualityEntity | Menghapus ekspresi partisi. |
| GetQualityEntity | GetQualityEntity | Panggil `GetQualityEntity` untuk mengambil ekspresi partisi. |
| CreateQualityEntity | CreateQualityEntity | Membuat ekspresi partisi untuk Kualitas Data. |
| CreateQualityRelativeNode | CreateQualityRelativeNode | Membuat asosiasi ekspresi partisi. |
| DeleteQualityRelativeNode | Menghapus Node Relatif Kualitas | Menghapus asosiasi penjadwalan. |
| ListQualityResultsByEntity | ListQualityResultsByEntity | Mengambil hasil validasi berdasarkan ekspresi partisi. |
| ListQualityResultsByRule | ListQualityResultsByRule | Memvalidasi kualitas Sumber Data terhadap Aturan Validasi dan mengembalikan Hasil Validasi. |
Layanan data
|
API |
Judul |
Deskripsi |
| DeleteDataServiceApi | DeleteDataServiceApi | Menghapus API di Studio Layanan Data. |
| ListDataServiceApis | ListDataServiceApis | Mengkueri daftar API dalam status pengembangan. |
| GetDataServiceApi | GetDataServiceApi | Mengambil detail API DataService Studio dalam status pengembangan. |
| UpdateDataServiceApi | UpdateDataServiceApi | Memperbarui informasi tentang API dalam status pengembangan di Studio Layanan Data. |
| GetDataServicePublishedApi | GetDataServicePublishedApi | Mengambil detail API DataService Studio yang dipublikasikan. |
| ListDataServiceApiAuthorities | ListDataServiceApiAuthorities | Mengambil daftar API yang izin aksesnya diberikan kepada pengguna lain. |
| ListDataServiceAuthorizedApis | ListDataServiceAuthorizedApis | Mengambil daftar API yang Anda diberi izin untuk mengakses. |
| AbolishDataServiceApi | AbolishDataServiceApi | Membatalkan publikasi API Studio Layanan Data. |
| GetDataServiceApplication | GetDataServiceApplication | Mengambil detail aplikasi. |
| ListDataServiceApplications | ListDataServiceApplications | Mengambil daftar aplikasi. |
| CreateDataServiceFolder | CreateDataServiceFolder | Membuat folder di Studio Layanan Data. |
| GetDataServiceFolder | GetDataServiceFolder | Mengkueri sebuah folder. |
| ListDataServiceFolders | Daftar Folder Layanan Data | Mengambil daftar folder. |
| CreateDataServiceGroup | CreateDataServiceGroup | Membuat proses bisnis. |
| GetDataServiceGroup | GetDataServiceGroup | Mengambil detail proses bisnis. |
| ListDataServiceGroups | ListDataServiceGroups | Mengambil daftar proses bisnis. |
| CreateDataServiceApiAuthority | CreateDataServiceApiAuthority | Memberikan izin akses pada API di DataService Studio. |
| DeleteDataServiceApiAuthority | DeleteDataServiceApiAuthority | Mencabut izin akses pada suatu API. |
| ListDataServiceApiTest | ListDataServiceApiTest | Mengkueri catatan pengujian API Studio Layanan Data. Operasi API ini memungkinkan Anda mengkueri hanya catatan pengujian yang dihasilkan dalam satu bulan sebelumnya. |
| TestDataServiceApi | TestDataServiceApi | Menguji API Studio Layanan Data dalam mode asinkron. Anda dapat memanggil operasi GetDataServiceApiTest untuk mengkueri hasil pengujian. |
| GetDataServiceApiTest | GetDataServiceApiTest | Mengkueri hasil pengujian API di Studio Layanan Data. |
| SubmitDataServiceApi | SubmitDataServiceApi | Mengirimkan API di Studio Layanan Data. |
| SaveDataServiceApiTestResult | SaveDataServiceApiTestResult | Menyimpan hasil pengujian dari sebuah API. |
Perlindungan data
|
API |
Judul |
Deskripsi |
| DsgUpdateDesensStatusList | Perbarui status sakelar penyamaran data | Perbarui status sakelar penyamaran data |
| DsgQueryDesensStatusList | Kueri Switch Penyamaran Data | Mengkueri status switch penyamaran data. |
| GetOpSensitiveData | GetOpSensitiveData | Mengkueri rekaman yang dibuat pada tanggal tertentu untuk akses ke data sensitif di semua workspace DataWorks penyewa. |
| DesensitizeData | DesensitizeData | Menyembunyikan data. |
| GetOpRiskData | GetOpRiskData | Mengkueri catatan yang dihasilkan pada tanggal tertentu untuk akses ke data sensitif berisiko tinggi di semua ruang kerja DataWorks dari sebuah tenant. |
| GetSensitiveData | GetSensitiveData | Mengkueri data sensitif terbaru di semua ruang kerja DataWorks dari sebuah tenant. |
| ScanSensitiveData | Pindai Data Sensitif | Memeriksa apakah data masukan mengandung data sensitif. |
| DsgQuerySensResult | Mengambil Hasil Identifikasi Data Sensitif | Mengambil hasil identifikasi data sensitif dari Data Security Guard. |
| QueryDefaultTemplate | QueryDefaultTemplate | Mengkueri templat kategori data dan tingkat sensitivitas data default yang ditentukan oleh Data Security Guard. |
| DsgStopSensIdentify | DsgStopSensIdentify | Menghentikan tugas identifikasi data sensitif. |
| QuerySensClassification | QuerySensClassification | Membuat kueri kategori data. |
| QuerySensLevel | QuerySensLevel | Mengkueri tingkat sensitivitas data di Data Security Guard. |
| QueryRecognizeRulesType | Kueri Tipe Aturan Identifikasi Data Sensitif | Mengkueri aturan identifikasi data sensitif bawaan yang digunakan untuk mengonfigurasi bidang sensitif. |
| DsgRunSensIdentify | DsgRunSensIdentify | Memulai tugas identifikasi data sensitif di Data Security Guard. |
| DeleteRecognizeRule | DeleteRecognizeRule | Menghapus tipe bidang sensitif. |
| QuerySensNodeInfo | QuerySensNodeInfo | Meminta aturan identifikasi data sensitif. |
| AddRecognizeRule | AddRecognizeRule | Menambahkan bidang sensitif yang didefinisikan berdasarkan kategori dan tingkat sensitivitas data di Data Security Guard. |
| EditRecognizeRule | EditRecognizeRule | Mengubah bidang sensitif yang ditentukan berdasarkan kategori dan tingkat sensitivitas data di Data Security Guard. |
| QueryRecognizeDataByRuleType | QueryRecognizeDataByRuleType | Mengkueri tipe aturan identifikasi data sensitif. |
| QueryRecognizeRuleDetail | QueryRecognizeRuleDetail | Mengambil detail bidang sensitif tertentu di Data Security Guard. |
| DsgUserGroupGetOdpsRoleGroups | DsgUserGroupGetOdpsRoleGroups | Mengkueri daftar peran MaxCompute yang dapat dipilih oleh anggota kelompok pengguna saat kelompok pengguna dibuat atau dimodifikasi oleh penyewa di Data Security Guard. |
| DsgDesensPlanAddOrUpdate | DsgDesensPlanAddOrUpdate | Panggil API `DsgDesensPlanAddOrUpdate` untuk membuat atau mengedit aturan penyamaran data. |
| DsgPlatformQueryProjectsAndSchemaFromMeta | DsgPlatformQueryProjectsAndSchemaFromMeta | Mengkueri daftar mesin komputasi dari berbagai jenis di penyewa saat ini. |
| DsgUserGroupDelete | DsgUserGroupDelete | Menghapus grup pengguna yang dikonfigurasi di Data Security Guard. |
| DsgWhiteListDeleteList | Hapus Daftar Putih Penyamaran Data | Menghapus daftar putih penyamaran data yang dikonfigurasi di Data Security Guard. |
| DsgScenedDeleteScene | DsgScenedDeleteScene | Menghapus skenario penyamaran data level-2 yang dibuat di Data Security Guard. |
| DsgDesensPlanDelete | DsgDesensPlanDelete | Menghapus aturan penyamaran data yang dibuat di Data Security Guard. |
| DsgDesensPlanUpdateStatus | DsgDesensPlanUpdateStatus | Mengubah status aturan penyamaran data. |
| DsgWhiteListQueryList | DsgWhiteListQueryList | Membuat kueri daftar putih penyamaran data. |
| DsgSceneAddOrUpdateScene | DsgSceneAddOrUpdateScene | Menambahkan atau memodifikasi skenario penyamaran data tingkat-2. |
| DsgSceneQuerySceneListByName | DsgSceneQuerySceneListByName | Panggil API `DsgSceneQuerySceneListByName` untuk mengambil daftar skenario penyamaran data. |
| DsgUserGroupAddOrUpdate | DsgUserGroupAddOrUpdate | Membuat atau memperbarui kelompok pengguna di Data Security Guard. |
| DsgUserGroupQueryList | DsgUserGroupQueryList | Memanggil `DsgUserGroupQueryList` untuk mengkueri kelompok pengguna di Data Security Guard (DSG). |
| DsgUserGroupQueryUserList | DsgUserGroupQueryUserList | Mengkueri daftar pengguna atau peran penyewa saat ini. |
| DsgDesensPlanQueryList | DsgDesensPlanQueryList | Memanggil API DsgDesensPlanQueryList untuk mengkueri aturan penyamaran data Data Security Guard (DSG). |
| DsgWhiteListAddOrUpdate | DsgWhiteListAddOrUpdate | Menambahkan atau memodifikasi daftar putih penyamaran data. |
| DsgQueryDefaultTemplates | DsgQueryDefaultTemplates | Mengambil Templat Tipe Data Sensitif yang tersedia dan Aturan Desensitisasi yang didukungnya. Gunakan tanggapan API ini untuk mengonfigurasi Aturan Desensitisasi Anda. |
Asisten migrasi
|
API |
Judul |
Deskripsi |
| CreateImportMigration | CreateImportMigration | Membuat tugas impor. Tugas impor berisi paket impor untuk sumber data, node, dan tabel. |
| GetMigrationProcess | GetMigrationProcess | Mengkueri kemajuan tugas migrasi. |
| StartMigration | StartMigration | Memulai tugas migrasi. |
| CreateExportMigration | CreateExportMigration | Membuat tugas ekspor. Anda dapat menggunakan operasi ini untuk membuat tugas ekspor, tetapi tidak dapat menggunakan operasi ini untuk memulai tugas ekspor yang dibuat. |
| GetMigrationSummary | GetMigrationSummary | Mengkueri informasi tugas migrasi. |
| ListMigrations | ListMigrations | Mengkueri daftar tugas migrasi. |
Pusat keamanan
|
API |
Judul |
Deskripsi |
| CreatePermissionApplyOrder | Membuat Pesanan Permintaan Izin. | Membuat pesanan permintaan izin. Catatan: Edisi OpenAPI 2020 akan segera dihentikan. Segera bermigrasi ke Edisi OpenAPI 2024 — ApplyResourceAccessPermission. |
| GetPermissionApplyOrderDetail | Mengkueri Detail Pesanan Permintaan Izin | Mengkueri detail pesanan permintaan izin. Catatan: Versi OpenAPI 2020 akan dihentikan. Harap bermigrasi ke versi OpenAPI 2024 sesegera mungkin — GetApplicationContents/GetProcessInstance. |
| ListPermissionApplyOrders | Mengkueri daftar pesanan aplikasi izin | Mengkueri daftar pesanan aplikasi izin. |
| ApprovePermissionApplyOrder | Menyetujui Pesanan Permintaan Izin | Menyetujui pesanan permintaan izin. Catatan: Edisi OpenAPI 2020 akan dihentikan. Segera bermigrasi ke OpenAPI edisi 2024 ApproveProcessInstance. |
Platform terbuka
|
API |
Judul |
Deskripsi |
| ListExtensions | ListExtensions | Menanyakan daftar ekstensi. |
| GetExtension | GetExtension | Mengambil detail ekstensi. |
| GetOptionValueForProject | GetOptionValueForProject | Mengkueri pengaturan opsi ekstensi di ruang kerja. |
| ListEnabledExtensionsForProject | ListEnabledExtensionsForProject | Mengkueri daftar ekstensi bawaan dan kustom yang diaktifkan di ruang kerja. |
| CallbackExtension | CallbackExtension | Mengirim hasil pemrosesan event extension point oleh ekstensi ke DataWorks. |
| ListCheckProcesses | ListCheckProcesses | Mengkueri hasil pemeriksaan event titik ekstensi. |
Lainnya
|
API |
Judul |
Deskripsi |
| UpdateTableAddColumn | Memperbarui Tabel dengan Menambahkan Kolom | Memperbarui bidang dalam tabel MaxCompute. |
| GetMetaTableFullInfo | GetMetaTableFullInfo | Mengambil metadata lengkap untuk tabel, termasuk detail kolom. |
| GetDDLJobStatus | GetDDLJobStatus | Mengkueri status tugas pembuatan, pembaruan, atau penghapusan tabel. |
| DeleteTable | DeleteTable | Menghapus tabel MaxCompute. |
| CreateTable | CreateTable | Membuat tabel MaxCompute. |
| CheckFileDeployment | CheckFileDeployment | Mengembalikan event pemeriksaan untuk file yang menunggu penerapan di DataStudio. Setelah file di-commit, DataWorks memeriksa file dan menghasilkan event sebelum penerapan. Gunakan event yang dikembalikan untuk menentukan apakah file dapat melanjutkan validasi penerapan. |
| ListRefDISyncTasks | ListRefDISyncTasks | Meminta tugas sinkronisasi di Data Integration yang menggunakan sumber data tertentu. |
| ExportDataSources | ExportDataSources | Mengekspor daftar sumber data. |
| ImportDataSources | Impor Sumber Data | Mengimpor sumber data dari mesin on-premises Anda ke ruang kerja DataWorks tertentu. |
| UpdateClusterConfigs | UpdateClusterConfigs | Memperbarui konfigurasi submodul kluster di ruang kerja. Saat ini, hanya parameter Spark yang didukung. |
| ListClusterConfigs | Daftar konfigurasi kluster | Mengkueri konfigurasi submodul di ruang kerja. Anda dapat mengkueri informasi tentang parameter SPARK. |
API yang tidak digunakan lagi
|
API |
Judul |
Deskripsi |
| ListEntitiesByTags | ListEntitiesByTags | Mengkueri daftar entitas berdasarkan tag. Hanya entitas bertipe maxcompute-table yang didukung. |
| RemoveEntityTags | RemoveEntityTags | Menghapus tag dari entitas. Hanya entitas dengan tipe maxcompute-table yang didukung. |
| SetEntityTags | SetEntityTags | Mengonfigurasi tag untuk entitas. Hanya entitas bertipe maxcompute-table yang didukung. |
| ListEntityTags | Daftar Tag Entitas | Mengkueri daftar tag entitas. Hanya entitas bertipe maxcompute-table yang didukung. |
| SetDataSourceShare | SetDataSourceShare | Membagikan sumber data ke ruang kerja DataWorks tertentu atau pengguna tertentu. |
| CreateDagComplement | Membuat Alur Kerja Pengisian Ulang Data | Membuat alur kerja pengisian ulang data. |
| CreateDagTest | Membuat Alur Kerja Smoke Test | Membuat alur kerja smoke test dengan memanggil CreateDagTest. |
| CreateManualDag | Picu eksekusi dari alur kerja manual | Alur kerja manual harus sudah dikirim dan di-deploy melalui UI, dan Operation Center harus dapat menemukan alur kerja manual yang sesuai. Hanya dengan begitu API ini dapat digunakan. |
| GetProjectDetail | GetProjectDetail | Menanyakan informasi tentang workspace DataWorks. |
| ListNodeIO | ListNodeIO | Mengkueri informasi tentang satu tingkat node leluhur atau node turunan dari sebuah node. |
| GetInstanceStatusCount | GetInstanceStatusCount | Mengkueri statistik instans dalam berbagai status. |
| ListProgramTypeCount | ListProgramTypeCount | Mengkueri distribusi berbagai tipe node. |
| GetManualDagInstances | GetManualDagInstances | Mengkueri informasi tentang instans dalam alur kerja yang dipicu secara manual. |
| SearchNodesByOutput | SearchNodesByOutput | Mengkueri node berdasarkan output. |
| GetNodeTypeListInfo | GetNodeTypeListInfo | Mengambil informasi tentang tipe node, termasuk kode dan nama dari sebuah tipe node. |
| GetNodeOnBaseline | Kueri node pada baseline | Memanggil operasi GetNodeOnBaseline untuk melakukan kueri node pada baseline. |
| GetSuccessInstanceTrend | GetSuccessInstanceTrend | Mengkueri statistik instans pada periode berbeda dalam sehari. |
| GetInstanceCountTrend | GetInstanceCountTrend | Mengkueri tren jumlah instans yang dipicu secara otomatis. |
| GetInstanceConsumeTimeRank | Mengkueri peringkat instans berdasarkan durasi berjalan | Mengkueri peringkat instans berdasarkan durasi berjalan. |
| GetInstanceErrorRank | Memperoleh peringkat kesalahan node dalam sebulan terakhir | Memanggil GetInstanceErrorRank untuk memperoleh peringkat kesalahan node dalam sebulan terakhir. |
Others
|
API |
Judul |
Deskripsi |
| CreateBusiness | CreateBusiness | Membuat workflow di DataStudio. |
| CreateConnection | CreateConnection | Menambahkan sumber data. |
| CreateDIAlarmRule | CreateDIAlarmRule | Membuat aturan peringatan untuk tugas sinkronisasi. |
| CreateDIJob | CreateDIJob | Membuat tugas sinkronisasi versi baru. Jenis tugas sinkronisasi berikut didukung: sinkronisasi real-time semua data dari database MySQL ke Hologres dan sinkronisasi batch semua data dari database MySQL ke Hive. |
| CreateDataServiceApi | CreateDataServiceApi | Membuat API. |
| CreateDataSource | CreateDataSource | Menambahkan sumber data ke DataWorks. |
| CreateFile | CreateFile | Membuat file di DataStudio. Anda tidak dapat memanggil operasi ini untuk membuat file untuk node Data Integration. |
| CreateFolder | CreateFolder | Operasi yang ingin Anda lakukan. Setel nilai ke \\*\\*CreateFolder\\*\\*. |
| CreateMetaCollection | CreateMetaCollection | Membuat koleksi. |
| CreateProject | CreateProject | Membuat ruang kerja DataWorks. |
| CreateProjectMember | CreateProjectMember | Menambahkan pengguna ke ruang kerja DataWorks. |
| CreateQualityRule | CreateQualityRule | Membuat aturan kualitas. |
| CreateResourceFile | CreateResourceFile | Membuat atau mengunggah file resource di DataStudio. Fitur yang diimplementasikan dengan memanggil operasi ini sama dengan fitur pembuatan resource yang disediakan di lingkungan pengembangan terintegrasi (IDE). |
| CreateUdfFile | CreateUdfFile | Membuat file untuk fungsi di DataStudio. |
| DeleteBusiness | DeleteBusiness | Menghapus alur kerja. |
| DeleteConnection | DeleteConnection | Menghapus sumber data. |
| DeleteDIAlarmRule | Menghapus Aturan Alert Integrasi Data | Menghapus aturan alert untuk tugas Data Integration versi baru. Hanya jenis tugas berikut yang didukung: sinkronisasi data real-time dari database MySQL ke Gudang Data Real-time. |
| DeleteDIJob | DeleteDIJob | Menghapus tugas Data Integration versi baru. Hanya jenis tugas berikut yang didukung: sinkronisasi data real-time dari database MySQL ke Hologres. |
| DeleteDataSource | DeleteDataSource | Menghapus sumber data. |
| DeleteFile | DeleteFile | Menghapus file dari DataStudio. Jika file telah di-commit, proses asinkron akan dipicu untuk menghapus file di sistem penjadwalan. Nilai parameter DeploymentId yang dikembalikan digunakan untuk memanggil operasi GetDeployment guna mem-polling status proses asinkron. |
| DeleteFolder | DeleteFolder | Menghapus folder dari halaman Data Development. |
| DeleteMetaCollection | Hapus Koleksi | Menghapus koleksi. |
| DeleteProjectMember | DeleteProjectMember | Menghapus pengguna dari ruang kerja DataWorks. |
| DeleteQualityRule | DeleteQualityRule | Menghapus aturan kualitas data. |
| DeployFile | DeployFile | Menerapkan file ke lingkungan produksi. |
| EstablishRelationTableToBusiness | EstablishRelationTableToBusiness | Mengimpor tabel ke alur kerja. Pemanggilan operasi API ini setara dengan melakukan operasi berikut: Buka halaman DataStudio, cari alur kerja yang diinginkan, lalu klik nama alur kerja tersebut. Klik kanan Tabel di bawah folder yang diinginkan dan pilih Impor Tabel. |
| GetBusiness | GetBusiness | Mengkueri informasi tentang alur kerja. |
| GetDIJob | GetDIJob | Mengkueri informasi tentang tugas sinkronisasi versi baru yang dibuat di Data Integration. Jenis tugas sinkronisasi berikut didukung: sinkronisasi pengatur waktu seluruh data di database MySQL ke Gudang Data Real-time. |
| GetDeployment | GetDeployment | Mengkueri informasi tentang Paket penyebaran. |
| GetFile | GetFile | Mengkueri informasi file. |
| GetFileVersion | GetFileVersion | Mengkueri informasi tentang versi file. |
| GetFolder | GetFolder | Anda dapat memanggil GetFolder untuk mengambil detail sebuah folder. |
| GetIDEEventDetail | GetIDEEventDetail | Mengkueri snapshot data extension point berdasarkan ID Paket di DataWorks OpenEvent saat event extension point terkait dipicu. |
| GetInstance | GetInstance | Mengkueri informasi tentang sebuah instance. |
| GetNode | GetNode | Apakah permintaan berhasil. |
| GetProject | GetProject | Mengkueri informasi tentang ruang kerja DataWorks. |
| GetQualityRule | GetQualityRule | Mengambil informasi tentang aturan kualitas. |
| GetTopic | GetTopic | Menanyakan informasi tentang sebuah peristiwa. |
| ListBusiness | ListBusiness | Menanyakan daftar alur kerja. |
| ListCalcEngines | ListCalcEngines | Queries a list of compute engines that are associated with a DataWorks workspace. |
| ListClusters | ListClusters | Mengkueri kluster yang terdaftar di DataWorks. Kluster E-MapReduce (EMR) dan kluster Cloudera's Distribution Including Apache Hadoop (CDH) didukung. |
| ListConnections | ListConnections | Mengkueri daftar sumber data. |
| ListDIAlarmRules | ListDIAlarmRules | Mengambil daftar aturan peringatan yang dikonfigurasi untuk tugas sinkronisasi. |
| ListDIJobs | ListDIJobs | Mengambil daftar tugas sinkronisasi. |
| ListDataServicePublishedApis | ListDataServicePublishedApis | Mengambil daftar API yang telah dipublikasikan. |
| ListDataSources | ListDataSources | Mengkueri sumber data yang ditambahkan ke workspace DataWorks. |
| ListDeployments | ListDeployments | Mengkueri daftar Paket penyebaran. Operasi ini setara dengan melihat daftar Paket penyebaran pada halaman Paket penyebaran di Konsol DataWorks. |
| ListFileVersions | ListFileVersions | Meminta daftar versi file. |
| ListFiles | ListFiles | Mengkueri daftar file. |
| ListFolders | ListFolders | Mengkueri folder. |
| ListInstances | ListInstances | Mengkueri daftar instans. |
| ListMetaCollections | ListMetaCollections | Mengambil daftar koleksi. Koleksi mencakup album data yang ditampilkan di halaman Peta Data dan kategori yang dibuat di album data. Anda dapat memfilter koleksi berdasarkan tipe. |
| ListNodes | ListNodes | ID ruang kerja. |
| ListProjectMembers | ListProjectMembers | Mengkueri daftar anggota yang ada di ruang kerja DataWorks. |
| ListProjectRoles | Daftar Peran Proyek | Mengkueri daftar peran di ruang kerja DataWorks. |
| ListProjects | ListProjects | Mengkueri daftar ruang kerja DataWorks pada penyewa tempat pengguna berada. |
| ListQualityRules | ListQualityRules | Panggil ListQualityRules untuk mengambil aturan kualitas yang cocok dengan ekspresi partisi. |
| ListResourceGroups | ListResourceGroups | Mengkueri daftar kelompok sumber daya dengan tipe tertentu. |
| ListTables | Daftar Tabel | Mengambil tabel berbagai tipe sumber data dalam penyewa per halaman. |
| ListTopics | ListTopics | Mengkueri event. |
| PublishDataServiceApi | PublishDataServiceApi | Mempublikasikan API. |
| RestartInstance | RestartInstance | Merestart instans. |
| ResumeInstance | ResumeInstance | Melanjutkan instans yang ditangguhkan. |
| RevokeTablePermission | RevokeTablePermission | Mencabut izin pada tabel dari seorang pengguna. |
| StartDIJob | StartDIJob | Memulai tugas sinkronisasi versi baru. Hanya tipe tugas berikut yang didukung: sinkronisasi data real-time dari database MySQL ke Hologres. |
| StopDIJob | StopDIJob | Menghentikan tugas sinkronisasi versi baru. Tipe tugas sinkronisasi berikut didukung: sinkronisasi real-time semua data dalam database MySQL ke Hologres. |
| StopInstance | StopInstance | Menghentikan sebuah instans. |
| SubmitFile | SubmitFile | Mengirimkan file ke lingkungan pengembangan untuk membuat tugas yang sesuai. |
| UpdateBusiness | UpdateBusiness | Memperbarui alur kerja. |
| UpdateConnection | UpdateConnection | Memperbarui sumber data. |
| UpdateDIAlarmRule | UpdateDIAlarmRule | Memperbarui aturan peringatan untuk tugas sinkronisasi. |
| UpdateDIJob | UpdateDIJob | Memperbarui tugas sinkronisasi versi baru. Jenis tugas berikut didukung: sinkronisasi real-time seluruh data dalam database MySQL ke Hologres. |
| UpdateDataSource | UpdateDataSource | Memperbarui sumber data. |
| UpdateFile | UpdateFile | Memperbarui file. |
| UpdateFolder | UpdateFolder | Memperbarui folder. |
| UpdateIDEEventResult | UpdateIDEEventResult | Mengembalikan hasil pemeriksaan suatu peristiwa extension point ke DataStudio setelah peristiwa extension point tersebut dipicu selama pengembangan data dan diperiksa oleh sebuah extension. |
| UpdateMetaCollection | UpdateMetaCollection | Memperbarui nama dan komentar koleksi. |
| UpdateTable | UpdateTable | Memperbarui tabel MaxCompute. |
| UpdateUdfFile | UpdateUdfFile | Memperbarui informasi file tentang sebuah fungsi. |