DescribeApplicationMonitor - Global Accelerator - Alibaba Cloud Documentation Center

Queries the detailed information about an origin probing task.

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:DescribeApplicationMonitor	get	ApplicationMonitor acs:ga:{#regionId}:{#accountId}:sitemonitor/{#TaskId}	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
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.	123e4567-e89b-12d3-a456-426655440000
TaskId	string	Yes	The ID of the origin probing task.	sm-bp1fpdjfju9k8yr1y****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
AcceleratorId	string	The ID of the GA instance on which the origin probing task ran.	ga-bp1odcab8tmno0hdq****
ListenerId	string	The ID of the listener on which the origin probing task ran.	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 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 }
IspCityList	array<object>	The probe points of the Internet service provider (ISP).
	object
Isp	string	The probe point ID of the ISP.	465
IspName	string	The probe point name of the ISP.	Alibaba
City	string	The ID of the city in which the probe point of the ISP is deployed.	375
CityName	string	The name of the city in which the probe point of the ISP is deployed.	Singapore
DetectEnable	boolean	Indicates whether the automatic diagnostics feature is enabled. Valid values: true false	true
DetectThreshold	integer	The threshold that is used to trigger automatic diagnostics. If the availability of the origin server drops below the specified threshold, the automatic diagnostics feature is triggered.	0
DetectTimes	integer	The number of times that are required to reach the threshold before the automatic diagnostics feature is 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 automatic diagnostics, 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 automatic diagnostics threshold reaches the value of DetectTimes, the automatic diagnostics feature is triggered. The automatic diagnostics feature is not triggered again within the silence period regardless of whether the availability rate remains 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
RegionId	string	The region ID of the GA instance. Set the value to cn-hangzhou.	cn-hangzhou
State	string	The status of the origin probing task. Valid values: init active updating inactive deleting	active

Examples

Sample success responses

JSONformat

{
  "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": "Alibaba\n",
      "City": "375",
      "CityName": "Singapore\n"
    }
  ],
  "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.

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-10-12	The response structure of the API has changed	View Change Details