查询拨测任务。
调试
您可以在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. | 拨测任务协议不合法。 |
访问错误中心查看更多错误码。