Creates an origin probing task.

Description

You can call the CreateApplicationMonitor operation to create an origin probing task. An origin probing task monitors the network quality between the client and origin server and checks the availability of the origin.

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

  • CreateApplicationMonitor is an asynchronous operation. After you send a request, the system returns the ID of an origin probing task, but the origin probing task is still being created in the system background. You can call the DescribeApplicationMonitor or ListApplicationMonitor operation to query the state of the origin probing task.
    • If the origin probing task is in the init state, it indicates that the task is being created. In this case, you can only perform query operations.
    • If the origin probing task is in the active state, it indicates that the task is created.
  • The CreateApplicationMonitor operation cannot be called repeatedly for the same Global Accelerator (GA) instance within a specific period of time.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateApplicationMonitor

The operation that you want to perform. Set the value to CreateApplicationMonitor.

RegionId String Yes cn-hangzhou

The ID of the region where the 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.
AcceleratorId String Yes ga-bp1odcab8tmno0hdq****

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

ListenerId String Yes lsr-bp1bpn0kn908w4nbw****

The ID of the listener on which to execute the origin probing task.

TaskName String Yes 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 Yes https://www.aliyun.com

The URL or IP address that you want to probe.

OptionsJson String No null

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:

  • true: yes
  • false: no
DetectThreshold Integer No 0

The threshold that is used to trigger the automatic diagnostics feature. Unit: %.

Valid values: 0 to 100.

The default value is 0, which indicates that the automatic diagnostics feature is not triggered.

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. Default value: 1.

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. Default value: 300.

Response parameters

Parameter Type Example Description
RequestId String 04F0F334-1335-436C-A1D7-6C044FE73368

The ID of the request.

TaskId String sm-bp1fpdjfju9k8yr1y****

The ID of the origin probing task.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateApplicationMonitor
&RegionId=cn-hangzhou
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&AcceleratorId=ga-bp1odcab8tmno0hdq****
&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

<CreateApplicationMonitorResponse>
    <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
    <TaskId>sm-bp1fpdjfju9k8yr1y****</TaskId>
</CreateApplicationMonitorResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HttpCode Error code Error message Description
400 NotExist.Listener The listener does not exist. The error message returned because the specified listener does not exist.

For a list of error codes, visit the API Error Center.