文档

ListProbeTask - 查询拨测任务

更新时间:

查询拨测任务。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
smartag:ListProbeTaskList
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RegionIdstring

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

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

cn-shanghai
SagIdstring

智能接入网关实例 ID。

sag-****
Snstring

智能接入网关设备序列号。

sag****
ProbeTaskIdstring

拨测任务 ID。

probe-****
TaskNamestring

拨测任务名称。

test-ping
Protocolstring

拨测任务协议。取值:

  • ICMP
  • TCP
  • HTTP
说明 私网拨测仅支持 ICMP 和 TCP 协议。
ICMP
SagNamestring

智能接入网关实例名称。

shanghai-office
PageSizeinteger

分页查询时每页的行数。最大值:50。默认值:10

10
PageNumberinteger

列表的页码。默认值:1

1

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

324223F3-93D3-4CE4-B26F-66C0C3809922
Codestring

响应码。

200
Messagestring

响应消息。

successful
TotalCountinteger

列表条目数。

1
PageSizeinteger

分页查询时每页的行数。

10
PageNumberinteger

列表的页码。

1
Dataobject []

拨测任务配置信息列表。

probe-xxx
ProbeTaskIdstring

拨测任务 ID。

probe-****
TaskNamestring

拨测任务名称。

test-ping
SagIdstring

智能接入网关实例 ID。

sag-asdfz6ac74oj5v****
Snstring

智能接入网关设备序列号。

sag****
Typestring

拨测任务类型。取值:

  • Internet:公网拨测。
  • Intranet:私网拨测。
Internet
Protocolstring

拨测任务协议。取值:

  • ICMP
  • TCP
  • HTTP
说明 私网拨测仅支持 ICMP 和 TCP 协议。
ICMP
Domainstring

拨测任务目的域名。

www.example.com
Portinteger

拨测协议端口号。

80
PacketNumberinteger

拨测协议每分钟发包数。

10
ProbeTaskSourceAddressstring

私网拨测源地址。

192.168.1.1
Enableboolean

是否已启用拨测任务。取值:

  • true:已开启。
  • false:未开启。
true
GmtCreatestring

创建时间。

2022-11-23 14:09
GmtModifystring

修改时间。

2022-11-23 14:09

示例

正常返回示例

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错误码错误信息描述
400InvalidNameThe specified name is not valid.名称不合法。
400InvalidProbeProtocolThe specified probe task protocol is invalid.拨测任务协议不合法。

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