SiemplifyJob 模組

class SiemplifyJob.SiemplifyJob

基礎：Siemplify

端點：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)

從整合執行個體取得設定參數。

參數

參數名稱	參數類型	定義	可能的值	註解
param_name	{string}	要擷取的參數名稱	不適用	不適用
default_value	{any}	參數的預設值		(選用) 如果未設定參數，則會傳回指定值 (如果 is_mandatory 設為 False)。 預設為 None
input_type	{obj}	參數類型	不適用	(選用) 傳回的值會轉換為所選的輸入類型。 {str} by default
is_mandatory	{boolean}	定義參數是否為必要參數	不適用	(選用) 如果設為 True，但未填寫參數，系統就會引發例外狀況。預設為 False
print_value	{boolean}	定義是否要將擷取的參數值輸出至記錄檔。	不適用	(選用) 預設為 False

傳回

參數值 (預設為字串)，除非指定 input_type。

範例

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)

結果行為

系統會傳回所選參數的值，並轉換為所選類型。

結果值

C:\Siemplify_Server\Scripting\SampleJob\Logs

fetch_and_save_timestamp

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

擷取時間戳記並儲存至案例脈絡。

參數

參數名稱	參數類型	定義	可能的值	註解
datetime_format	{boolean}	日期/時間格式	True (取得日期時間格式)、 False (取得 Unix 時間)	預設為 False (選用)
時區	不再支援參數
new_timestamp	{int}	要儲存的時間戳記	不適用	預設為 Unix 紀元時間 (選用)

fetch_timestamp

fetch_timestamp(datetime_format=False, timezone=False)

取得使用 save_timestamp 儲存的時間戳記。

參數

參數名稱	參數類型	定義	可能的值	註解
datetime_format	{boolean}	如果 True，則傳回時間戳記做為日期時間。 否則，以 Unix 格式傳回	True/False	預設為 False (選用)
時區	不再支援參數

傳回

儲存的 Unix 時間/日期時間。

get_configuration

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

取得整合設定。

參數

參數名稱	參數類型	定義	可能的值	註解
供應商	{string}	整合作業名稱	VirusTotal	整合供應商名稱須區分大小寫。 如果未安裝整合服務或字串不存在，系統會擲回錯誤
環境	{string}	特定環境或「全部」的設定	不適用	(選用) 如果提供，系統會從對應的 環境設定中擷取憑證。如未指定環境，系統預設會使用案件環境。 如果該特定環境沒有設定，系統會傳回預設設定
integration_instance	{string}	整合執行個體 ID	不適用	不適用

傳回

{dict} 設定詳細資料

範例

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

結果行為

系統會傳回字典，其中包含從 Google Security Operations Marketplace 整合的已儲存憑證。

結果值

{
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)

取得在指定時數內失敗的所有 ETL 工作。

傳回

{dict} 項工作失敗

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

get_failed_etljobs

get_failed_etljobs(number_of_hours)

取得在指定時數內失敗的所有 ETL 工作。

傳回

{dict} 項工作失敗

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

get_faulted_connectors

get_faulted_connectors(start_unix_time, end_unix_time)

取得 start_unix_time 至 end_unix_time 之間發生失敗的所有連接器。

傳回

{dict} 個連接器失敗

結果值

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

get_faulted_jobs

get_faulted_jobs(number_of_hours)

取得指定時數內失敗的所有工作。

傳回

{[dict]} 項工作失敗

結果值

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

get_job_context_property

get_job_context_property(identifier, property_key)

依據指定鍵取得工作內容值。

參數

參數名稱	參數類型	定義	可能的值	註解
ID	{string}	情境 ID	不適用	不適用
property_key	{string}	要擷取屬性的鍵	不適用	不適用

get_scoped_job_context_property

get_scoped_job_context_property(property_key)

使用工作的專屬 ID 取得範圍內的工作內容屬性。

參數

參數名稱	參數類型	定義	可能的值	註解
property_key	{string}	工作內容屬性的鍵	不適用	不適用

傳回

特定鍵的值。

get_system_info

get_system_info(start_time_unixtime_ms)

屬性 log_location

save_publisher_logs

save_publisher_logs(records)

儲存發布商記錄檔記錄。

參數

參數名稱	參數類型	定義	可能的值	註解
記錄	{list}	要儲存的記錄	不適用	不適用

save_timestamp

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

儲存時間戳記。

參數

參數名稱	參數類型	定義	可能的值	註解
datetime_format	{boolean}	不適用	True (日期時間格式) 或 False (Unix)	預設值為 False (選填)
時區	不再支援參數
new_timestamp	{long}	要儲存至情境的時間戳記	不適用	時間戳記預設為呼叫方法時的 Unix 時間戳記

send_mail

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

傳送電子郵件 (可附加檔案)。

參數

參數名稱	參數類型	定義	可能的值	註解
主旨	{string}	電子郵件主旨	不適用	不適用
訊息	{string}	電子郵件內文	不適用	不適用
attachment_file_name	{string}	附件檔案名稱	不適用	不適用
收件者	{[{string}]}	收件者清單	不適用	不適用

set_job_context_property

set_job_context_property(identifier, property_key, property_value)

使用工作的專屬 ID 設定範圍內的工作內容屬性。

參數

參數名稱	參數類型	定義	可能的值	註解
ID	{string}	情境 ID	不適用	不適用
property_key	{string}	工作內容屬性的鍵	不適用	不適用
property_value	{string}	工作內容屬性的值	不適用	不適用

set_scoped_job_context_property

set_scoped_job_context_property(property_key, property_value)

使用工作的專屬 ID 設定範圍內的工作內容屬性。

參數

參數名稱	參數類型	定義	可能的值	註解
property_key	{string}	工作內容屬性的鍵	不適用	不適用
property_value	{string}	工作內容屬性的值	不適用	不適用