Modul SiemplifyJob

class SiemplifyJob.SiemplifyJob

Dasar: Siemplify

Endpoint: external/v1/sdk/GetFailedETLOperations

extract_job_param

extract_job_param(param_name, default_value=None, input_type=<class 'str'>, is_mandatory=False, print_value=False)

Mendapatkan parameter konfigurasi dari instance integrasi.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
param_name	{string}	Nama parameter yang akan diambil	T/A	T/A
default_value	{any}	Nilai default parameter		(Opsional) Nilai yang diberikan akan ditampilkan jika parameter tidak ditetapkan (jika is_mandatory ditetapkan ke False). None secara default
input_type	{obj}	Jenis parameter	T/A	(Opsional) Nilai yang ditampilkan akan di-cast ke jenis input yang dipilih. {str} secara default
is_mandatory	{boolean}	Menentukan apakah parameter wajib diisi	T/A	(Opsional) Jika disetel ke True dan parameter tidak diisi, pengecualian akan dimunculkan. False secara default
print_value	{boolean}	Menentukan apakah akan menampilkan nilai parameter yang diambil ke log.	T/A	(Opsional) False secara default

Hasil

Nilai parameter, string secara default, kecuali jika input_type ditentukan.

Contoh

from SiemplifyJob import SiemplifyJob
siemplify = SiemplifyJob()
param_value= siemplify.extract_job_param(
                                       "Logs Folder",
                                       default_value="C:\\Siemplify_Server\\Scripting\\JobLogs",
                                       input_type=str,
                                       is_mandatory=False,
                                       print_value=False)

Perilaku hasil

Nilai parameter yang dipilih akan ditampilkan, ditransmisikan ke jenis yang dipilih.

Nilai hasil

C:\Siemplify_Server\Scripting\SampleJob\Logs

fetch_and_save_timestamp

fetch_and_save_timestamp(datetime_format=False, timezone=False, new_timestamp=1683034181430)

Ambil stempel waktu dan simpan ke konteks kasus.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
datetime_format	{boolean}	Format untuk tanggal/waktu	True untuk mendapatkan format tanggal dan waktu, False untuk Unix	False secara default (opsional)
zona waktu	Parameter tidak didukung lagi
new_timestamp	{int}	Stempel waktu yang akan disimpan	T/A	Waktu epoch Unix secara default (opsional)

fetch_timestamp

fetch_timestamp(datetime_format=False, timezone=False)

Dapatkan stempel waktu yang disimpan dengan save_timestamp.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
datetime_format	{boolean}	Jika True, menampilkan stempel waktu sebagai datetime. Jika tidak, tampilkan dalam Unix	Benar/Salah	False secara default (opsional)
zona waktu	Parameter tidak didukung lagi

Hasil

Waktu/tanggal dan waktu Unix yang disimpan.

get_configuration

get_configuration(provider, environment=None, integration_instance=None)

Mendapatkan konfigurasi integrasi.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
penyedia	{string}	Nama integrasi	VirusTotal	Nama Penyedia Integrasi peka huruf besar/kecil. Error akan ditampilkan jika integrasi tidak diinstal atau string tidak ada
lingkungan	{string}	Konfigurasi untuk lingkungan tertentu atau 'semua'	T/A	(Opsional) Jika disediakan, kredensial akan diambil dari konfigurasi lingkungan yang sesuai. Jika tidak ada lingkungan yang dinyatakan, lingkungan kasus akan digunakan secara default. Jika tidak ada konfigurasi untuk lingkungan tertentu tersebut, konfigurasi default akan ditampilkan
integration_instance	{string}	ID instance integrasi	T/A	T/A

Hasil

Detail konfigurasi {dict}

Contoh

from SiemplifyJob import SiemplifyJob
siemplify = SiemplifyJob()
siemplify.get_configuration(provider="VirusTotal", environment="")

Perilaku hasil

Kamus dengan kredensial tersimpan untuk integrasi dari Google Security Operations Marketplace akan ditampilkan.

