文档

CreateApplicationMonitor - 创建源站探测任务

更新时间:

调用CreateApplicationMonitor接口创建源站探测任务。

接口说明

您可以使用 CreateApplicationMonitor 接口创建源站探测任务,实时监测从探测点经过全球加速至源站的全链路网络质量,从而快速定位网络故障,针对性的进行网络优化。

调用本接口,请注意以下事项:

  • 仅包年包月、中型Ⅰ及以上规格的标准型全球加速实例支持创建源站探测任务。

  • 不支持为 UDP 协议监听创建源站探测任务。

  • 监控地址的服务端口需在监听端口范围内。

  • CreateApplicationMonitor 接口属于异步接口,即系统会先返回一个源站探测的任务 ID,但源站探测任务并未创建完成,系统后台的创建任务仍在进行。您可以调用 DescribeApplicationMonitorListApplicationMonitor 查询源站探测任务的状态:

    • 当源站探测任务处于 init 状态时,表示源站探测任务正在创建中,在该状态下,您只能执行查询操作,不能执行其他操作。

    • 当源站探测任务处于 active 状态时,表示源站探测任务创建完成。

  • CreateApplicationMonitor 接口不支持在同一个全球加速实例内并发创建源站探测任务。

调试

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

授权信息

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

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

请求参数

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

全球加速实例所属的地域 ID,仅取值:cn-hangzhou

cn-hangzhou
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567-e89b-12d3-a456-426655440000
AcceleratorIdstring

需要探测的全球加速实例 ID。

ga-bp1odcab8tmno0hdq****
ListenerIdstring

需要探测的监听实例 ID。

lsr-bp1bpn0kn908w4nbw****
TaskNamestring

源站探测的任务名称。

名称长度为 1~128 个字符,以大小写字母或中文开头,可包含数字、半角句号(.)下划线(_)和短划线(-)。

task1
Addressstring

需要探测的 URL 或 IP 地址。

https://www.aliyun.com
OptionsJsonstring

源站探测任务对应监听协议类型的高级扩展选项。不同源站探测任务的监听协议类型对应不同的扩展选项。

{ "http_method": "get","header": "key:asd","acceptable_response_code": "500","cert_verify": true }
DetectEnableboolean

是否开启自动诊断功能。取值:

  • true:是。

  • false(默认值):否。

false
DetectThresholdinteger

设置自动诊断触发阈值。单位:%。

取值范围:0~100

默认值:0,表示不触发自动诊断。

0
DetectTimesinteger

触发自动诊断需要达到触发阈值的次数。

取值范围:1~20。默认值:1

1
SilenceTimeinteger

自动诊断触发沉默时间。表示自动诊断触发后,未恢复到正常,间隔多久触发一次自动诊断。

可用率连续多次(即设置的 DetectTimes)低于自动诊断触发阈值时,触发自动诊断,如果可用率在自动诊断触发沉默时间内持续低于自动诊断触发阈值,在自动诊断触发沉默时间内不会重复出发自动诊断;如果可用率在自动诊断触发沉默时间后仍未恢复正常,则再次触发自动诊断。

单位:秒。取值范围:300~86400。默认值:300

300

返回参数

名称类型描述示例值
object

返回请求列表。

RequestIdstring

请求 ID。

04F0F334-1335-436C-A1D7-6C044FE73368
TaskIdstring

源站探测的任务 ID。

sm-bp1fpdjfju9k8yr1y****

示例

正常返回示例

JSON格式

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "TaskId": "sm-bp1fpdjfju9k8yr1y****"
}

错误码

HTTP status code错误码错误信息描述
400NotExist.ListenerThe listener does not exist.监听器不存在

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

变更历史

变更时间变更内容概要操作
2023-04-20OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
  • 本页导读 (1)
文档反馈