更新撥測任務。
調試
您可以在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. | - |
訪問錯誤中心查看更多錯誤碼。