请联系 Dotcom 监视器支持团队以接收对此 Web API 功能的访问权限。

请求网址

把 https://api.dotcom-monitor.com/config_api_v1/tasks

查询参数

参数 必填 描述
Device_Id

true

 将在其下创建任务的监视设备的唯一 ID。
Task_Type_Id

true

 任务的类型。

对于用户视图：

Task_Type_Id=21
超时

自选

 任务执行超时（毫秒）。
名字

自选

 任务描述。

请求正文

Dotcom 监视器 API 接受使用请求正文上传的二进制文件。 要将 ES 脚本与您的请求一起上传到 Dotcom 监视器：

  1. 使用每个步骤脚本工具创建或编辑每个步骤脚本。
  2. 将脚本下载到您的计算机并保存到 dmuv/dmes 文件。
  3. 在 API 客户端中，选择将 dmuv/dmes 文件作为二进制文件发送到请求正文中。 如果您的 API 客户端不支持二进制方法，请使用 替代方法。
请求示例
curl --location --request PUT "https://api.dotcom-monitor.com/config_api_v1/tasks?Device_Id=16826&Task_Type_Id=21&Timeout=55000&Name=uploaded_dmes_script" ^
--header "Content-Type: application/octet-stream" ^
--header "Cookie: DANA-AUTH-API-COOKIE=7efad88951954e61a1235f43219882f34; DANA-AUTH-COOKIE=21c34cc69cdd4123448eaa5c519a824e" ^
--data "@/C:/Users/dm_admin/ES_Scripts/everystep-script.dmes"

将 ES 脚本作为 base64 编码数据上传

如果您的 API 客户端不支持二进制方法，您可以将 ES 脚本作为 Base64 格式的 JSON 正文参数上传到 Dotcom 监视器。 请注意，在这种情况下，所有请求参数都应在请求正文中传递（而不是在查询中传递）。

请求网址

发布 https://api.dotcom-monitor.com/config_api_v1/task/{task_id}

路径参数

领域 类型 必填 描述
task_id

字符串

true

 要编辑的监控任务的唯一 ID。

头参数

Content-Type: application/json

JSON 正文示例

{ 
    "Device_Id": 3153, 
    "Task_Type_Id": 21, 
    "Name": "dotcom-monitor.com", 
    "Timeout": 1200, 
    "base64dmuv": "AAEAAAD/////AQAAAAAAAAAEAQAAAAxTeXN0ZW0uSW50MzIBAAAAB21fdmFsdWUACAIAAAALAAEAAAD/////AQAAAAAAAAAMAgAAAERfT1FMX0R5bmFtaWNfLCB.......1bHR1cmU9bmV1dHJh"
    
}

身体参数

领域 类型 必需/可选 描述
超时

int32

自选

 包含任务执行超时（以毫秒为单位）。
base64dmuv 字符串 必填 包含 Base64 格式的每个步骤脚本。

请参阅将每个步骤脚本转换为 Base64 的 指南 。
Device_Id

int32

必填

 唯一的设备 ID。

例子：
"Device_Id": 8692
Task_Type_Id

int32

必填

 任务的类型。
名字

字符串

自选

 任务描述。

要将脚本转换为 Base64 格式，您需要先将脚本从工具导入到 *.dmuv （ES 桌面） 或 *.dmes （ES Web） 文件。 请按照以下步骤操作：

  1. 使用每个步骤脚本工具创建或编辑每个步骤脚本。
  2. 将脚本下载到您的计算机并保存到 dmuv/dmes 文件。
  3. 使用编码器将 dmuv/dmes 文件转换为 Base64 格式。
  4. 将编码的内容复制到 JSON 请求的 base64dmuv 参数中。

或者，如果您在将脚本文件转换为 Base64 时遇到任何问题，可以 在此处下载我们的 Base64 编码器。 下载后，使用编码器转换 ES 文件，如下所述：

  1. 打开命令行并提供编码器.exe文件encoding_checker.exe的路径 。
  2. 提供下载的 dmuv/dmes 文件的完整路径作为参数（例如，“g：\Temp9\login_check.dmuv”）。
  3. 要将转换后的脚本保存到文件中，请提供该文件的路径。

成功响应

示例响应
{
    "Success": true,
    "Result": "Task 12365 has been updated"
}