文档

CreateProbeTask - 创建拨测任务

更新时间:

为指定的智能接入网关设备创建拨测任务。

接口说明

  • 目前仅软件版本为 2.7.0 及以上的 SAG-1000 设备支持应用拨测监控功能。
  • 在创建拨测任务时,智能接入网关实例需提前开启深度监控功能。您可以调用 SetAdvancedMonitorState 接口设置深度监控开关状态。

调试

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

授权信息

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

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

请求参数

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

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

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

cn-shanghai
SagIdstring

智能接入网关实例 ID。

sag-asdfz6ac74oj5v****
Snstring

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

sag****
TaskNamestring

拨测任务名称。

test-ping
Typestring

拨测任务类型。取值:

  • Internet:公网拨测。

  • Intranet:私网拨测。

Internet
Protocolstring

拨测任务协议,取值:

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

拨测任务目的域名。 对于 ICMP、TCP 协议类型的拨测,取值为目的服务的 IP 或域名;对于 HTTP 协议类型的拨测,取值为目的服务的 URL。

www.example.com
Portinteger

拨测协议端口号。

说明 对于 TCP 协议类型的拨测必填,其他协议不填值。
80
PacketNumberinteger

拨测协议每分钟发包数。

取值范围:1~60

说明 对于 ICMP 协议类型的拨测必填,其他协议不填值。
10
ProbeTaskSourceAddressstring

私网拨测源地址。

说明 对于私网类型的拨测协议必填。
192.168.1.1
Enableboolean

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

  • true:是。
  • false:否。
true

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

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

响应码。

200
Messagestring

响应消息。

successful
Datastring

创建成功的拨测任务 ID。

probe-****

示例

正常返回示例

JSON格式

{
  "RequestId": "324223F3-93D3-4CE4-B26F-66C0C3809922",
  "Code": "200",
  "Message": "successful",
  "Data": "probe-****"
}

错误码

HTTP status code错误码错误信息描述
400InvalidProbeDomainThe specified probe task domain is invalid.拨测任务域名不合法。
400InvalidNameThe specified name is not valid.名称不合法。
400InvalidProbeTypeThe specified probe task type is invalid.拨测任务类型不合法。
400InvalidProbeProtocolThe specified probe task protocol is invalid.拨测任务协议不合法。
400InvalidProbePortThe specified probe task port is invalid.拨测任务端口不合法。
400InvalidPacketNumberThe specified probe task packet number is invalid.拨测任务发包数不合法。
400InvalidProbeSourceIPThe specified probe task source ip is invalid.拨测任务源IP不合法。
400ExistSameParamTaskExist task with same params.存在参数相同的任务。
400SagConfiguringSag is configuring. -
403FeatureNotSupportThe current edition of the smart access gateway does not support this feature.智能接入网关当前版本不支持该功能特性。

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