Gunakan GetIDEEventDetail untuk kueri snapshot data dari event titik ekstensi-DataWorks-Alibaba Cloud

Mengambil snapshot data dari titik ekstensi berdasarkan ID pesan di DataWorks OpenEvent saat event titik ekstensi dipicu.

Deskripsi operasi

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter	Type	Required	Description	Example
MessageId	string	Yes	ID pesan di DataWorks OpenEvent. Anda dapat memperoleh ID tersebut dari pesan yang diterima saat event titik ekstensi dipicu.	8abcb91f-d266-4073-b907-2ed67****1
ProjectId	integer	Yes	ID ruang kerja DataWorks. Anda dapat memperoleh ID tersebut dari pesan.	10000

Elemen respons

Element	Type	Description	Example
	object	Respons.
RequestId	string	ID permintaan.	8abcb91f-d266-4073-b907-2ed670378ed1
EventDetail	object	Snapshot data yang dihasilkan saat event titik ekstensi dipicu. Bidang yang terdapat dalam snapshot data bervariasi tergantung pada jenis event titik ekstensi yang dipicu. Untuk informasi lebih lanjut, lihat deskripsi bidang tersebut.
FileExecutionCommand	object	Snapshot data saat kode dalam file dijalankan. Parameter ini hanya berlaku jika tipe pesan adalah IDE_FILE_EXECUTE_BEFORE.
FileId	integer	ID file.	1234123
DataSourceName	string	Nama sumber data tempat file tersebut terkait.	odps_source
Content	string	Kode dalam file versi saat ini.	SHOW TABLES;
FileType	integer	Tipe kode untuk file tersebut. Kode file bervariasi tergantung pada tipe file. Untuk informasi lebih lanjut, lihat node DataWorks.	10
DeletedFile	object	Snapshot data saat file dihapus. Parameter ini hanya berlaku jika tipe pesan adalah IDE_FILE_DELETE_BEFORE.
Owner	string	Pemilik file.	7384234****
FileType	integer	Tipe kode untuk file tersebut. Kode file bervariasi tergantung pada tipe file. Untuk informasi lebih lanjut, lihat node DataWorks.	10
CurrentVersion	integer	Nomor versi terbaru dari file tersebut.	1
BusinessId	integer	ID alur kerja tempat file tersebut berada.	74328
FileName	string	Nama file.	hello_dataworks.sql
DataSourceName	string	Nama sumber data tempat file tersebut terkait.	odps_source
UseType	string	Modul tempat file tersebut berada. Nilai yang valid: NORMAL: File digunakan untuk DataStudio. MANUAL: File digunakan untuk node yang dipicu secara manual. MANUAL_BIZ: File digunakan untuk alur kerja yang dipicu secara manual. SKIP: File digunakan untuk node DataStudio simulasi kering. ADHOCQUERY: File digunakan untuk kueri ad hoc. COMPONENT: File digunakan untuk cuplikan.	NORMAL
FolderId	string	ID folder tempat file tersebut berada. Anda dapat memanggil operasi GetFolder untuk menanyakan detail file berdasarkan ID folder.	aldurie78l2falure
ParentFileId	integer	ID node do-while atau node for-each yang sesuai dengan file tersebut.	1234122
Content	string	Kode dalam file versi saat ini.	SHOW TABLES;
NodeId	integer	ID node yang dijadwalkan.	421429
FileId	integer	ID file.	1234123
CommittedFile	object	Snapshot data saat file dikomit dan dideploy. Parameter ini hanya berlaku jika tipe pesan adalah IDE_FILE_SUBMIT_BEFORE atau IDE_FILE_DEPLOY_BEFORE.
FileId	integer	ID file.	1234123
Content	string	Kode dalam file versi saat ini.	SHOW TABLES;
Committor	string	ID Akun Alibaba Cloud yang digunakan untuk menghasilkan file versi saat ini.	7384234****
FileType	integer	Tipe kode untuk file tersebut. Kode file bervariasi tergantung pada tipe file. Untuk informasi lebih lanjut, lihat node DataWorks.	10
ChangeType	string	Tipe perubahan pada file versi saat ini. Nilai yang valid: CREATE, UPDATE, dan DELETE.	UPDATE
FileName	string	Nama file.	hello_dataworks.sql
NodeId	integer	ID node yang dijadwalkan.	421429
Comment	string	Deskripsi versi file.	Second version submission
UseType	string	Modul tempat file tersebut berada. Nilai yang valid: NORMAL: File digunakan untuk DataStudio. MANUAL: File digunakan untuk node yang dipicu secara manual. MANUAL_BIZ: File digunakan untuk alur kerja yang dipicu secara manual. SKIP: File digunakan untuk node DataStudio simulasi kering. ADHOCQUERY: File digunakan untuk kueri ad hoc. COMPONENT: File digunakan untuk cuplikan.	NORMAL
FilePropertyContent	object	Detail file.
DataSourceName	string	Nama sumber data tempat file tersebut terkait.	odps_source
ParentFileId	integer	ID node do-while atau node for-each yang sesuai dengan file tersebut.	1234122
BusinessId	integer	ID alur kerja tempat file tersebut berada.	74328
CurrentVersion	integer	Nomor versi terbaru dari file tersebut.	1
Owner	string	Pemilik file.	7384234****
FolderId	string	ID folder tempat file tersebut berada. Anda dapat memanggil operasi GetFolder untuk menanyakan detail file berdasarkan ID folder.	aldurie78l2falure
NodeConfiguration	object	Properti penjadwalan node yang sesuai dengan file tersebut.
RerunMode	string	Menunjukkan apakah node yang sesuai dengan file dapat dijalankan ulang. Nilai yang valid: ALL_ALLOWED: Node dapat dijalankan ulang terlepas dari keberhasilan atau kegagalannya. FAILURE_ALLOWED: Node hanya dapat dijalankan ulang setelah gagal dijalankan. ALL_DENIED: Node tidak dapat dijalankan ulang terlepas dari keberhasilan atau kegagalannya. Parameter ini sesuai dengan parameter Rerun di bagian Schedule pada tab Properties di Konsol DataWorks.	ALL_ALLOWED
SchedulerType	string	Tipe penjadwalan node. Nilai yang valid: NORMAL: Node adalah node yang dipicu secara otomatis. MANUAL: Node adalah node yang dipicu secara manual. Node yang dipicu secara manual tidak dapat dipicu secara otomatis. Node ini sesuai dengan node di panel Alur Kerja yang Dipicu Secara Manual. PAUSE: Node adalah node yang dijeda. SKIP: Node adalah node simulasi kering. Node simulasi kering dimulai sesuai jadwal, tetapi sistem mengatur status node menjadi berhasil saat mulai menjalankannya.	NORMAL
ParaValue	string	Parameter penjadwalan node. Parameter ini sesuai dengan bagian Scheduling Parameter pada tab Properties di Konsol DataWorks. Untuk informasi lebih lanjut tentang konfigurasi parameter penjadwalan, lihat Konfigurasikan parameter penjadwalan.	a=x b=y
CycleType	string	Tipe siklus penjadwalan node yang sesuai dengan file tersebut. Nilai yang valid: NOT_DAY dan DAY. Nilai NOT_DAY menunjukkan bahwa node dijadwalkan berjalan per menit atau jam. Nilai DAY menunjukkan bahwa node dijadwalkan berjalan per hari, minggu, atau bulan. Parameter ini sesuai dengan parameter Scheduling Cycle di bagian Schedule pada tab Properties di Konsol DataWorks.	DAY
DependentNodeIdList	string	ID node tempat node yang sesuai dengan file bergantung ketika parameter DependentType diatur ke USER_DEFINE. Beberapa ID dipisahkan dengan koma (,). Nilai parameter ini setara dengan ID node yang Anda tentukan setelah memilih Other Nodes untuk Cross-Cycle Dependency (Original Previous-Cycle Dependency) di bagian Dependencies pada tab Properties di Konsol DataWorks.	5,10,15,20
ResourceGroupId	integer	ID kelompok sumber daya yang digunakan untuk menjalankan node yang sesuai dengan file tersebut. Anda dapat memanggil operasi ListResourceGroups untuk menanyakan kelompok sumber daya yang tersedia di ruang kerja.	375827434852437
AutoRerunTimes	integer	Jumlah kali node yang sesuai dengan file dapat dijalankan ulang.	3
AutoRerunIntervalMillis	integer	Interval pengulangan node yang sesuai dengan file. Satuan: milidetik.	120000
CronExpress	string	Ekspresi CRON yang digunakan untuk menjadwalkan node yang sesuai dengan file tersebut.	00 05 00 * * ?
InputList	array<object>	Nama output file induk tempat file saat ini bergantung.
	object	Informasi output file induk tempat file saat ini bergantung.
