CreateProbeTask_智能接入网关_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
smartag:CreateProbeTask
Write
ProbeTask
acs:smartag:{#regionId}:{#accountId}:probetask/*
SmartAccessGateway
acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAgId}

请求参数

字段名称字段详情
RegionIdstring

智能接入网关实例所属的地域 ID。展开详情

示例值:cn-shanghai参考取值来源:
    DescribeRegions
SagIdstring

智能接入网关实例 ID。

示例值:sag-asdfz6ac74oj5v****
Snstring

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

示例值:sag****
TaskNamestring

拨测任务名称。

示例值:test-ping
Typestring

拨测任务类型。取值:展开详情

示例值:Internet
Protocolstring

拨测任务协议,取值:展开详情

示例值:ICMP参考取值来源:
    DescribeSagGlobalRouteProtocol
Domainstring

拨测任务目的域名。展开详情

示例值:www.example.com
Portinteger<int32>

拨测协议端口号。展开详情

示例值:80
PacketNumberinteger<int32>

拨测协议每分钟发包数。展开详情

示例值:10
ProbeTaskSourceAddressstring

私网拨测源地址。展开详情

示例值:192.168.1.1参考取值来源:
    ListProbeTask
Enableboolean

是否启用拨测任务。取值:展开详情

示例值:true

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:324223F3-93D3-4CE4-B26F-66C0C3809922
Codestring

响应码。

示例值:200
Messagestring

响应消息。

示例值:successful
Datastring

创建成功的拨测任务 ID。

示例值:probe-****

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
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.诊断
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.诊断

变更历史

暂无变更历史

相关示例