All Products
Search

This Product

    Global Accelerator:CreateApplicationMonitor

    Document Center

    Global Accelerator:CreateApplicationMonitor

    Last Updated:Sep 17, 2026

    Creates an origin probing task by calling the CreateApplicationMonitor operation.

    Operation description

    You can call the CreateApplicationMonitor operation to create an origin probing task. This task monitors the end-to-end network quality from probing points through Global Accelerator (GA) to the origin server in real time, helping you quickly locate network faults and perform targeted network optimization.

    Before you call this operation, take note of the following items:

    • Only subscription Alibaba Cloud Global Accelerator (GA) instances of Medium Ⅰ or higher specifications support origin probing nodes.

    • Origin probing nodes cannot be created for UDP protocol listeners.

    • The service port of the monitoring address must be within the listener port range.

    • The CreateApplicationMonitor operation is asynchronous. After you invoke this operation, the system returns a node ID for the origin probing node, but the node is not yet created. The node creation continues in the background. You can invoke DescribeApplicationMonitor or ListApplicationMonitor to query the status of the origin probing node:

      • When an origin probing task is in the init state, the task is being created. In this state, you can only perform query operations and cannot perform other operations.

      • If the origin probing task is in the active state, the task is created.

    • The CreateApplicationMonitor operation does not support concurrent creation of origin probing nodes within the same Alibaba Cloud Global Accelerator (GA) instance.

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

    create

    *ApplicationMonitor

    acs:ga:{#regionId}:{#accountId}:ga/{#gaId}

    *ApplicationMonitor

    acs:ga:{#regionId}:{#accountId}:sitemonitor/*

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    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 a 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 of the API request as the ClientToken. The RequestId may be different for each API request.

    123e4567-e89b-12d3-a456-426655440000
    AcceleratorId

    string

    Yes

    The instance ID of the Alibaba Cloud Global Accelerator (GA) instance to be probed.

    ga-bp1odcab8tmno0hdq****
    ListenerId

    string

    Yes

    The instance ID of the listener to be probed.

    lsr-bp1bpn0kn908w4nbw****
    TaskName

    string

    Yes

    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

    Yes

    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. Unit: %.

    Valid values: 0 to 100.

    Default value: 0, which indicates that automatic diagnostics is not triggered.

    0
    DetectTimes

    integer

    No

    The number of times that the threshold must be reached to trigger automatic diagnostics.

    Valid values: 1 to 20. Default value: 1.

    1
    SilenceTime

    integer

    No

    The silence period for automatic diagnostics. This specifies the interval between automatic diagnostics triggers when the availability does not recover to normal after automatic diagnostics is triggered.

    When the availability rate falls below the automatic diagnostics threshold for consecutive times (the value 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, automatic diagnostics is triggered again.

    Unit: seconds. Valid values: 300 to 86400. Default value: 300.

    300

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

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

    string

    The ID of the origin probing task.

    sm-bp1fpdjfju9k8yr1y****

    Examples

    Success response

    JSON format

    {
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "TaskId": "sm-bp1fpdjfju9k8yr1y****"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 NotExist.Listener The listener does not exist. The listener does not exist.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.