All Products
Search
Document Center

DataWorks:Ikhtisar API

Last Updated:Jul 13, 2026

Standar API dan SDK siap pakai dalam berbagai bahasa

Spesifikasi OpenAPI produk ini (dataworks-public/2024-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

Agen Data

API

Judul

Deskripsi

Manajemen server MCP Manajemen server MCP
CreateMcpServer CreateMcpServer Membuat MCP Server.
DeleteMcpServer Hapus MCP Server Hapus MCP Server
UpdateMcpServer UpdateMcpServer Memperbarui MCP Server.
GetMcpServer GetMcpServer Mengembalikan detail MCP Server.
ListMcpServers ListMcpServers Mengambil daftar server MCP yang dipaginasi.
Manajemen keterampilan Manajemen keterampilan
DeleteSkill Hapus Skill Menghapus skill.
GetSkill GetSkill Mengambil detail Skill tertentu berdasarkan nama, termasuk isi file SKILL.md dan tautan unduhan bundle.
ListSkills ListSkills Mencantumkan Skill di akun Anda.
Manajemen agen Manajemen agen
CreateAgent Create Agent Membuat Agen.
ListCustomAgents ListCustomAgents Mengambil daftar agen kustom dengan paginasi.
GetAgent GetAgent Mengambil detail agen berdasarkan nama.
ListAgents ListAgents Mencantumkan agen untuk penyewa saat ini dan mendukung pemfilteran berdasarkan nama dan paginasi.
Manajemen sesi agen Manajemen sesi agen
PromptAgentSession PromptAgentSession Mengirim prompt ke sesi yang sudah ada dan melakukan streaming respons agen.
LoadAgentSession LoadAgentSession Memuat riwayat Paket dari sesi yang ada dan mengembalikannya sebagai aliran SSE. Jika sesi tidak ada, server mengirimkan JSONRPCResponse.error dengan kode 400 melalui aliran SSE. Content-Type adalah text/event-stream. Gunakan operasi ini untuk memulihkan konteks sesi.
ListAgentSessions ListAgentSessions Mengambil riwayat percakapan untuk sesi agen.
ListAgentSessionArtifacts ListAgentSessionArtifacts Mengambil daftar artefak dari sesi tertentu.
GetAgentSessionTokenUsage GetAgentSessionTokenUsage Mengambil penggunaan token AI kumulatif untuk sesi tertentu.
GetAgentSessionArtifactMeta GetAgentSessionArtifactMeta Mengambil metadata dan konten artefak berdasarkan ID sesi dan jalur artefak.
CreateAgentSession Membuat sesi. Membuat sesi agen baru dan mengembalikan ID sesi.
CancelAgentSession CancelAgentSession Membatalkan panggilan agent dalam sesi tertentu. Operasi ini juga mendukung penghentian respons streaming yang sedang berlangsung.

Manajemen ruang kerja

API

Judul

Deskripsi

Ruang kerja Ruang kerja
CreateProject CreateProject Membuat ruang kerja.
DeleteProject DeleteProject Menghapus workspace DataWorks.
UpdateProject UpdateProject Operasi ini memperbarui ruang kerja DataWorks.
ListProjects ListProjects Mengkueri daftar ruang kerja DataWorks dari tenant tempat akun Anda berada.
GetProject GetProject Mengkueri informasi tentang ruang kerja DataWorks.
Peran ruang kerja Peran ruang kerja
CreateProjectRole CreateProjectRole Membuat peran kustom untuk ruang kerja.
DeleteProjectRole DeleteProjectRole Menghapus peran kustom dari workspace.
UpdateProjectRole UpdateProjectRole Memperbarui izin peran kustom di ruang kerja.
GetProjectRole GetProjectRole Mengkueri detail peran ruang kerja.
ListProjectRoles ListProjectRoles Mengembalikan daftar role yang dipaginasi dalam sebuah workspace.
Anggota ruang kerja Anggota ruang kerja
CreateProjectMember CreateProjectMember Menambahkan anggota ruang kerja dan menetapkan peran tingkat ruang kerja kepada anggota tersebut.
DeleteProjectMember DeleteProjectMember Menghapus anggota ruang kerja dan peran tingkat ruang kerja yang ditetapkan kepada anggota tersebut.
GrantMemberProjectRoles GrantMemberProjectRoles Menetapkan peran kepada anggota di ruang kerja.
RevokeMemberProjectRoles RevokeMemberProjectRoles Mencabut peran yang ditetapkan kepada anggota di ruang kerja.
GetProjectMember GetProjectMember Mengambil detail anggota tertentu dalam Workspace.
ListProjectMembers ListProjectMembers Mengkueri daftar anggota ruang kerja per halaman.

Sumber data

API

Judul

Deskripsi

UpdateDataSource UpdateDataSource Memodifikasi sumber data berdasarkan ID.
TestDataSourceConnectivity Menguji konektivitas sumber data Menguji konektivitas sumber data pada grup sumber daya.
CreateDataSource CreateDataSource Menambahkan sumber data ke lingkungan pengembangan atau lingkungan produksi ruang kerja.
DeleteDataSource DeleteDataSource Menghapus sumber data berdasarkan ID sumber data.
CloneDataSource CloneDataSource Menduplikasi sumber data untuk membuat sumber data baru dengan konfigurasi yang sama.
ListDataSources ListDataSources Mengambil daftar sumber data yang cocok dengan kondisi filter yang ditentukan.
Aturan berbagi sumber data Aturan berbagi sumber data
CreateDataSourceSharedRule CreateDataSourceSharedRule Membuat aturan berbagi untuk sumber data agar dapat dibagikan dengan workspace lain atau pengguna RAM.
DeleteDataSourceSharedRule DeleteDataSourceSharedRule Menghapus aturan berbagi sumber data berdasarkan ID aturan.
ListDataSourceSharedRules ListDataSourceSharedRules Mengambil daftar aturan berbagi untuk sumber data.

Resource komputasi

API

Judul

Deskripsi

DeleteComputeResource DeleteComputeResource Menghapus sumber daya komputasi yang ditentukan berdasarkan ID sumber daya komputasi.
GetComputeResource GetComputeResource Mengambil sumber daya komputasi yang ditentukan berdasarkan ID sumber daya komputasi.
UpdateComputeResource UpdateComputeResource Mengubah sumber daya komputasi tertentu berdasarkan ID sumber daya komputasi.
ListComputeResources ListComputeResources Mengkueri daftar sumber daya komputasi yang memenuhi informasi bisnis yang ditentukan.
CreateComputeResource CreateComputeResource Membuat Sumber daya komputasi di ruang kerja yang ditentukan. Sumber daya dapat digunakan untuk lingkungan pengembangan atau lingkungan produksi.

Manajemen kelompok sumber daya

API

Judul

Deskripsi

Kelompok sumber daya Kelompok sumber daya
CreateResourceGroup CreateResourceGroup Membuat kelompok sumber daya.
DeleteResourceGroup DeleteResourceGroup Menghapus grup sumber daya.
UpdateResourceGroup UpdateResourceGroup Memperbarui informasi dasar tentang kelompok sumber daya.
GetResourceGroup GetResourceGroup Mengkueri informasi kelompok sumber daya berdasarkan ID.
ListResourceGroups ListResourceGroups Mengambil daftar grup sumber daya.
DissociateProjectFromResourceGroup Memisahkan resource group dari workspace Memisahkan resource group dari workspace.
AssociateProjectToResourceGroup AssociateProjectToResourceGroup Mengaitkan grup sumber daya dengan ruang kerja.
ListResourceGroupAssociateProjects ListResourceGroupAssociateProjects Mengkueri daftar ruang kerja yang terkait dengan kelompok sumber daya.
ListResourceGroupMetricData ListResourceGroupMetricData Mengkueri data metrik dari grup sumber daya.
Entri rute Entri rute
CreateRoute CreateRoute Membuat entri rute untuk jaringan.
DeleteRoute DeleteRoute Menghapus rute dari sumber daya jaringan.
UpdateRoute UpdateRoute Memperbarui informasi entri rute.
GetRoute GetRoute Mengkueri informasi entri rute berdasarkan ID.
ListRoutes ListRoutes Mengambil daftar entri rute untuk Sumber daya jaringan.
Jaringan Jaringan
CreateNetwork CreateNetwork Membuat jaringan dan mengaitkannya dengan grup sumber daya umum.
DeleteNetwork DeleteNetwork Memutuskan asosiasi dan menghapus jaringan dari grup sumber daya umum.
GetNetwork GetNetwork Mengkueri informasi Sumber daya jaringan.
ListNetworks ListNetworks Mengambil daftar sumber daya jaringan untuk grup sumber daya serverless.

Manajemen image

API

Judul

Deskripsi

GetImage GetImage Mendapatkan detail gambar berdasarkan ID-nya.
ListImages ListImages Mengambil daftar image.
ListImageVersions ListImageVersions Mengambil detail versi gambar tertentu.
AssociateProjectToImage AssociateProjectToImage Mengaitkan image dengan ruang kerja.
DissociateProjectFromImage DissociateProjectFromImage Memutuskan asosiasi image dari ruang kerja.
ListImageAssociatedProjects ListImageAssociatedProjects Menampilkan daftar workspace yang terkait dengan sebuah image.

Pengembangan data (versi baru)

API

Judul

Deskripsi

Komponen Komponen
CreateComponent CreateComponent Membuat komponen.
DeleteComponent DeleteComponent Menghapus komponen.
GetComponent GetComponent Mendapatkan informasi komponen.
UpdateComponent UpdateComponent Memperbarui komponen.
ListComponents ListComponents Mengambil daftar komponen.
Node Node
CreateNode CreateNode Membuat node di DataStudio. Informasi tentang node dijelaskan menggunakan FlowSpec.
DeleteNode DeleteNode Menghapus node dari DataStudio.
UpdateNode UpdateNode Memperbarui informasi dasar tentang node di DataStudio. Operasi API ini melakukan pembaruan inkremental. Informasi pembaruan dideskripsikan menggunakan FlowSpec.
MoveNode MoveNode Memindahkan node ke jalur di DataStudio.
RenameNode RenameNode Mengganti nama node di DataStudio.
GetNode GetNode Mengkueri informasi tentang sebuah node di DataStudio.
ListNodes ListNodes Mengambil daftar node pengembangan data dengan paginasi yang dapat difilter berdasarkan kriteria yang ditentukan.
ListNodeDependencies ListNodeDependencies Mendapatkan daftar paginasi node dependen untuk node pengembangan data tertentu.
Definisi alur kerja Definisi alur kerja
CreateWorkflowDefinition CreateWorkflowDefinition Membuat alur kerja di direktori DataStudio.
ImportWorkflowDefinition Mengimpor alur kerja DataStudio. Mengimpor node alur kerja yang ditentukan oleh FlowSpec beserta node turunannya ke DataStudio.
DeleteWorkflowDefinition DeleteWorkflowDefinition Menghapus alur kerja dari DataStudio.
UpdateWorkflowDefinition UpdateWorkflowDefinition Memperbarui informasi dasar tentang alur kerja di DataStudio. Operasi API ini melakukan pembaruan inkremental. Informasi pembaruan dideskripsikan menggunakan FlowSpec.
MoveWorkflowDefinition MoveWorkflowDefinition Memindahkan alur kerja ke jalur di DataStudio.
RenameWorkflowDefinition RenameWorkflowDefinition Mengganti nama alur kerja di DataStudio.
GetWorkflowDefinition GetWorkflowDefinition Mengkueri informasi tentang alur kerja.
ListWorkflowDefinitions ListWorkflowDefinitions Mengkueri daftar alur kerja di DataStudio. Anda juga dapat menentukan kondisi filter untuk mengkueri alur kerja tertentu.
Resource Resource
CreateResource CreateResource \\> Anda tidak dapat menggunakan operasi API ini untuk membuat beberapa sumber daya file sekaligus. Jika Anda menentukan beberapa sumber daya file menggunakan FlowSpec, sistem hanya membuat sumber daya pertama yang ditentukan.
DeleteResource DeleteResource Menghapus sumber daya file dari DataStudio.
UpdateResource UpdateResource Memperbarui informasi dasar tentang sumber daya file di DataStudio. Operasi API ini melakukan pembaruan inkremental. Informasi pembaruan dijelaskan menggunakan FlowSpec.
GetResource GetResource Mengkueri informasi tentang Sumber daya file.
ListResources ListResources Mengkueri daftar Sumber daya file di DataStudio. Anda juga dapat menentukan kondisi filter untuk mengkueri Sumber daya file tertentu.
MoveResource MoveResource Memindahkan resource file ke sebuah path di DataStudio.
RenameResource RenameResource Mengganti nama sumber daya file di DataStudio.
Fungsi Fungsi
CreateFunction CreateFunction Membuat fungsi yang ditentukan pengguna (UDF) di DataStudio. Informasi tentang UDF dijelaskan menggunakan FlowSpec.
DeleteFunction DeleteFunction Menghapus fungsi yang ditentukan pengguna (UDF) di DataStudio.
UpdateFunction UpdateFunction Memperbarui informasi dasar tentang user-defined function (UDF) di DataStudio. Operasi API ini melakukan pembaruan inkremental. Informasi pembaruan dideskripsikan menggunakan FlowSpec.
MoveFunction MoveFunction Memindahkan fungsi yang ditentukan pengguna (UDF) ke path di DataStudio.
RenameFunction RenameFunction Mengganti nama fungsi yang ditentukan pengguna (UDF) di DataStudio.
GetFunction GetFunction Menanyakan informasi tentang fungsi yang ditentukan pengguna (UDF) di DataStudio.
ListFunctions ListFunctions Mengkueri daftar fungsi yang ditentukan pengguna (UDF) di DataStudio. Anda juga dapat menentukan kondisi filter untuk mengkueri UDF tertentu.
Proses penerbitan Proses penerbitan
CreatePipelineRun Create a publish process. Membuat proses publikasi untuk sebuah entitas di DataStudio versi baru.
AbolishPipelineRun AbolishPipelineRun Menghentikan proses deployment yang ditentukan. Operasi ini mengubah status proses menjadi Terminated, tetapi tidak menghapus proses tersebut. Anda tetap dapat mengkueri proses ini.
ExecPipelineRunStage ExecPipelineRunStage Menjalankan suatu tahap dalam sebuah proses.
GetPipelineRun GetPipelineRun Mengambil detail proses Penerapan.
ListPipelineRuns ListPipelineRuns Mengambil daftar proses penerapan yang dipaginasi. Anda juga dapat memfilter daftar ini berdasarkan kriteria tertentu.
ListPipelineRunItems ListPipelineRunItems Mengkueri informasi tentang objek penerapan berdasarkan ID proses penerapan.

Pengembangan data (warisan)

API

Judul

Deskripsi

File File
CreateFile CreateFile Membuat file di DataStudio. Anda tidak dapat memanggil operasi ini untuk membuat node Data Integration.
CreateResourceFile Membuat Resource File Mendukung pengguna dalam menentukan file sendiri (seperti JAR, PY, arsip, atau file) untuk membuat file resource Data Development.
CreateUdfFile CreateUdfFile Membuat file untuk fungsi di DataStudio.
UpdateFile UpdateFile Memperbarui file.
UpdateUdfFile UpdateUdfFile Memperbarui informasi file fungsi.
GetFile Mengambil Detail File Mengambil detail file.
ListFiles ListFiles Mengambil daftar file.
SubmitFile SubmitFile Mengirimkan file ke lingkungan pengembangan sistem penjadwalan untuk membuat tugas.
DeployFile DeployFile Publikasikan file ke lingkungan produksi.
Folder Folder
CreateFolder CreateFolder Membuat folder.
DeleteFolder DeleteFolder Menghapus folder di halaman Data Development.
UpdateFolder UpdateFolder Panggil UpdateFolder untuk memperbarui informasi folder.
GetFolder GetFolder Mengkueri informasi tentang sebuah folder.
ListFolders ListFolders Mengkueri daftar folder.
Proses bisnis Proses bisnis
CreateBusiness CreateBusiness Membuat alur kerja di DataStudio.
DeleteBusiness DeleteBusiness Menghapus alur kerja.
UpdateBusiness UpdateBusiness Memperbarui alur kerja.
GetBusiness GetBusiness Mengkueri informasi alur kerja.
ListBusiness ListBusiness Mengkueri daftar alur kerja.
Paket penerbitan Paket penerbitan
GetDeploymentPackage GetDeploymentPackage Mengkueri informasi tentang paket deployment.
ListDeploymentPackages ListDeploymentPackages Mengkueri daftar paket deployment.
ListDeploymentPackageFiles ListDeploymentPackageFiles Mengkueri daftar versi berkas yang akan di-deploy.
Versi file Versi file
GetFileVersion Memperoleh detail versi file Panggil GetFileVersion untuk memperoleh detail versi file.
ListFileVersions ListFileVersions Mengkueri daftar versi file.
Event titik ekstensi Event titik ekstensi
UpdateIDEEventResult UpdateIDEEventResult Memanggil kembali hasil pemeriksaan dari pesan acara titik ekstensi.
GetIDEEventDetail GetIDEEventDetail Mengkueri snapshot data extension point berdasarkan ID Paket di DataWorks OpenEvent saat event extension point terkait dipicu.
Tabel Tabel
EstablishRelationTableToBusiness EstablishRelationTableToBusiness Mengimpor tabel ke alur kerja. Pemanggilan operasi API ini setara dengan melakukan operasi berikut: Buka halaman DataStudio, temukan alur kerja yang diinginkan, lalu klik nama alur kerja. Klik kanan Table di bawah folder yang diinginkan dan pilih Import Table.

Integrasi data

API

Judul

Deskripsi

Tugas sinkronisasi Tugas sinkronisasi
CreateDIJob CreateDIJob Membuat versi baru dari tugas integrasi data.
UpdateDIJob UpdateDIJob Memperbarui tugas Integrasi Data.
DeleteDIJob DeleteDIJob Menghapus tugas sinkronisasi versi baru.
StopDIJob StopDIJob Menghentikan tugas sinkronisasi.
StartDIJob StartDIJob Memulai tugas sinkronisasi versi baru.
GetDIJob GetDIJob Melihat tugas integrasi data.
GetDIJobLog GetDIJobLog Memperoleh log yang dihasilkan untuk tugas sinkronisasi.
ListDIJobs ListDIJobs Menampilkan daftar pekerjaan Data Integration.
ListDIJobRunDetails ListDIJobRunDetails Mengkueri informasi berjalan tentang tugas sinkronisasi.
ListDIJobMetrics ListDIJobMetrics Mengkueri data deret waktu untuk tugas sinkronisasi.
ListDIJobEvents ListDIJobEvents Mengkueri peristiwa untuk tugas sinkronisasi.
Peringatan tugas Peringatan tugas
CreateDIAlarmRule CreateDIAlarmRule Membuat aturan peringatan untuk tugas sinkronisasi.
UpdateDIAlarmRule UpdateDIAlarmRule Memperbarui aturan peringatan yang dikonfigurasi untuk tugas sinkronisasi.
DeleteDIAlarmRule DeleteDIAlarmRule Menghapus aturan alert yang dikonfigurasi untuk tugas sinkronisasi.
ListDIAlarmRules ListDIAlarmRules Menampilkan aturan peringatan yang dikonfigurasi untuk tugas sinkronisasi.

Peta data

API

Judul

Deskripsi

Properti kustom Properti kustom
ListCustomAttributes ListCustomAttributes Mengambil daftar definisi atribut khusus.
GetCustomAttribute GetCustomAttribute Mengambil definisi atribut kustom.
CreateCustomAttribute CreateCustomAttribute Membuat definisi atribut kustom.
UpdateCustomAttribute UpdateCustomAttribute Memperbarui atribut khusus.
DeleteCustomAttribute DeleteCustomAttribute Menghapus definisi atribut kustom.
Definisi entitas metadata kustom Definisi entitas metadata kustom
ListMetaEntityDefs ListMetaEntityDefs Mengambil daftar definisi entitas kustom, termasuk tipe entitas kustom dan tipe tabel yang diperluas.
GetMetaEntityDef GetMetaEntityDef Mengambil detail definisi entitas kustom.
CreateMetaEntityDef CreateMetaEntityDef Membuat definisi entitas metadata. Definisi dapat berupa tipe khusus murni atau tipe tabel yang diperluas.
UpdateMetaEntityDef UpdateMetaEntityDef Memperbarui definisi entitas meta. Operasi ini mendukung jenis entitas tabel kustom maupun yang diperluas.
DeleteMetaEntityDef DeleteMetaEntityDef Menghapus definisi entitas metadata, termasuk tipe kustom murni dan tipe tabel yang diperluas.
Tipe pengumpul metadata Tipe pengumpul metadata
ListCrawlerTypes ListCrawlerTypes Mengkueri daftar tipe crawler metadata yang didukung di Peta Data. Subtipe dari tipe tersebut dan hubungan hierarkis antar subtipe juga dikembalikan.
Entitas metadata Entitas metadata
Entitas kustom Entitas kustom
ListMetaEntities ListMetaEntities Mencantumkan entitas metadata. Dukungan saat ini terbatas pada tipe kustom.
GetMetaEntity GetMetaEntity Mengambil detail entitas kustom.
BatchCreateMetaEntities BatchCreateMetaEntities Membuat entitas metadata secara batch. Semua entitas dalam satu batch harus memiliki tipe entitas yang sama. Operasi ini saat ini hanya mendukung tipe kustom dan tipe tabel yang diperluas, yang merepresentasikan database dan tabel.
UpdateMetaEntity UpdateMetaEntity Memperbarui entitas metadata. Anda dapat memperbarui entitas khusus atau objek tipe tabel terperluas, seperti database, tabel, dan kolom.
BatchDeleteMetaEntities BatchDeleteMetaEntities Menghapus beberapa entitas meta secara batch. Operasi ini menghapus entitas meta kustom dan objek berbasis tabel yang diperluas, seperti basis data dan tabel. Anda tidak dapat menghapus kolom secara individual. Sebagai gantinya, Anda harus menghapus seluruh tabel untuk menghapus kolom-kolom yang terkait.
Katalog data Katalog data
ListCatalogs ListCatalogs Mengkueri daftar katalog di Peta Data. Hanya katalog dengan tipe perayap metadata Data Lake Formation (DLF) dan StarRocks yang didukung. Untuk tipe perayap metadata DLF, semua katalog data yang didukung akan dikembalikan. Untuk tipe perayap metadata StarRocks, katalog data dalam instans tertentu akan dikembalikan.
GetCatalog GetCatalog Mengkueri informasi tentang katalog di Data Map. Hanya katalog dari crawler metadata Data Lake Formation (DLF) dan StarRocks yang didukung.
Database Database
ListDatabases ListDatabases Menanyakan daftar basis data dalam suatu instance, cluster, atau katalog data di Data Map. Untuk sumber data DLF atau StarRocks, Anda dapat memanggil operasi API ini untuk menanyakan basis data dalam katalog data. Untuk sumber data StarRocks, Anda dapat memanggil operasi API ini untuk menanyakan basis data dalam katalog internal. Untuk jenis sumber data lainnya, Anda dapat memanggil operasi API ini untuk menanyakan basis data dalam suatu instance atau cluster.
GetDatabase GetDatabase Mengkueri informasi tentang database tertentu di Peta Data.
Skema Skema
ListSchemas Kueri daftar skema database di Data Map Melakukan kueri daftar skema di bawah database atau proyek MaxCompute yang ditentukan di Data Map. Saat ini mendukung tipe MaxCompute dan Holo.
GetSchema GetSchema Mengambil detail skema tabel tertentu di Peta Data. Hanya skema MaxCompute dan Gudang Data Real-time yang didukung.
Tabel data Tabel data
ListTables Mengkueri tabel data di peta data. Mengkueri daftar tabel data di Peta Data DataWorks. Untuk tipe yang tidak mendukung level skema, Anda dapat mengkueri tabel data di bawah database tertentu. Untuk tipe yang mendukung level skema, Anda dapat mengkueri tabel data di bawah database, proyek MaxCompute, atau skema tertentu. Tanggapan hanya berisi informasi tabel dasar dan tidak menyertakan metadata teknis atau metadata bisnis.
GetTable Detail Tabel Data di Peta Data. Mengambil detail tabel data tertentu di Peta Data DataWorks. Apakah akan mengembalikan metadata bisnis.
UpdateTableBusinessMetadata UpdateTableBusinessMetadata Memperbarui metadata bisnis untuk tabel data di Peta Data. Anda hanya dapat memperbarui Readme dan atribut kustom tabel.
Bidang Bidang
ListColumns Mengkueri kolom tabel data di Peta Data. Mengkueri daftar kolom tabel data tertentu di DataWorks Peta Data.
GetColumn Mengambil informasi kolom tabel Peta Data. Mengambil detail kolom tertentu dalam tabel Peta Data.
UpdateColumnBusinessMetadata UpdateColumnBusinessMetadata Memperbarui metadata bisnis untuk kolom dalam peta data. Operasi ini hanya dapat memperbarui deskripsi bisnis dan atribut kustom.
Set data Set data
ListDatasets ListDatasets Meminta daftar kumpulan data. Saat ini, kumpulan data DataWorks dan kumpulan data PAI didukung.
GetDataset GetDataset Mendapatkan detail dataset.
CreateDataset CreateDataset Membuat dataset. Operasi ini hanya didukung di workspace yang telah diikuti oleh pengguna. Saat ini, hanya dataset DataWorks yang didukung. Jumlah maksimum dataset yang diizinkan per tenant adalah 2.000.
UpdateDataset UpdateDataset Memperbarui informasi set data. Hanya set data DataWorks yang didukung. Operator harus merupakan pembuat set data atau administrator ruang kerja tempat set data berada.
DeleteDataset DeleteDataset Hapus dataset. Hanya dataset DataWorks yang didukung. Operasi ini menghapus secara berjenjang semua versi dataset terkait. Memerlukan izin pembuat dataset atau administrator workspace.
Versi set data Versi set data
ListDatasetVersions ListDatasetVersions Mengambil daftar versi untuk dataset tertentu.
GetDatasetVersion GetDatasetVersion Mendapatkan informasi untuk versi dataset tertentu.
CreateDatasetVersion CreateDatasetVersion Membuat versi set data. Saat ini hanya mendukung set data DataWorks, dengan maksimum 20 versi.
UpdateDatasetVersion UpdateDatasetVersion Memperbarui informasi versi dataset. Hanya dataset DataWorks yang didukung. Memerlukan izin pembuat dataset atau administrator ruang kerja.
DeleteDatasetVersion DeleteDatasetVersion Menghapus versi dataset. Hanya dataset DataWorks non-v1 yang didukung. Untuk menghapus dataset v1, gunakan operasi DeleteDataset. Memerlukan izin pembuat dataset atau administrator ruang kerja.
PreviewDatasetVersion PreviewDatasetVersion Mempratinjau konten versi set data yang ditentukan. Saat ini hanya pratinjau file teks yang didukung untuk set data tipe OSS. Tipe MIME yang didukung 1. application/json 2. application/xml 3. text/html 4. text/plain 5. application/octet-stream
Partisi Partisi
ListPartitions ListPartitions Mengkueri daftar partisi dalam tabel di Data Map. Hanya tabel dari crawler metadata MaxCompute dan Hive Metastore Service (HMS) tipe E-MapReduce (EMR) yang didukung.
GetPartition GetPartition Mengambil detail partisi untuk tabel Peta Data. Saat ini hanya mendukung tipe MaxCompute dan HMS (kluster EMR).
Garis keturunan Garis keturunan
ListLineageRelationships ListLineageRelationships Mengkueri Peta Data untuk hubungan alur data antar entitas tertentu, seperti tabel, kolom, dan objek OSS.
GetLineageRelationship GetLineageRelationship Mengambil detail hubungan lineage tertentu di Peta Data.
DeleteLineageRelationship DeleteLineageRelationship Menghapus silsilah di Data Map.
CreateLineageRelationship Mendaftarkan hubungan lineage data di data map Mendaftarkan hubungan lineage data di DataWorks Data Map. Anda dapat menggunakan operasi ini untuk membuat hubungan lineage antara entitas metadata yang dikelola oleh DataWorks, termasuk skenario tabel-ke-tabel, kolom-ke-kolom, tabel-ke-kolom, dan dataset-ke-tabel. Anda juga dapat membuat hubungan lineage antara entitas terkelola dan objek entitas kustom yang didaftarkan oleh pengguna. Operasi ini kompatibel dengan objek kustom non-terkelola, tetapi pendekatan ini tidak lagi direkomendasikan. Sebelum memanggil operasi ini, pastikan entitas terkelola yang terlibat dalam pendaftaran lineage sudah ada di platform DataWorks.
ListLineages ListLineages Mengkueri entitas hulu dan hilir untuk entitas tertentu di Data Map. Anda dapat secara opsional menyertakan informasi hubungan silsilah (lineage) yang terperinci.
Pengumpulan metadata Pengumpulan metadata
ListMetaCollections ListMetaCollections Mengkueri daftar koleksi di Peta Data. Koleksi mencakup kategori dan album data.
CreateMetaCollection CreateMetaCollection Membuat koleksi di Peta Data. Koleksi mencakup kategori, subkategori, album data, dan kategori yang dibuat di album data.
GetMetaCollection GetMetaCollection Mengkueri informasi tentang koleksi di Peta Data. Koleksi mencakup kategori dan album data.
UpdateMetaCollection Perbarui Objek Koleksi Data Map Perbarui objek koleksi Data Map, termasuk kategori Data Map dan album data. Anda dapat memperbarui nama koleksi, deskripsi, dan informasi administrator. Saat memperbarui album data, pemanggil harus memiliki izin AliyunDataWorksFullAccess atau merupakan pembuat atau administrator album tersebut.
DeleteMetaCollection Menghapus objek koleksi Data Map Menghapus objek koleksi di Data Map yang ditentukan, termasuk kategori Data Map dan album data. Saat menghapus album data, pemanggil harus memiliki izin AliyunDataWorksFullAccess atau merupakan pembuat atau administrator album tersebut.
ListEntitiesInMetaCollection ListEntitiesInMetaCollection Mengkueri daftar entitas dalam koleksi di Peta Data. Koleksi mencakup kategori dan album data. Entitas hanya dapat berupa tabel.
AddEntityIntoMetaCollection AddEntityIntoMetaCollection Menambahkan entitas ke koleksi di Data Map. Koleksi mencakup kategori dan album data. Entitas hanya dapat berupa tabel. Jika Anda ingin menambahkan entitas ke album data, akun yang Anda gunakan harus dilampirkan kebijakan AliyunDataWorksFullAccess, atau Anda adalah pembuat atau administrator album data.
RemoveEntityFromMetaCollection Hapus objek entitas dari koleksi Data Map Hapus objek entitas dari koleksi Data Map. Koleksi ini mendukung kategori Data Map dan album data, dan entitas saat ini hanya mendukung tipe Data Table. Saat menghapus entitas dari album data, pemanggil harus memiliki izin AliyunDataWorksFullAccess atau merupakan pembuat atau administrator album tersebut.

Pusat O&M

API

Judul

Deskripsi

Parameter Parameter
CreateParameter CreateParameter Membuat parameter.
DeleteParameter DeleteParameter Menghapus parameter tertentu.
UpdateParameter UpdateParameter Memperbarui parameter. Operasi ini melakukan pembaruan inkremental dan hanya memodifikasi bidang yang ditentukan.
RollbackParameter RollbackParameter Mengembalikan parameter yang ditentukan ke versi sebelumnya.
GetParameter GetParameter Mendapatkan detail parameter berdasarkan ID-nya.
ListParameters ListParameters Parameter kueri.
ListParameterVersions ListParameterVersions Mencantumkan versi parameter.
Pemantauan dan peringatan Pemantauan dan peringatan
ListAlertRules ListAlertRules Mengkueri daftar aturan peringatan pemantauan kustom.
GetAlertRule GetAlertRule Mengkueri aturan pemantauan peringatan kustom.
UpdateAlertRule UpdateAlertRule Memperbarui informasi tentang aturan pemantauan peringatan khusus.
DeleteAlertRule DeleteAlertRule Menghapus aturan peringatan pemantauan kustom.
CreateAlertRule CreateAlertRule Membuat aturan peringatan pemantauan kustom.
Node Node
DeleteTask DeleteTask Menghapus tugas.
UpdateTask Memperbarui node. Memperbarui node tertentu. Modifikasi disinkronkan ke DataStudio, di mana versi tersimpan baru dibuat.
BatchUpdateTasks Pembaruan batch tugas Melakukan pembaruan inkremental pada beberapa tugas sekaligus.
GetTask GetTask Mengkueri informasi tugas.
ListTasks ListTasks Mengkueri daftar task per halaman. Anda juga dapat menentukan kondisi filter untuk mengkueri task.
ListUpstreamTasks ListUpstreamTasks Mengkueri daftar tugas hulu suatu tugas per halaman.
ListDownstreamTasks Daftar Tugas Downstream Mengkueri daftar tugas turunan suatu tugas per halaman.
ListTaskOperationLogs ListTaskOperationLogs Mengambil daftar log operasi yang dipaginasi untuk sebuah tugas.
Instans node Instans node
UpdateTaskInstances Ubah Properti Instance Tugas Ubah properti beberapa instance tugas secara batch, termasuk prioritas, grup sumber daya, sumber data, dan lainnya.
GetTaskInstance GetTaskInstance Mengkueri informasi tentang sebuah instance.
GetTaskInstanceLog GetTaskInstanceLog Mengkueri log run yang dihasilkan selama run tertentu pada instans.
ListTaskInstances ListTaskInstances Mengkueri daftar instans. Anda juga dapat menentukan kondisi filter untuk mengkueri instans tertentu.
ListUpstreamTaskInstances Daftar Instans Tugas Upstream Mengkueri daftar instans upstream suatu instans per halaman.
ListTaskInstanceOperationLogs Daftar Log Operasi Instans Tugas Mengambil daftar log operasi berhalaman untuk instans tugas.
ListDownstreamTaskInstances ListDownstreamTaskInstances Membuat kueri daftar instans turunan dari sebuah instans per halaman.
SuspendTaskInstances Menangguhkan Instans Tugas Menangguhkan beberapa instans pada satu pengatur waktu.
ResumeTaskInstances Melanjutkan Instans Tugas Melanjutkan beberapa instans yang ditangguhkan per pengatur waktu.
StopTaskInstances StopTaskInstances Menghentikan beberapa instans pada pengatur waktu.
SetSuccessTaskInstances SetSuccessTaskInstances Mengatur status beberapa instans menjadi berhasil pada satu pengatur waktu.
RerunTaskInstances Rerun node instances. Menjalankan ulang beberapa instans node secara batch.
RemoveTaskInstanceDependencies RemoveTaskInstanceDependencies Menghapus beberapa dependensi hulu dari sebuah instans sekaligus.
TriggerSchedulerTaskInstance TriggerSchedulerTaskInstance Memicu tugas untuk berjalan menggunakan node Pemicu HTTP pada pengatur waktu yang ditentukan.
Alur kerja Alur kerja
DeleteWorkflow DeleteWorkflow Menghapus alur kerja.
Instans alur kerja Instans alur kerja
GetRerunWorkflowInstancesResult Hasil Instans Alur Kerja yang Dijalankan Ulang Mengkueri hasil instans alur kerja yang dijalankan ulang secara asinkron.
RerunWorkflowInstances Jalankan ulang instance alur kerja Jalankan ulang instance alur kerja
CreateWorkflowInstances CreateWorkflowInstances Membuat instance alur kerja, seperti instance alur kerja pengisian ulang data, berdasarkan konfigurasi.
GetCreateWorkflowInstancesResult GetCreateWorkflowInstancesResult Menanyakan hasil pembuatan instance workflow secara asinkron.
GetWorkflowInstance GetWorkflowInstance Mengkueri informasi instans alur kerja.
ListWorkflowInstances ListWorkflowInstances Mengembalikan daftar instans alur kerja berhalaman yang dapat difilter berdasarkan kriteria tertentu.
StartWorkflowInstances Mulai Instance Alur Kerja Mulai beberapa instance alur kerja secara batch.
StopWorkflowInstances StopWorkflowInstances Menghentikan beberapa instans alur kerja pada satu pengatur waktu.
ExecuteAdhocWorkflowInstance ExecuteAdhocWorkflowInstance Membuat instance workflow sementara berdasarkan konfigurasi.

Kualitas data

API

Judul

Deskripsi

Templat aturan kualitas data Templat aturan kualitas data
CreateDataQualityTemplate CreateDataQualityTemplate Membuat templat kualitas data.
UpdateDataQualityTemplate Memperbarui templat aturan kualitas data Memperbarui templat aturan kualitas data dalam suatu proyek.
ListDataQualityTemplates ListDataQualityTemplates Mengkueri daftar template aturan kualitas data dalam sebuah proyek.
GetDataQualityTemplate GetDataQualityTemplate Mengambil detail templat aturan kualitas data berdasarkan ID templat.
DeleteDataQualityTemplate DeleteDataQualityTemplate Menghapus template aturan kualitas data berdasarkan ID.
Pemantauan kualitas data Pemantauan kualitas data
CreateDataQualityScan CreateDataQualityScan Membuat monitor kualitas data.
UpdateDataQualityScan UpdateDataQualityScan Memperbarui monitor kualitas data.
ListDataQualityScans ListDataQualityScans Mengkueri daftar tugas pemindaian kualitas data dalam sebuah proyek.
GetDataQualityScan GetDataQualityScan Mendapatkan detail pemantauan kualitas data.
DeleteDataQualityScan DeleteDataQualityScan Menghapus monitor kualitas data.
Aturan peringatan Aturan peringatan
CreateDataQualityAlertRule CreateDataQualityAlertRule Membuat aturan peringatan pemantauan Kualitas Data di Proyek.
UpdateDataQualityAlertRule UpdateDataQualityAlertRule Memperbarui aturan peringatan pemantauan kualitas data yang ditentukan.
ListDataQualityAlertRules ListDataQualityAlertRules Mengkueri daftar aturan pemberitahuan peringatan kualitas data dalam sebuah proyek.
GetDataQualityAlertRule GetDataQualityAlertRule Mengambil detail aturan peringatan kualitas data berdasarkan ID aturan.
DeleteDataQualityAlertRule Menghapus Aturan Peringatan Kualitas Data Menghapus aturan peringatan kualitas data berdasarkan ID.
Eksekusi kualitas data Eksekusi kualitas data
CreateDataQualityScanRun CreateDataQualityScanRun Memicu pemindaian Kualitas Data tertentu dan mengembalikan ID run.
ListDataQualityScanRuns ListDataQualityScanRuns Mengkueri riwayat eksekusi pemindaian kualitas data di proyek tertentu.
GetDataQualityScanRunLog GetDataQualityScanRunLog Mengkueri log instans tugas tertentu yang memantau kualitas data.
GetDataQualityScanRun Mendapatkan Run Pemindaian Kualitas Data Membuat instans run pemantauan Kualitas Data.

Pusat keamanan

API

Judul

Deskripsi

Permintaan dan persetujuan izin Permintaan dan persetujuan izin
ApplyResourceAccessPermission Mengajukan Aplikasi Izin Akses Sumber daya Mengajukan aplikasi izin akses pada Sumber daya tertentu.
StopProcessInstance StopProcessInstance Menarik atau menghentikan instans proses tertentu.
ApproveProcessInstance Menyetujui Instans Alur Kerja Menyetujui atau menolak instans proses persetujuan tertentu.
GetApplicationContents Mendapatkan Detail Aplikasi Izin Resource Mengkueri konten aplikasi izin sumber daya berdasarkan ID instans proses yang ditentukan.
GetProcessInstance GetProcessInstance Mengambil detail instans proses persetujuan tertentu, termasuk node persetujuan dan daftar tugasnya.
ListPendingApprovals Query Pending Permission Request Orders Mengambil daftar pesanan permintaan izin tertunda yang penyetujuannya adalah pengguna saat ini.
ListMyRelatedApprovals Mengkueri Pesanan Aplikasi Izin Terkait Saya Mengkueri semua pesanan aplikasi izin tempat pengguna saat ini adalah penyetuju atau pemangku kepentingan.
ListMyApplications Mengkueri Pesanan Aplikasi Izin yang Diinisiasi oleh Saya Mengkueri semua pesanan aplikasi izin akses sumber daya yang diinisiasi oleh pengguna saat ini.
Kebijakan kontrol hasil kueri Kebijakan kontrol hasil kueri
CreateSecurityStrategy CreateSecurityStrategy Membuat kebijakan kontrol keamanan baru untuk mengonfigurasi berbagai modul dan submodul. Memerlukan izin administrator penyewa DataWorks dan administrator keamanan.
DeleteSecurityStrategy DeleteSecurityStrategy Menghapus strategi keamanan berdasarkan ID-nya. Untuk memanggil operasi ini, Anda harus memiliki izin administrator penyewa DataWorks dan administrator keamanan.
UpdateSecurityStrategy UpdateSecurityStrategy Untuk mengubah konfigurasi kebijakan keamanan yang sudah ada, Anda harus menjadi administrator tenant DataWorks sekaligus administrator keamanan.
GetSecurityStrategy GetSecurityStrategy Mengambil detail kebijakan keamanan berdasarkan ID-nya. Operasi ini memerlukan izin administrator tenant DataWorks sekaligus administrator keamanan.
ListSecurityStrategies ListSecurityStrategies Mengambil daftar kebijakan keamanan berhalaman berdasarkan kondisi yang ditentukan. Operasi ini memerlukan izin administrator penyewa DataWorks atau administrator keamanan.
FindBestMatchSecurityStrategy Cocokkan Kebijakan Keamanan Terbaik Temukan kebijakan keamanan yang paling cocok dengan kondisi yang diberikan.
Kebijakan persetujuan Kebijakan persetujuan
CreateProcessDefinition CreateApprovalProcessDefinition Membuat definisi proses persetujuan baru, mendukung konfigurasi kustom aturan persetujuan dan layanan notifikasi.
DeleteProcessDefinition DeleteProcessDefinition Menghapus definisi proses berdasarkan ID yang ditentukan.
EnableProcessDefinition Mengaktifkan Definisi Proses Mengaktifkan definisi proses dengan ID yang ditentukan.
DisableProcessDefinition DisableProcessDefinition Menonaktifkan definisi proses persetujuan tertentu.
UpdateProcessDefinition UpdateProcessDefinition Memperbarui definisi proses persetujuan yang ada.
GetProcessDefinition GetProcessDefinition Mengambil kebijakan persetujuan untuk ID definisi proses tertentu.
ListProcessDefinitions ListProcessDefinitions Mengkueri definisi proses tipe tertentu.
CreateIdentifyCredential Membuat Kredensial Identitas Membuat kredensial identitas.

Manajemen tag

API

Judul

Deskripsi

CreateDataAssetTag CreateDataAssetTag Membuat tag.
DeleteDataAssetTag DeleteDataAssetTag Menghapus tag.
UpdateDataAssetTag UpdateDataAssetTag Memperbarui tag.
ListDataAssetTags ListDataAssetTags Mengkueri daftar tag.
TagDataAssets TagDataAssets Menambahkan tag ke aset data.
UnTagDataAssets UnTagDataAssets Menghapus tag dari aset data.
ListDataAssets Query aset data yang dikaitkan dengan tag. Mengkueri aset data DataWorks yang dikaitkan dengan tag secara berhalaman.

Platform terbuka

API

Judul

Deskripsi

GetJobStatus GetJobStatus Mengkueri informasi status Tugas asinkron. Setelah Anda memanggil operasi asinkron, Tugas asinkron akan dibuat. Anda dapat memanggil operasi GetJobStatus untuk mengkueri status Tugas asinkron.

Lainnya

API

Judul

Deskripsi

ListDataQualityEvaluationTasks Mendapatkan Daftar Tugas Pemantauan Kualitas Mendaftar node pemantauan kualitas melalui kueri paging.
ListDataQualityRules Melakukan kueri daftar aturan kualitas data. Kueri berhalaman dari aturan pemantauan kualitas data.
ListDataQualityEvaluationTaskInstances Membuat kueri daftar instance tugas pemantauan kualitas Melakukan kueri terpaginasi pada daftar instance tugas pemantauan kualitas.
ListDataQualityResults Mengkueri Hasil Kualitas Data Mengkueri daftar hasil kualitas data menggunakan paging.
DetachDataQualityRulesFromEvaluationTask Hapus asosiasi antara aturan kualitas data dan tugas pemantauan Menghapus asosiasi antara aturan kualitas data dan tugas pemantauan kualitas data.
DeleteDataQualityEvaluationTask Menghapus monitor kualitas data Menghapus tugas pemantauan kualitas data.
GetDataQualityEvaluationTaskInstance Mengambil detail instans tugas pemeriksaan kualitas data. Mengambil detail dari sebuah instans tugas pemeriksaan kualitas data.
GetDataQualityEvaluationTask Detail Pemantauan Kualitas Data Mengkueri detail tugas validasi Kualitas Data.
AttachDataQualityRulesToEvaluationTask Kaitkan aturan kualitas data dengan task pemantauan kualitas data Mengaitkan aturan kualitas data dengan task pemantauan kualitas data.
UpdateDataQualityEvaluationTask Perbarui pemantauan kualitas data Memperbarui tugas validasi kualitas data.
CreateDataQualityEvaluationTaskInstance Membuat instans pemantauan evaluasi kualitas data Membuat instans tugas evaluasi kualitas data.
CreateDataQualityEvaluationTask Buat Monitor Kualitas Data Membuat monitor kualitas data DataWorks.
DeleteDataQualityRule DeleteDataQualityRule Menghapus aturan pemantauan kualitas data.
UpdateDataQualityRuleTemplate Memperbarui templat aturan kualitas data Memperbarui templat aturan kualitas data.
CreateDataQualityRuleTemplate Membuat Templat Aturan Kualitas Data Membuat templat aturan.
DeleteDataQualityRuleTemplate Menghapus template aturan kualitas data kustom Menghapus template aturan kualitas data kustom.
GetDataQualityRuleTemplate Mengkueri detail templat aturan kualitas data. Mengkueri detail templat aturan kualitas data.
CreateDataQualityRule Membuat aturan kualitas data Membuat aturan kualitas data.
UpdateDataQualityRule Memperbarui aturan kualitas data Memperbarui aturan kualitas data.
GetDataQualityRule Mengkueri detail aturan kualitas data Mengkueri detail aturan kualitas data.
ListDataQualityRuleTemplates Mengkueri Daftar Templat Aturan Kualitas Data Mengkueri daftar templat aturan kualitas data.
DeleteCertificate DeleteCertificate Menghapus file sertifikat.
GetCertificate GetCertificate Membuat kueri detail file sertifikat.
GetDataSource GetDataSource Mengambil detail sumber data berdasarkan ID sumber data.
ImportCertificate ImportCertificate Mengimpor file sertifikat.
ListCertificates ListCertificates Mengambil daftar file sertifikat.
DeleteFile DeleteFile Menghapus file dari DataStudio. Jika file telah di-commit, proses asinkron dipicu untuk menghapus file di sistem penjadwalan. Nilai parameter DeploymentId yang dikembalikan digunakan untuk memanggil operasi GetDeployment guna melakukan polling status proses asinkron tersebut.
GetWorkflow GetWorkflow Mengkueri informasi alur kerja.
ListWorkflows ListWorkflows Mengambil daftar alur kerja per halaman. Anda juga dapat menentukan kondisi filter untuk mengambil alur kerja.
UpdateWorkflow Memperbarui alur kerja. Memperbarui alur kerja tertentu dengan menggunakan metode pembaruan penuh. Bidang yang dapat diperbarui secara asinkron ke DataStudio meliputi: pemilik, sumber data, kelompok sumber daya penjadwalan, deskripsi, dan mode jalankan pemicu (Normal, Lewati, atau Jeda).