1. Interface Description
Interface request domain name: clb.api3.convergecloud.com.
This API (DescribeTargetHealth) is used to query the health check result of a real server of a CLB instance. It is not supported by Classic CLB.
Default interface request rate limit: 20 times per second.
Interface update time: 2020-01-10 20:44:19.
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: DescribeTargetHealth |
| 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 |
| LoadBalancerIds | Yes | No | Array of String | The CLB instance ID list to query Example: ["lb-qc2iq5yc"] |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| LoadBalancers | Array of LoadBalancerHealth | CLB instance list 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.LBIdNotFound | CLB instance ID error. |
| InvalidParameter.FormatError | Incorrect parameter format |
| InvalidParameterValue.Length | Invalid parameter length. |