ListApplicationMonitor - Global Accelerator - Alibaba Cloud Documentation Center

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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ga:ListApplicationMonitor	list	ApplicationMonitor acs:ga:{#regionId}:{#accountId}:sitemonitor/*	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region where the Global Accelerator (GA) instance is deployed. Set the value to cn-hangzhou.	cn-hangzhou
PageNumber	integer	No	The page number. Default value: 1.	１
PageSize	integer	No	The number of entries per page. Maximum value: 100. Default value: 10.	10
SearchValue	string	No	The keyword that is used to search for origin probing tasks. You can enter a URL, an IP address, a GA instance ID, or a listener ID to perform a fuzzy match.	aliyun

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
TotalCount	integer	The total number of entries returned.	1
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
ApplicationMonitors	array<object>	The list of origin probing tasks.
	object
AcceleratorId	string	The ID of the GA instance on which the origin probing task runs.	ga-bp1odcab8tmno0hdq****
ListenerId	string	The ID of the listener on which the origin probing task runs.	lsr-bp1bpn0kn908w4nbw****
TaskId	string	The origin probing task ID.	sm-bp1fpdjfju9k8yr1y****
TaskName	string	The origin probing task name.	task1
Address	string	The URL or IP address that was probed.	https://www.aliyun.com
OptionsJson	string	The extended options of the listener protocol that is used by the origin probing task. The options vary based on the listener protocol.	{ "http_method": "get","header": "key:asd","acceptable_response_code": "500","cert_verify": true }
DetectEnable	boolean	Indicates whether the automatic diagnostics feature is enabled. Valid values: true false	true
DetectThreshold	integer	The threshold that is used to trigger the automatic diagnostics feature.	１
DetectTimes	integer	The number of times that are required to reach the threshold before the automatic diagnostics feature can be triggered.	１
SilenceTime	integer	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 task, GA must wait until the silence period ends before GA can trigger another automatic diagnostic task. If the number of consecutive times that the availability rate drops below the threshold of automatic diagnostics reaches the value of DetectTimes , 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.	300
State	string	The status 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.	active

Examples

Sample success responses

JSONformat

{
  "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"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	No permissions.	No permissions.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-07-23	The Error code has changed	View Change Details
2023-07-20	The internal configuration of the API is changed, but the call is not affected	View Change Details