查詢撥測任務。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| smartag:ListProbeTask | List |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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 |
| SagName | string | 是 | 智能接入網關實例名稱。 | shanghai-office |
| PageSize | integer | 否 | 分頁查詢時每頁的行數。最大值：50。默認值：10。 | 10 |
| PageNumber | integer | 否 | 列表的頁碼。默認值：1。 | 1 |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "324223F3-93D3-4CE4-B26F-66C0C3809922",
"Code": "200",
"Message": "successful",
"TotalCount": 1,
"PageSize": 10,
"PageNumber": 1,
"Data": [
{
"ProbeTaskId": "probe-****",
"TaskName": "test-ping",
"SagId": "sag-asdfz6ac74oj5v****",
"Sn": "sag****",
"Type": "Internet",
"Protocol": "ICMP",
"Domain": "www.example.com",
"Port": 80,
"PacketNumber": 10,
"ProbeTaskSourceAddress": "192.168.1.1",
"Enable": true,
"GmtCreate": "2022-11-23 14:09",
"GmtModify": "2022-11-23 14:09"
}
]
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidName | The specified name is not valid. | 名稱不合法。 |
| 400 | InvalidProbeProtocol | The specified probe task protocol is invalid. | 撥測任務協議不合法。 |
訪問錯誤中心查看更多錯誤碼。