创建周期拨测任务--云拨测-火山引擎

文档中心

立即注册

导航

创建周期拨测任务

最近更新时间：2024.12.25 19:44:39首次发布时间：2024.12.25 19:44:39

本接口用于创建周期拨测任务。您可以通过该接口，配置任务类型、名称、目标地址等参数，并设定执行周期、拨测频率以及其他相关配置。通过此接口，您可以创建一个定时执行的拨测任务，以监控和分析网络性能和稳定性。

使用限制

节流限制：您每秒最多可以提交 5 个 API 请求。

请求说明

请求方式：POST
请求地址：https://cloud-detect.volcengineapi.com?Action=CreateTask&Version=2023-08-31

请求参数

Query

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `CreateTask`。
Version	String	是	接口版本。当前 API 的版本为 `2023-08-31`。

Body

参数名称	数据类型	是否必选	参数说明	示例
Type	Integer	是	任务类型： 1：HTTP(S) 2：DNS 3：PING 5：UDP 6：TCP	`1`
Name	String	是	任务名称。	`cloud-detect-test`
Address	String	是	目标地址。	`www.example.com`
LineIDList	Long[]	是	节点ID列表。	`[274]`
NodeCount	Integer	是	每条线路的样本数量。	`10`
IntervalSeconds	Long	是	拨测频率（单位：秒）。可选值：60、120、180、300、600、900、1200、1800、3600、7200、10800、21600、43200、86400。	`60`
FinishTime	Long	是	结束时间（秒级时间戳），0代表不限结束时间。	`0`
PeriodConfig	Object	否	自定义执行周期。
DiagnoseConfig	Object	否	诊断配置。
HTTPConfig	Object	否	HTTP任务配置。如果创建HTTP类型的任务，必填该配置项。
DNSConfig	Object	否	DNS任务配置。如果创建DNS类型的任务，必填该配置项。
TCPConfig	Object	否	TCP任务配置。如果创建TCP类型的任务，必填该配置项。
UDPConfig	Object	否	UDP任务配置。如果创建UDP类型的任务，必填该配置项。
PingConfig	Object	否	PING任务配置。如果创建PING类型的任务，必填该配置项。

返回参数

参数名称	数据类型	参数说明	示例
TaskID	Long	拨测任务ID。	`23275831`
LocationInfo	Object	地理位置信息。

请求示例

POST https://cloud-detect.volcengineapi.com?Action=CreateTask&Version=2023-08-31
{
    "Type": 1,
    "Name": "api-http",
    "Address": "http://www.baidu.com",
    "IntervalSeconds": 60,
    "LineIDList": [
        274
    ],
    "NodeCount": 2,
    "FinishTime": 0
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241225172553A796E78EB68493102633",
    "Action": "CreateTask",
    "Version": "2023-08-31",
    "Service": "cloud_detect",
    "Region": "cn-north-1"
  },
  "Result": {
    "BaseResponse": {
      "Extra": null,
      "Logid": "",
      "ShowMessage": "",
      "StatusCode": 0,
      "StatusMessage": ""
    },
    "LocationInfo": {
      "City": "",
      "Continent": "",
      "Country": "",
      "Isp": "",
      "Province": ""
    },
    "TaskID": 23339190
  }
}