Configures latency monitoring on an endpoint.

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 a sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ConfigEndpointProbe

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

RegionId String Yes cn-hangzhou

The ID of the region where the Global Accelerator (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 ensure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

EndpointGroupId String Yes epg-bp1dmlohjjz4kqaun****

The ID of the endpoint group.

EndpointType String Yes Ip

The type of the endpoint. Valid values:

  • Ip: a custom IP address
  • Domain: a custom domain name
  • EIP: an Alibaba Cloud elastic IP address (EIP)
  • PublicIp: an Alibaba Cloud public IP address
  • ECS: an Alibaba Cloud Elastic Compute Service (ECS) instance
  • SLB: an Alibaba Cloud Server Load Balancer (SLB) instance
Endpoint String Yes 127.XX.XX.21

The endpoint.

ProbeProtocol String No tcp

The protocol that is used to monitor latency. Valid values:

  • tcp
  • icmp
ProbePort String No 80

The port that is used to monitor latency. Valid values: 0 to 65535.

Enable String Yes true

Specifies whether to enable latency monitoring. Valid values: true and false. Default value: false.

Response parameters

Parameter Type Example Description
RequestId String 6FEA0CF3-D3B9-43E5-A304-D217037876A8

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ConfigEndpointProbe
&RegionId=cn-hangzhou
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&EndpointGroupId=epg-bp1dmlohjjz4kqaun****
&EndpointType=Ip
&Endpoint=127.XX.XX.21
&ProbeProtocol=tcp
&ProbePort=80
&Enable=true
&<Common request parameters>

Sample responses

XML format

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

<ConfigEndpointProbeResponse>
    <RequestId>6FEA0CF3-D3B9-43E5-A304-D217037876A8</RequestId>
</ConfigEndpointProbeResponse>

JSON format

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

{
  "RequestId" : "6FEA0CF3-D3B9-43E5-A304-D217037876A8"
}

Error codes

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