Use UpdateApplicationMonitor to modify an origin probing task - Global Accelerator - Alibaba Cloud - Global Accelerator

Modifies the configuration of an origin probing task by calling the UpdateApplicationMonitor operation.

Operation description

UpdateApplicationMonitor is an asynchronous operation. After you call this operation, the system returns a request ID, but the origin probing task is not yet modified. The modification task continues to run in the background. You can call DescribeApplicationMonitor or ListApplicationMonitor to check whether the origin probing task configuration has been modified:

If the modified parameter values have not changed, the origin probing task is still being modified. In this case, you can only perform query operations and cannot perform other operations.
If the modified parameter values have changed, the origin probing task has been modified.

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

update

*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 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 client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId value as the ClientToken value. The RequestId value of each API request is different.	123e4567-e89b-12d3-a456-426655440000
TaskId	string	Yes	The ID of the origin probing task that you want to modify.	sm-bp1fpdjfju9k8yr1y****
ListenerId	string	No	The instance ID of the listener associated with the origin probing task that you want to modify.	lsr-bp1bpn0kn908w4nbw****
TaskName	string	No	The name of the origin probing task. The name must be 1 to 128 characters in length and must start with a letter or a Chinese character. It can contain digits, periods (.), underscores (_), and hyphens (-).	task1
Address	string	No	The URL or IP address to be probed.	https://www.aliyun.com
OptionsJson	string	No	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 }
DetectEnable	boolean	No	Specifies whether to enable the automatic diagnostics feature. Valid values: true: Enabled. false (default): Disabled.	false
DetectThreshold	integer	No	The threshold that triggers automatic diagnostics. When the origin availability rate falls below this threshold, automatic diagnostics is triggered. Valid values: 0 to 100.	0
DetectTimes	integer	No	The number of consecutive times that the availability rate must fall below the threshold before automatic diagnostics is triggered. Valid values: 1 to 20.	1
SilenceTime	integer	No	The silence period for automatic diagnostics. This specifies the interval between automatic diagnostics triggers when the availability rate does not recover to normal after diagnostics is triggered. When the availability rate falls below the automatic diagnostics threshold for consecutive times (as 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 after the silence period expires, automatic diagnostics is triggered again. Unit: seconds. Valid values: 300 to 86400.	300

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidateTaskId.ApplicationMonitor	The application monitor task %s is not exist.	The source station probe task ID does not exist.
400	NotExist.Listener	listener %s is not exist	The listener %s does not exist.
400	NotActive.Listener	listener %s is not active	The listener %s is unavailable.
400	ListenerNotSupport.ApplicationMonitor	when the listener protocol is udp, application monitor is not supported.	Origin probing tasks do not support UDP listeners.
400	InvalidatePort.ApplicationMonitor	The address port not in listener port range.	The port of the domain name that is probed is not within the port range of the listener.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.