Input	string	Nama output file induk tempat file saat ini bergantung. Parameter ini sesuai dengan parameter Output Name of Ancestor Node di bawah Parent Nodes di bagian Dependencies pada tab Properties di Konsol DataWorks.	dw_project_root
ParseType	string	Mode dependensi file konfigurasi. Nilai yang valid: MANUAL: Dependensi penjadwalan dikonfigurasi secara manual. AUTO: Dependensi penjadwalan diurai secara otomatis.	MANUAL
OutputList	array<object>	Nama output file saat ini. Parameter ini sesuai dengan parameter Output Name of Current Node di bagian Dependencies pada tab Properties di Konsol DataWorks.
	object	Informasi output file saat ini.
RefTableName	string	Nama tabel output file saat ini. Parameter ini sesuai dengan parameter Output Table Name di bawah Output Name of Current Node di bagian Dependencies pada tab Properties di Konsol DataWorks.	ods_user_info_d
Output	string	Nama output file saat ini. Parameter ini sesuai dengan parameter Output Name di bawah Output Name of Current Node di bagian Dependencies pada tab Properties di Konsol DataWorks.	dw_project.002_out
DependentType	string	Tipe dependensi penjadwalan lintas siklus node. Nilai yang valid: SELF: Instans yang dihasilkan untuk node dalam siklus saat ini bergantung pada instans yang dihasilkan untuk node dalam siklus sebelumnya. CHILD: Instans yang dihasilkan untuk node dalam siklus saat ini bergantung pada instans yang dihasilkan untuk node turunan di level terdekat dalam siklus sebelumnya. USER_DEFINE: Instans yang dihasilkan untuk node dalam siklus saat ini bergantung pada instans yang dihasilkan untuk satu atau beberapa node tertentu dalam siklus sebelumnya. NONE: Tidak ada tipe dependensi penjadwalan lintas siklus yang dipilih untuk node tersebut.	USER_DEFINE
TableModel	object	Snapshot data saat tabel dikomit dan dideploy. Parameter ini hanya berlaku jika tipe pesan adalah IDE_TABLE_SUBMIT_BEFORE atau IDE_TABLE_DEPLOY_BEFORE.
Env	string	Lingkungan tempat tabel digunakan. Nilai yang valid: DEV PROD	DEV
LifeCycle	integer	Siklus hidup metatable. Satuan: hari.	7
TableName	string	Nama tabel.	tb_hello
DataSourceName	string	Nama sumber data tempat tabel tersebut berada.	odps_source
Columns	array<object>	Kolom dalam tabel.
	object	Kolom dalam tabel.
