DescribeApplicationMonitor -

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	DescribeApplicationMonitor	The operation that you want to perform. Set the value to DescribeApplicationMonitor.
RegionId	String	No	cn-hangzhou	The ID of the region where the Global Accelerator (GA) instance is deployed. Set the value to cn-hangzhou.
ClientToken	String	No	123e4567-e89b-12d3-a456-426655440000	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. Note If you do not set this parameter, the system uses RequestId as ClientToken. RequestId may be different for each API request.
TaskId	String	Yes	sm-bp1fpdjfju9k8yr1y****	The ID of the origin probing task.

Response parameters


Parameter	Type	Example	Description
RequestId	String	04F0F334-1335-436C-A1D7-6C044FE73368	The ID of the request.
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.
IspCityList	Array		The list of probe points provided by the service provider.
Isp	String	465	The ID of the probe point provided by the service provider.
IspName	String	Alibaba	The name of the probe point provided by the service provider.
City	String	375	The ID of the city where the probe point provided by the service provider is deployed.
CityName	String	Singapore (Singapore)	The name of the city where the probe point provided by the service provider is deployed.
DetectEnable	Boolean	true	Indicates whether the automatic diagnostics feature is enabled. Valid values: true: yes. false: no
DetectThreshold	Integer	0	The threshold that is used to trigger the automatic diagnostics feature. If the liveness of the origin in percentile drops below the specified threshold, the automatic diagnostics feature is triggered.
DetectTimes	Integer	1	The number of times that is 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 specifies 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.
RegionId	String	cn-hangzhou	The ID of the region where the GA instance is deployed. The value is set to cn-hangzhou.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeApplicationMonitor
&RegionId=cn-hangzhou
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&TaskId=sm-bp1fpdjfju9k8yr1y****
&Common request parameters

Sample success responses

XML format

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

<DescribeApplicationMonitorResponse>
    <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
    <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>
    <IspCityList>
        <Isp>465</Isp>
        <IspName>Alibaba</IspName>
        <City>375</City>
        <CityName>Singapore (Singapore)</CityName>
    </IspCityList>
    <DetectEnable>true</DetectEnable>
    <DetectThreshold>0</DetectThreshold>
    <DetectTimes>1</DetectTimes>
    <SilenceTime>300</SilenceTime>
    <RegionId>cn-hangzhou</RegionId>
</DescribeApplicationMonitorResponse>

JSON format

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

{
  "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",
    "City" : "375",
    "CityName" : "Singapore (Singapore)"
  } ],
  "DetectEnable" : true,
  "DetectThreshold" : 0,
  "DetectTimes" : 1,
  "SilenceTime" : 300,
  "RegionId" : "cn-hangzhou"
}

Error codes

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