Use DescribeApplicationMonitor to query the details of an origin probing task - Global Accelerator - Alibaba Cloud - Global Accelerator

Queries the details of an origin probing task by calling the DescribeApplicationMonitor operation.

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:DescribeApplicationMonitor

get

*ApplicationMonitor

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the Alibaba Cloud Global Accelerator (GA) instance. Set the value to cn-hangzhou.	cn-hangzhou
ClientToken	string	No	The client token that is used to ensure the idempotence of a request. The client generates the value of this parameter. Ensure that the value is unique among different requests. The value can contain up to 64 ASCII characters. Note If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.	123e4567-e89b-12d3-a456-426655440000
TaskId	string	Yes	The ID of the origin probing task.	sm-bp1fpdjfju9k8yr1y****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
AcceleratorId	string	The instance ID of the Alibaba Cloud Global Accelerator (GA) instance that is associated with the origin probing node.	ga-bp1odcab8tmno0hdq****
ListenerId	string	The instance ID of the listener instance that is associated with the origin probing node.	lsr-bp1bpn0kn908w4nbw****
TaskId	string	The ID of the origin probing task.	sm-bp1fpdjfju9k8yr1y****
TaskName	string	The name of the origin probing task.	task1
Address	string	The URL or IP address to be probed.	https://www.aliyun.com
OptionsJson	string	The advanced extension options for the listener protocol type of the origin probing task. Different listener protocol types correspond to different extension options.	{ "http_method": "get","header": "key:asd","acceptable_response_code": "500","cert_verify": true }
IspCityList	array<object>	The list of ISP detection points.
	object	The list of ISP detection points.
Isp	string	The ID of the ISP detection point.	465
IspName	string	The name of the ISP detection point.	Alibaba
City	string	The ID of the city where the ISP detection point is located.	375
CityName	string	The name of the city where the ISP detection point is located.	Singapore
DetectEnable	boolean	Indicates whether the automatic diagnostics feature is enabled. true: Enabled. false: Disabled.	true
DetectThreshold	integer	The threshold that triggers automatic diagnostics. Automatic diagnostics is triggered when the origin availability rate falls below the threshold.	0
DetectTimes	integer	The number of times the threshold must be reached to trigger automatic diagnostics.	1
SilenceTime	integer	The silence period for automatic diagnostics. This specifies the interval between automatic diagnostics triggers when the availability rate has not recovered to normal after automatic diagnostics is triggered. When the availability rate falls below the automatic diagnostics threshold for consecutive times (the value specified by DetectTimes), automatic diagnostics is triggered. If the availability rate remains below the threshold during the silence period, automatic diagnostics is not triggered again within the silence period. If the availability rate has not recovered to normal after the silence period ends, automatic diagnostics is triggered again. Unit: seconds.	300
RegionId	string	The region ID of the Alibaba Cloud Global Accelerator (GA) instance. Set the value to cn-hangzhou.	cn-hangzhou
State	string	The status of the origin probing task. Valid values: init: Initializing. active: Active. updating: Being configured. inactive: Inactive. deleting: Being deleted.	active

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "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 }",
  "IspCityList": [
    {
      "Isp": "465",
      "IspName": "阿里巴巴",
      "City": "375",
      "CityName": "新加坡"
    }
  ],
  "DetectEnable": true,
  "DetectThreshold": 0,
  "DetectTimes": 1,
  "SilenceTime": 300,
  "RegionId": "cn-hangzhou",
  "State": "active"
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	No permissions.	No permissions.
400	NotExist.SiteMonitor	The siteMonitor %s is not exist.	Site monitoring% s does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.