ColumnName	string	Nama kolom.	ID
ColumnType	string	Tipe data kolom.	BIGINT
IsPartitionColumn	boolean	Menunjukkan apakah kolom tersebut merupakan kolom kunci partisi. Nilai yang valid: true: Kolom tersebut adalah kolom kunci partisi. false: Kolom tersebut bukan kolom kunci partisi.	false
Comment	string	Keterangan kolom.	ID
Comment	string	Keterangan tabel.	A new table
Location	string	Jalur tabel.	hdfs://path/to/object

Contoh

Respons sukses

JSONformat

{
  "RequestId": "8abcb91f-d266-4073-b907-2ed670378ed1",
  "EventDetail": {
    "FileExecutionCommand": {
      "FileId": 1234123,
      "DataSourceName": "odps_source",
      "Content": "SHOW TABLES;",
      "FileType": 10
    },
    "DeletedFile": {
      "Owner": "7384234****",
      "FileType": 10,
      "CurrentVersion": 1,
      "BusinessId": 74328,
      "FileName": "hello_dataworks.sql",
      "DataSourceName": "odps_source",
      "UseType": "NORMAL",
      "FolderId": "aldurie78l2falure",
      "ParentFileId": 1234122,
      "Content": "SHOW TABLES;",
      "NodeId": 421429,
      "FileId": 1234123
    },
    "CommittedFile": {
      "FileId": 1234123,
      "Content": "SHOW TABLES;",
      "Committor": "7384234****",
      "FileType": 10,
      "ChangeType": "UPDATE",
      "FileName": "hello_dataworks.sql",
      "NodeId": 421429,
      "Comment": "Second version submission",
      "UseType": "NORMAL",
      "FilePropertyContent": {
        "DataSourceName": "odps_source",
        "ParentFileId": 1234122,
        "BusinessId": 74328,
        "CurrentVersion": 1,
        "Owner": "7384234****",
        "FolderId": "aldurie78l2falure"
      },
      "NodeConfiguration": {
        "RerunMode": "ALL_ALLOWED",
        "SchedulerType": "NORMAL",
        "ParaValue": "a=x b=y",
        "CycleType": "DAY",
        "DependentNodeIdList": "5,10,15,20",
        "ResourceGroupId": 375827434852437,
        "AutoRerunTimes": 3,
        "AutoRerunIntervalMillis": 120000,
        "CronExpress": "00 05 00 * * ?",
        "InputList": [
          {
            "Input": "dw_project_root",
            "ParseType": "MANUAL"
          }
        ],
        "OutputList": [
          {
            "RefTableName": "ods_user_info_d",
            "Output": "dw_project.002_out"
          }
        ],
        "DependentType": "USER_DEFINE"
      }
    },
    "TableModel": {
      "Env": "DEV",
      "LifeCycle": 7,
      "TableName": "tb_hello",
      "DataSourceName": "odps_source",
      "Columns": [
        {
          "ColumnName": "ID",
          "ColumnType": "BIGINT",
          "IsPartitionColumn": false,
          "Comment": "ID"
        }
      ],
      "Comment": "A new table",
      "Location": "hdfs://path/to/object"
    }
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InternalError.UserId.Missing	An internal system error occurred. Try again later.
500	InternalError.System	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.