Queries origin probing tasks.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListApplicationMonitor

The operation that you want to perform. Set the value to ListApplicationMonitor.

RegionId String No cn-hangzhou

The region where the Global Accelerator (GA) instance is deployed. Set the value to cn-hangzhou.

PageNumber Integer No 1

The number of the page to return. Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Maximum value: 100. Default value: 10.

SearchValue String No aliyun

The keyword that is used to search for origin probing tasks. You can enter a URL, an IP address, the ID of a GA instance, or the ID of a listener to perform a fuzzy match.

Response parameters

Parameter Type Example Description
RequestId String 04F0F334-1335-436C-A1D7-6C044FE73368

The ID of the request.

TotalCount Integer 1

The total number of entries returned.

PageSize Integer 10

The number of entries returned per page.

PageNumber Integer 1

The page number of the returned page.

ApplicationMonitors Array of ApplicationMonitor

The list of origin probing tasks.

AcceleratorId String ga-bp1odcab8tmno0hdq****

The ID of the GA instance on which the origin probing task runs.

ListenerId String lsr-bp1bpn0kn908w4nbw****

The ID of the listener on which the origin probing task runs.

TaskId String sm-bp1fpdjfju9k8yr1y****

The ID of the origin probing task.

TaskName String task1

The name of the origin probing task.

Address String https://www.aliyun.com

The URL or IP address that is probed.

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

The extended options of the listener protocol that is used by the origin probing task. The options vary based on the listener protocol.

DetectEnable Boolean true

Indicates whether the automatic diagnostics feature is enabled. Valid values:

  • true: yes
  • false: no
DetectThreshold Integer 1

The threshold that is used to trigger the automatic diagnostics feature.

DetectTimes Integer 1

The number of times that are required to reach the threshold before the automatic diagnostics feature can be triggered.

SilenceTime Integer 300

The silence period of the automatic diagnostics feature. This parameter indicates the interval at which the automatic diagnostics feature is triggered. If the availability rate does not return to normal after GA triggers an automatic diagnostic, GA must wait until the silence period ends before GA can trigger another automatic diagnostic.

If the number of consecutive times that the availability rate drops below the threshold of automatic diagnostics reaches the value of the DetectTimes parameter, the automatic diagnostics feature is triggered. The automatic diagnostics feature is not triggered again within the silence period even if the availability rate stays below the threshold. If the availability rate does not return to normal after the silence period ends, the automatic diagnostics feature is triggered again.

Unit: seconds.

State String active

The state of the origin probing task. Valid values:

  • active: The origin probing task is running.
  • inactive: The origin probing task is stopped.
  • init: The origin probing task is being initialized.
  • deleting: The origin probing task is being deleted.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListApplicationMonitor
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=10
&SearchValue=aliyun
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format 

HTTP/1.1 200 OK
Content-Type:application/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" : 1,
    "DetectTimes" : 1,
    "SilenceTime" : 300,
    "State" : "active"
  } ]
}

Error codes

For a list of error codes, visit the API Error Center.