更新拨测任务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 智能接入网关实例所属的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-shanghai |
SagId | string | 是 | 智能接入网关实例 ID。 | sag-**** |
Sn | string | 是 | 智能接入网关设备序列号。 | sag**** |
ProbeTaskId | string | 是 | 拨测任务 ID。 | probe-**** |
TaskName | string | 否 | 拨测任务名称。 | test-ping |
Protocol | string | 否 | 拨测任务协议。取值:
说明
私网拨测仅支持 ICMP 和 TCP 协议。
| ICMP |
Domain | string | 否 | 拨测任务目的域名。 对于 ICMP、TCP 协议类型的拨测,取值为目的服务的 IP 或域名;对于 HTTP 协议类型的拨测,取值为目的服务的 URL。 | www.example.com |
Port | integer | 否 | 拨测协议端口号。 说明
对于 TCP 协议类型的拨测必填,其他协议不填值。
| 80 |
PacketNumber | integer | 否 | 拨测协议每分钟发包数。 取值范围:1~60。 说明
对于 ICMP 协议类型的拨测必填,其他协议不填值。
| 10 |
ProbeTaskSourceAddress | string | 否 | 私网拨测源地址。 说明
对于私网类型的拨测必填。
| 192.168.1.1 |
Enable | boolean | 否 | 是否启用拨测任务。取值:
| true |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "324223F3-93D3-4CE4-B26F-66C0C3809922",
"Code": "200",
"Message": "successful"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InstanceNotExit | The specified instance does not exist. | 指定的实例不存在。 |
400 | InvalidName | The specified name is not valid. | 名称不合法。 |
400 | InvalidProbeProtocol | The specified probe task protocol is invalid. | 拨测任务协议不合法。 |
400 | InvalidProbeDomain | The specified probe task domain is invalid. | 拨测任务域名不合法。 |
400 | InvalidProbePort | The specified probe task port is invalid. | 拨测任务端口不合法。 |
400 | InvalidPacketNumber | The specified probe task packet number is invalid. | 拨测任务发包数不合法。 |
400 | InvalidProbeSourceIP | The specified probe task source ip is invalid. | 拨测任务源IP不合法。 |
400 | ExistSameParamTask | Exist task with same params. | 存在参数相同的任务。 |
400 | SagConfiguring | Sag is configuring. | - |
访问错误中心查看更多错误码。