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 用于获取日期时间格式，False 用于获取 Unix 时间 |
默认值为 False（可选） |
| timezone | 相应参数不再受支持 | |||
| new_timestamp | {int} | 要保存的时间戳 | 不适用 | 默认的 Unix 纪元时间（可选） |
fetch_timestamp
fetch_timestamp(datetime_format=False, timezone=False)
获取使用 save_timestamp 保存的时间戳。
参数
| 参数名称 | 参数类型 | 定义 | 可能的值 | 评论 |
|---|---|---|---|---|
| datetime_format | {boolean} | 如果值为 True，则以日期时间格式返回时间戳。否则，以 Unix 格式返回 |
True/False | 默认值为 False（可选） |
| timezone | 相应参数不再受支持 | |||
返回值
已保存的 Unix 时间/日期时间。
get_configuration
get_configuration(provider, environment=None, integration_instance=None)
获取集成配置。
参数
| 参数名称 | 参数类型 | 定义 | 可能的值 | 评论 |
|---|---|---|---|---|
| provider | {string} | 集成名称 | VirusTotal | 集成提供商名称区分大小写。 如果未安装集成 或字符串不存在，则会抛出错误 |
| 环境 | {string} | 特定环境或“全部”的配置 | 不适用 | （可选） 如果提供，系统将从相应的 环境配置中检索凭据。如果未指明环境，则默认使用 环境。 如果该特定 环境没有配置，则返回默认配置 |
| 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)
按给定键获取作业上下文值。
参数
| 参数名称 | 参数类型 | 定义 | 可能的值 | 评论 |
|---|---|---|---|---|
| 标识符 | {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)
保存发布商日志记录。
参数
| 参数名称 | 参数类型 | 定义 | 可能的值 | 评论 |
|---|---|---|---|---|
| 记录 | {list} | 要保存的记录 | 不适用 | 不适用 |
save_timestamp
save_timestamp(datetime_format=False, timezone=False, new_timestamp=1683034181430)
保存时间戳。
参数
| 参数名称 | 参数类型 | 定义 | 可能的值 | 评论 |
|---|---|---|---|---|
| datetime_format | {boolean} | 不适用 | True 表示日期时间格式，False 表示 Unix |
默认值为 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)
使用作业的唯一标识符设置范围限定的作业上下文属性。
参数
| 参数名称 | 参数类型 | 定义 | 可能的值 | 评论 |
|---|---|---|---|---|
| 标识符 | {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} | 作业的上下文属性的值 | 不适用 | 不适用 |