激活监视器

描述:

此 API 方法可激活对工作流、工单、脚本、文件夹和节点的监控。

本页面显示的响应为 JSON 格式。 要返回默认响应(XML 格式),请省略&format=json在下面的请求中就有。

用途

https://Orchestrator_IP_address/aspera/orchestrator/api/activate_monitor?format=json&logon=login_name&monitor_type=monitor_type&portable_id=portable_id
例如:
https://10.0.0.10/aspera/orchestrator/api/activate_monitor?format=json&logon=my_login_name&monitor_type=workflow&portable_id=1

参数

您必须包括id参数或portable_id参数。
注意:要调用外部服务器上的 Orchestrator 实例,请使用portable_id参数,因为该值保持不变。 不要使用id参数,因为每次新的调用都会从数据库中生成一个新的 ID,这样就很难跟踪监视器的来源。
您可以从 Orchestrator API 或用户界面获取任一参数值:
  • API:从 List Monitors 响应中解析您需要的值。
  • 用户界面:单击 监视器 打开监视器页面,然后单击监视器类型(工作流、工单、脚本、文件夹或节点)的相应选项卡,显示该类型所有可用监视器的列表。
    • id参数值位于监视器名称左侧的 ID 列中。
    • for theportable_id参数,单击参数名称右侧的编辑图标,打开监视器详细信息对话框。 该值位于 Portable ID 字段中。
参数名称 必需/可选 数据类型 定义
monitor_type 必需 字符串 停用的监视器类型。 允许的值为:workflow,work order,folder,script,node
id 必需 字符串 数据库生成的 ID。 这只能用于同一 Orchestrator 实例内的调用。
portable_id 可选 字符串 由 Orchestrator 生成的辅助 ID。 向外部 Orchestrator 实例发出请求时使用此选项。

响应

{
  "action": "activate_monitor",
  "time": "2018-04-24 22:02:32",
  "id": "1",
  "description": "activated"
}