1. 接口描述
接口请求域名: clb.api3.gsesgpucloud.com。
DescribeTargetHealth 接口用来获取负载均衡后端服务的健康检查结果,不支持传统型负载均衡。
默认接口请求频率限制:20次/秒。
接口更新时间:2020-01-10 20:44:19。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
参数名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Action | 是 | 否 | String | 公共参数,本接口取值:DescribeTargetHealth |
Version | 是 | 否 | String | 公共参数,本接口取值:2018-03-17 |
Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
LoadBalancerIds | 是 | 否 | Array of String | 要查询的负载均衡实例 ID列表 示例值: ["lb-qc2iq5yc\n"] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
LoadBalancers | LoadBalancerHealth | 负载均衡实例列表 示例值:查看 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
错误码 | 描述 |
---|---|
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误 |
InternalError | 内部错误 |
UnauthorizedOperation | 未授权操作 |
FailedOperation | 操作失败 |
InvalidParameter.LBIdNotFound | 负载均衡实例ID错误。 |
InvalidParameter.FormatError | 参数格式错误。 |
InvalidParameterValue.Length | 参数长度错误。 |