ListApplicationMonitor - 查询源站探测任务列表

调用ListApplicationMonitor接口查询源站探测任务列表。

调试

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

授权信息

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

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

请求参数

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

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

cn-hangzhou
PageNumberinteger

列表的页码。默认值:1

PageSizeinteger

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

10
SearchValuestring

源站探测任务搜索关键字。支持按照 URL、IP 地址、全球加速实例 ID 和监听 ID 模糊搜索。

aliyun

返回参数

名称类型描述示例值
object

返回请求列表。

RequestIdstring

请求 ID。

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

总列表条目数。

1
PageSizeinteger

分页查询时每页的行数。

10
PageNumberinteger

列表的页码。

1
ApplicationMonitorsarray<object>

源站探测任务列表。

object

源站探测任务列表。

AcceleratorIdstring

源站探测任务对应的全球加速实例 ID。

ga-bp1odcab8tmno0hdq****
ListenerIdstring

源站探测任务对应的监听实例 ID。

lsr-bp1bpn0kn908w4nbw****
TaskIdstring

源站探测任务 ID。

sm-bp1fpdjfju9k8yr1y****
TaskNamestring

源站探测的任务名称。

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:否。

true
DetectThresholdinteger

自动诊断触发阈值。

DetectTimesinteger

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

SilenceTimeinteger

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

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

单位:秒。

300
Statestring

源站探测任务状态。

  • active:启用。

  • inactive:停用。

  • init:初始化。

  • deleting:删除中。

active

示例

正常返回示例

JSON格式

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "TotalCount": 1,
  "PageSize": 10,
  "PageNumber": 1,
  "ApplicationMonitors": [
    {
      "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
      "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
      "TaskId": "sm-bp1fpdjfju9k8yr1y****",
      "TaskName": "task1",
      "Address": "https://www.aliyun.com",
      "OptionsJson": "{ \"http_method\": \"get\",\"header\": \"key:asd\",\"acceptable_response_code\": \"500\",\"cert_verify\": true }",
      "DetectEnable": true,
      "DetectThreshold": 0,
      "DetectTimes": 0,
      "SilenceTime": 300,
      "State": "active"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400NoPermissionNo permissions.无权限

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

变更历史

变更时间变更内容概要操作
2024-07-23OpenAPI 错误码发生变更查看变更详情
2023-07-20API 内部配置变更,不影响调用查看变更详情