All Products
Search

This Product

    Global Accelerator:DescribeApplicationMonitor

    Document Center

    Global Accelerator:DescribeApplicationMonitor

    Last Updated:Mar 31, 2026

    Queries the detailed information about an origin probing task.

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

    get

    *ApplicationMonitor

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    No

    The ID of the region where the Global Accelerator (GA) instance is deployed. 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 token can contain only ASCII characters and cannot exceed 64 characters in length.

    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
    TaskId

    string

    Yes

    The ID of the origin probing task.

    sm-bp1fpdjfju9k8yr1y****

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

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

    string

    The ID of the GA instance on which the origin probing task ran.

    ga-bp1odcab8tmno0hdq****
    ListenerId

    string

    The ID of the listener on which the origin probing task ran.

    lsr-bp1bpn0kn908w4nbw****
    TaskId

    string

    The ID of the origin probing task.

    sm-bp1fpdjfju9k8yr1y****
    TaskName

    string

    The name of the origin probing task.

    task1
    Address

    string

    The URL or IP address that was probed.

    https://www.aliyun.com
    OptionsJson

    string

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

    array<object>

    The probe points of the Internet service provider (ISP).

    object

    Isp

    string

    The probe point ID of the ISP.

    465
    IspName

    string

    The probe point name of the ISP.

    Alibaba

    City

    string

    The ID of the city in which the probe point of the ISP is deployed.

    375
    CityName

    string

    The name of the city in which the probe point of the ISP is deployed.

    Singapore

    DetectEnable

    boolean

    Indicates whether the automatic diagnostics feature is enabled. Valid values:

    • true

    • false

    true
    DetectThreshold

    integer

    The threshold that is used to trigger automatic diagnostics.

    If the availability of the origin server drops below the specified threshold, the automatic diagnostics feature is triggered.

    0
    DetectTimes

    integer

    The number of times that are required to reach the threshold before the automatic diagnostics feature is triggered.

    1
    SilenceTime

    integer

    The silence period of the automatic diagnostics feature. This parameter indicates the interval at which the automatic diagnostics feature is triggered. If the availability rate does not return to normal after GA triggers automatic diagnostics, 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 automatic diagnostics threshold reaches the value of DetectTimes, the automatic diagnostics feature is triggered. The automatic diagnostics feature is not triggered again within the silence period regardless of whether the availability rate remains 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.

    300
    RegionId

    string

    The region ID of the GA instance. Set the value to cn-hangzhou.

    cn-hangzhou
    State

    string

    The status of the origin probing task. Valid values:

    • init

    • active

    • updating

    • inactive

    • deleting

    active

    Examples

    Success response

    JSON format

    {
  "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"
    }
  ],
  "DetectEnable": true,
  "DetectThreshold": 0,
  "DetectTimes": 1,
  "SilenceTime": 300,
  "RegionId": "cn-hangzhou",
  "State": "active"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 NoPermission No permissions. No permissions.
    400 NotExist.SiteMonitor The siteMonitor %s is not exist. Site monitoring% s does not exist.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.