All Products
Search
Document Center

Global Accelerator:ConfigEndpointProbe

Last Updated:Apr 10, 2024

Configures latency monitoring for an endpoint.

Operation description

  • ConfigEndpointProbe is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the DescribeEndpointGroup operation to query the status of the endpoint group to which an endpoint belongs and determine whether latency monitoring is configured for the endpoint.

    • If the endpoint group is in the updating state, it indicates that latency monitoring is being configured for the endpoint. In this case, you can perform only query operations.
    • If the endpoint group is in the active state, it indicates that latency monitoring is configured for the endpoint.
  • The ConfigEndpointProbe operation holds an exclusive lock on the Global Accelerator (GA) instance. While the operation is in progress, you cannot call the same operation in the same Alibaba Cloud account.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the GA instance. Set the value 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
EndpointGroupIdstringYes

The endpoint group ID.

epg-bp1dmlohjjz4kqaun****
EndpointTypestringYes

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.
Ip
EndpointstringYes

The endpoint.

127.0.XX.XX
ProbeProtocolstringNo

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

  • tcp: TCP.
  • icmp: ICMP.
tcp
ProbePortstringNo

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

80
EnablestringYes

Specifies whether to enable latency monitoring. Valid values:

  • true
  • false (default)
true

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

6FEA0CF3-D3B9-43E5-A304-D217037876A8

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history