查询IP组列表
更新时间:2022-06-24
接口描述
本接口用于查询IP组列表。
请求结构
GET /v2/appblb/{blbId}/ipgroup?name={name}&exactlyMatch={exactlyMatch}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
Host: bec.baidubce.com
Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
---|---|---|---|---|
blbId | 负载均衡ID | path | 是 | string |
exactlyMatch | 设置name是否完全匹配 | query | 否 | boolean |
marker | 标记查询的起始位置 | query | 否 | string |
maxKeys | 每页包含的最大数量,1-1000,默认1000 | query | 否 | integer |
name | IP组名称 | query | 否 | string |
响应头域
除公共头域外,无其它特殊头域。
响应参数
参数名称 | 参数说明 | 类型 |
---|---|---|
appIpGroupList | IP组列表响应 | array |
backendPolicyList | 关联的IP组协议列表 | array |
healthCheck | 健康检查协议类型,TCP、HTTP、UDP | string |
healthCheckDownRetry | 不健康阈值,即连续多少次健康检查失败后,屏蔽该后端服务器。 | integer |
healthCheckHost | 健康检查host | string |
healthCheckIntervalInSecond | 健康检查间隔(单位:秒) | integer |
healthCheckNormalStatus | 健康检查正常时的HTTP状态码 | string |
healthCheckPort | 健康检查端口 | integer |
healthCheckTimeoutInSecond | 健康检查超时(单位:秒) | integer |
healthCheckUpRetry | 健康阈值,即连续多少次健康检查成功后,重新将该后端服务器置为可用。 | integer |
healthCheckUrlPath | 健康检查路径 | string |
id | IP组协议ID | string |
type | IP组协议类型,TCP、HTTP、UDP | string |
udpHealthCheckString | udp健康检查字符串 | string |
desc | IP组描述 | string |
id | IP组ID | string |
name | IP组名称 | string |
isTruncated | true表示后面还有数据,false表示已经是最后一页 | boolean |
marker | 标记查询的起始位置 | string |
maxKeys | 每页包含的最大数量 | integer |
nextMarker | 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现 | string |
错误码
请参照错误返回章节的内容。
请求示例
GET /v2/appblb/applb-cn-hangzhou-cm-cmqypbkj/ipgroup HTTP/1.1
Host: bec.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:28:11 GMT
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
Server: BWS
{
"isTruncated": false,
"maxKeys": 1000,
"appIpGroupList": [
{
"id": "bec_ip_group-r8yc3lg1",
"name": "ipgroupametest",
"desc": "desc",
"backendPolicyList": [
{
"id": "bec_ip_group_policy-mdypveqe",
"type": "TCP",
"healthCheck": "TCP",
"healthCheckPort": 80,
"healthCheckUrlPath": "/",
"healthCheckTimeoutInSecond": 10,
"healthCheckIntervalInSecond": 3,
"healthCheckDownRetry": 4,
"healthCheckUpRetry": 5
}
]
}
]
}