Nilai hasil

{
u'AgentIdentifier': None,
u'Api Key': u'c0c412#########################4f85b22e707',
u'Verify SSL': u'True',
u'RunRemotely': u'False'
}

get_failed_actions

get_failed_actions(number_of_hours)

Mendapatkan semua tugas ETL yang gagal dalam jumlah jam yang ditentukan.

Hasil

{dict} tugas yang gagal

{'Id':{string}, 'Name':{string}, 'Message':{string}, WorkflowId = {string}, CreationTime: {string}, CaseId:{string}}

get_failed_etljobs

get_failed_etljobs(number_of_hours)

Mendapatkan semua tugas ETL yang gagal dalam jumlah jam yang ditentukan.

Hasil

{dict} tugas yang gagal

{ 'Id': {string}, 'Name': {string}, Message: {string}, CreationTime: {string}}

get_faulted_connectors

get_faulted_connectors(start_unix_time, end_unix_time)

Mendapatkan semua konektor yang gagal dalam periode waktu antara start_unix_time dan end_unix_time.

Hasil

{dict} konektor yang gagal

Nilai hasil

{'Name': {string}, 'Message': {string}, 'CreationTime': {string}}

get_faulted_jobs

get_faulted_jobs(number_of_hours)

Mendapatkan semua tugas yang gagal dalam jumlah jam yang ditentukan.

Hasil

{[dict]} tugas gagal

Nilai hasil

[{'Id': {long}, 'Name':{string}, 'Message':{string}, 'CreationTime':{string}}]

get_job_context_property

get_job_context_property(identifier, property_key)

Mendapatkan nilai konteks tugas dengan kunci yang diberikan.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
ID	{string}	ID konteks	T/A	T/A
property_key	{string}	Kunci properti yang akan diambil	T/A	T/A

get_scoped_job_context_property

get_scoped_job_context_property(property_key)

Dapatkan properti konteks tugas yang tercakup menggunakan ID unik tugas.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
property_key	{string}	Kunci properti konteks tugas	T/A	T/A

Hasil

Nilai kunci tertentu.

get_system_info

get_system_info(start_time_unixtime_ms)

property log_location

save_publisher_logs

save_publisher_logs(records)

Menyimpan data log penayang.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
record	{list}	Data yang akan disimpan	T/A	T/A

save_timestamp

save_timestamp(datetime_format=False, timezone=False, new_timestamp=1683034181430)

Stempel waktu simpan.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
datetime_format	{boolean}	T/A	True untuk format tanggal dan waktu, False untuk Unix	Default-nya adalah False (opsional)
zona waktu	Parameter tidak didukung lagi
new_timestamp	{long}	Stempel waktu untuk disimpan ke konteks	T/A	Stempel waktu default ke stempel waktu Unix saat memanggil metode

send_mail

send_mail(subject, message, recipients, attachment_file_name, attachment_content)

Mengirim email (lampiran diizinkan).

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
subject	{string}	Email subject	T/A	T/A
pesan	{string}	Kirim pesan melalui email	T/A	T/A
attachment_file_name	{string}	Nama file lampiran	T/A	T/A
penerima	{[{string}]}	Daftar penerima	T/A	T/A

set_job_context_property

set_job_context_property(identifier, property_key, property_value)

Menetapkan properti konteks tugas yang tercakup menggunakan ID unik tugas.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
ID	{string}	ID konteks	T/A	T/A
property_key	{string}	Kunci properti konteks tugas	T/A	T/A
property_value	{string}	Nilai properti konteks tugas	T/A	T/A

set_scoped_job_context_property

set_scoped_job_context_property(property_key, property_value)

Menetapkan properti konteks tugas yang tercakup menggunakan ID unik tugas.

Parameter

Nama parameter	Jenis parameter	Definisi	Nilai yang memungkinkan	Komentar
property_key	{string}	Kunci properti konteks tugas	T/A	T/A
property_value	{string}	Nilai properti konteks tugas	T/A	T/A