All Products
Search

This Product

    Global Accelerator:UpdateApplicationMonitor

    Document Center

    Global Accelerator:UpdateApplicationMonitor

    Last Updated:Apr 28, 2024

    Modifies an origin probing task.

    Operation 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

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    ga:UpdateApplicationMonitorWrite
    • ApplicationMonitor
      acs:ga:{#regionId}:{#accountId}:sitemonitor/{#TaskId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringNo

    The ID of the region where the Global Accelerator (GA) instance is deployed. The value is set to cn-hangzhou.

    		cn-hangzhou
    ClientTokenstringNo

    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.

    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
    TaskIdstringYes

    The ID of the origin probing task that you want to modify.

    		sm-bp1fpdjfju9k8yr1y****
    ListenerIdstringNo

    The ID of the listener that you want to modify. The listener runs the origin probing task.

    		lsr-bp1bpn0kn908w4nbw****
    TaskNamestringNo

    The name of the origin probing task.

    The name must be 1 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.

    		task1
    AddressstringNo

    The URL or IP address that is probed.

    		https://www.aliyun.com
    OptionsJsonstringNo

    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 }
    DetectEnablebooleanNo

    Specifies whether to enable the automatic diagnostics feature. Valid values:

    • true
    • false (default)
    		false
    DetectThresholdintegerNo

    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.

    		0
    DetectTimesintegerNo

    The number of times that the threshold must be reached before the automatic diagnostics feature is triggered.

    Valid values: 1 to 20.

    		1
    SilenceTimeintegerNo

    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 task, GA must wait until the silence period ends before GA can trigger another automatic diagnostic task.

    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.

    		300

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The ID of the request.

    		04F0F334-1335-436C-A1D7-6C044FE73368

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    No change history