调用UpdateProbeTask接口更新拨测任务。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 UpdateProbeTask

系统规定参数。取值：UpdateProbeTask。
RegionId String 是 cn-shanghai

智能接入网关实例所属的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

SagId String 是 sag-****

智能接入网关实例ID。
Sn String 是 sag****

智能接入网关设备序列号。
ProbeTaskId String 是 probe-****

拨测任务ID。
TaskName String 否 test-ping

拨测任务名称。
Protocol String 否 ICMP

拨测任务协议。取值：

  • ICMP。
  • TCP。
  • HTTP。
说明 私网拨测仅支持ICMP和TCP协议。
Domain String 否 www.example.com

拨测任务目的域名。

对于ICMP、TCP协议类型的拨测，取值为目的服务的IP或域名；对于HTTP协议类型的拨测，取值为目的服务的URL。
Port Integer 否 80

拨测协议端口号。

说明 对于TCP协议类型的拨测必填，其他协议不填值。
PacketNumber Integer 否 10

拨测协议每分钟发包数。

取值范围：1~60。

说明 对于ICMP协议类型的拨测必填，其他协议不填值。
ProbeTaskSourceAddress String 否 192.168.1.1

私网拨测源地址。

说明 对于私网类型的拨测必填。
Enable Boolean 否 true

是否启用拨测任务。取值：

  • true：是。
  • false：否。

返回数据

名称 类型 示例值 描述
RequestId String 324223F3-93D3-4CE4-B26F-66C0C3809922

请求ID。
Code String 200

响应码。
Message String successful

响应消息。

示例

请求示例

http(s)://[Endpoint]/?Action=UpdateProbeTask
&RegionId=cn-shanghai
&SagId=sag-****
&Sn=sag****
&ProbeTaskId=probe-****
&TaskName=test-ping
&Protocol=ICMP
&Domain=www.example.com
&Port=80
&PacketNumber=10
&ProbeTaskSourceAddress=192.168.1.1
&Enable=true
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateProbeTaskResponse>
    <RequestId>324223F3-93D3-4CE4-B26F-66C0C3809922</RequestId>
    <Code>200</Code>
    <Message>successful</Message>
</UpdateProbeTaskResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "324223F3-93D3-4CE4-B26F-66C0C3809922",
  "Code" : "200",
  "Message" : "successful"
}

错误码

HttpCode 错误码 错误信息 描述
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. 存在参数相同的任务。

访问错误中心查看更多错误码。