Modifies an origin probing task.
Description
UpdateApplicationMonitor is an asynchronous operation. After you send a request, the system returns a request ID, but this operation is still being performed in the system background. You can call the DescribeApplicationMonitor or ListApplicationMonitor operation to check whether the configurations of an origin probing task are modified.
- If the values of modified parameters remain unchanged, it indicates that the origin probing task is being modified. In this case, you can perform only query operations.
- If the values of modified parameters change, it indicates that the origin probing task is modified.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | UpdateApplicationMonitor |
The operation that you want to perform. Set the value to UpdateApplicationMonitor. |
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. ClientToken can contain only ASCII characters. Note If you do not set this parameter, ClientToken is set to the value of RequestId. The value of RequestId may be different for each API request.
|
TaskId | String | Yes | sm-bp1fpdjfju9k8yr1y**** |
The ID of the origin probing task that you want to modify. |
ListenerId | String | No | lsr-bp1bpn0kn908w4nbw**** |
The ID of the listener that you want to modify. The listener runs the origin probing task. |
TaskName | String | No | task1 |
The name of the origin probing task. The name must be 4 to 100 characters in length, and can contain digits, underscores (_), and hyphens (-). It must start with a letter. |
Address | String | No | https://www.aliyun.com |
The URL or IP address that you want to probe. |
OptionsJson | String | No | { "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. |
DetectEnable | Boolean | No | false |
Specifies whether to enable the automatic diagnostics feature. Default value: false. Valid values:
|
DetectThreshold | Integer | No | 0 |
Set 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. Valid values: 0 to 100. |
DetectTimes | Integer | No | 1 |
The number of times that are required to reach the threshold before the automatic diagnostics feature can be triggered. Valid values: 1 to 20. |
SilenceTime | Integer | No | 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. Valid values: 300 to 86400. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 04F0F334-1335-436C-A1D7-6C044FE73368 |
The ID of the request. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=UpdateApplicationMonitor
&RegionId=cn-hangzhou
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&TaskId=sm-bp1fpdjfju9k8yr1y****
&ListenerId=lsr-bp1bpn0kn908w4nbw****
&TaskName=task1
&Address=https://www.aliyun.com
&OptionsJson={ "http_method": "get","header": "key:asd","acceptable_response_code": "500","cert_verify": true }
&DetectEnable=false
&DetectThreshold=0
&DetectTimes=1
&SilenceTime=300
&Common request parameters
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<UpdateApplicationMonitorResponse>
<RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
</UpdateApplicationMonitorResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "04F0F334-1335-436C-A1D7-6C044FE73368"
}
Error codes
For a list of error codes, visit the Error Center.