Query origin probing tasks with ListApplicationMonitor - Global Accelerator - Alibaba Cloud - Global Accelerator

Queries origin probing tasks.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ga:ListApplicationMonitor

list

*ApplicationMonitor

acs:ga:{#regionId}:{#accountId}:sitemonitor/*

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.	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 elements

Element	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.	1
DetectTimes	integer	The number of times that are required to reach the threshold before the automatic diagnostics feature can be triggered.	1
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

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.