為指定的智能接入網關設備創建撥測任務。
接口說明
- 目前僅軟件版本為 2.7.0 及以上的 SAG-1000 設備支持應用撥測監控功能。
- 在創建撥測任務時，智能接入網關實例需提前開啟深度監控功能。您可以調用 SetAdvancedMonitorState 接口設置深度監控開關狀態。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| smartag:CreateProbeTask | Write |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 智能接入網關實例所屬的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-shanghai |
| SagId | string | 是 | 智能接入網關實例 ID。 | sag-asdfz6ac74oj5v**** |
| Sn | string | 是 | 智能接入網關設備序列號。 | sag**** |
| TaskName | string | 是 | 撥測任務名稱。 | test-ping |
| Type | string | 是 | 撥測任務類型。取值：
| Internet |
| 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",
"Data": "probe-****"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidProbeDomain | The specified probe task domain is invalid. | 撥測任務域名不合法。 |
| 400 | InvalidName | The specified name is not valid. | 名稱不合法。 |
| 400 | InvalidProbeType | The specified probe task type is invalid. | 撥測任務類型不合法。 |
| 400 | InvalidProbeProtocol | The specified probe task protocol 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. | - |
| 403 | FeatureNotSupport | The current edition of the smart access gateway does not support this feature. | 智能接入網關當前版本不支持該功能特性。 |
訪問錯誤中心查看更多錯誤碼。