DescribeTargets

Last Updated At: 2026-08-02 00:05:23

1. Interface Description

Interface request domain name: clb.api3.convergecloud.com.

This API (DescribeTargets) is used to query the list of real servers bound to some listeners of a CLB instance.

Default interface request rate limit: 20 times per second.

Interface update time: 2020-01-10 20:37:15.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DescribeTargets
Version Yes No String Public parameter, The value of this interface: 2018-03-17
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
LoadBalancerId Yes No String CLB instance ID
Example: lb-10iq9lou
ListenerIds No No Array of String List of listener IDs
Example: ["lbl-4fo6k8na"]
Protocol No No String Listener protocol type, supporting TCP, UDP, HTTP, HTTPS, and TCP_SSL.
Example: HTTP
Port No No Int64 Listener port
Example: 80

3. Output Parameters

Parameter name Type Description
Listeners Array of ListenerBackend Information of real servers bound to the listener
Example:View
RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

4. Error Code

The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

Error Code Description
InvalidParameter Wrong parameter.
InvalidParameterValue Incorrect parameter value
InternalError Internal Error
UnauthorizedOperation Unauthorized operation
FailedOperation Failed to operate.
InvalidParameter.FormatError Incorrect parameter format
InvalidParameterValue.Length Invalid parameter length.