SiemplifyJob 모듈

클래스 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}(기본값)
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: datetime 형식으로 가져오기 False: Unix	기본값은 False입니다(선택사항).
timezone	더 이상 지원되지 않는 매개변수
new_timestamp	{int}	저장할 타임스탬프	해당 사항 없음	기본값은 Unix epoch 시간입니다 (선택사항).

fetch_timestamp

fetch_timestamp(datetime_format=False, timezone=False)

save_timestamp로 저장된 타임스탬프를 가져옵니다.

매개변수

매개변수 이름	매개변수 유형	정의	가능한 값	설명
datetime_format	{boolean}	True인 경우 타임스탬프를 날짜/시간으로 반환합니다. 그렇지 않으면 Unix에서 반환합니다.	True/False	기본값은 False입니다(선택사항).
timezone	더 이상 지원되지 않는 매개변수

반환

저장된 Unix time/datetime입니다.

get_configuration

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

통합 구성을 가져옵니다.

매개변수

매개변수 이름	매개변수 유형	정의	가능한 값	설명
제공업체	{string}	통합 이름	VirusTotal	통합 제공업체 이름은 대소문자를 구분합니다. 통합이 설치되지 않았거나 문자열이 존재하지 않으면 오류가 발생합니다.
환경	{string}	특정 환경 또는 'all'의 구성	해당 사항 없음	(선택사항) 제공된 경우 사용자 인증 정보가 해당 환경 구성에서 검색됩니다. 환경을 명시하지 않으면 기본적으로 케이스 환경이 사용됩니다. 해당 환경에 대한 구성이 없으면 기본 구성이 반환됩니다.
integration_instance	{string}	통합 인스턴스의 식별자	해당 사항 없음	해당 사항 없음

반환

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

지정된 키로 작업 컨텍스트 값을 가져옵니다.

매개변수

매개변수 이름	매개변수 유형	정의	가능한 값	설명
identifier	{string}	컨텍스트 식별자	해당 사항 없음	해당 사항 없음
property_key	{string}	가져올 속성의 키	해당 사항 없음	해당 사항 없음

get_scoped_job_context_property

get_scoped_job_context_property(property_key)

작업의 고유 식별자를 사용하여 범위가 지정된 작업 컨텍스트 속성을 가져옵니다.

매개변수

매개변수 이름	매개변수 유형	정의	가능한 값	설명
property_key	{string}	작업의 컨텍스트 속성의 키	해당 사항 없음	해당 사항 없음

반환

특정 키의 값입니다.

get_system_info

get_system_info(start_time_unixtime_ms)

속성 log_location

save_publisher_logs

save_publisher_logs(records)

게시자 로그 레코드를 저장합니다.

매개변수

매개변수 이름	매개변수 유형	정의	가능한 값	설명
records	{list}	저장할 레코드	해당 사항 없음	해당 사항 없음

save_timestamp

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

타임스탬프를 저장합니다.

매개변수

매개변수 이름	매개변수 유형	정의	가능한 값	설명
datetime_format	{boolean}	해당 사항 없음	날짜 및 시간 형식의 경우 True, Unix의 경우 False	기본값은 False입니다(선택사항).
timezone	더 이상 지원되지 않는 매개변수
new_timestamp	{long}	컨텍스트에 저장할 타임스탬프	해당 사항 없음	타임스탬프는 메서드 호출의 Unix 타임스탬프로 기본 설정됩니다.

send_mail

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

이메일을 보냅니다(첨부파일 허용됨).

매개변수

매개변수 이름	매개변수 유형	정의	가능한 값	설명
subject	{string}	이메일 제목	해당 사항 없음	해당 사항 없음
메시지	{string}	이메일 메시지	해당 사항 없음	해당 사항 없음
attachment_file_name	{string}	첨부파일 이름	해당 사항 없음	해당 사항 없음
수신자	{[{string}]}	수신자 목록	해당 사항 없음	해당 사항 없음

set_job_context_property

set_job_context_property(identifier, property_key, property_value)

작업의 고유 식별자를 사용하여 범위가 지정된 작업 컨텍스트 속성을 설정합니다.

매개변수

매개변수 이름	매개변수 유형	정의	가능한 값	설명
identifier	{string}	컨텍스트 식별자	해당 사항 없음	해당 사항 없음
property_key	{string}	작업의 컨텍스트 속성의 키	해당 사항 없음	해당 사항 없음
property_value	{string}	작업의 컨텍스트 속성 값	해당 사항 없음	해당 사항 없음

set_scoped_job_context_property

set_scoped_job_context_property(property_key, property_value)

작업의 고유 식별자를 사용하여 범위가 지정된 작업 컨텍스트 속성을 설정합니다.

매개변수

매개변수 이름	매개변수 유형	정의	가능한 값	설명
property_key	{string}	작업의 컨텍스트 속성의 키	해당 사항 없음	해당 사항 없음
property_value	{string}	작업의 컨텍스트 속성 값	해당 사항 없음	해당 사항 없음