GetLBVip¶
获取负载均衡器虚拟服务地址(VIP)的详细信息
指定负载均衡器虚拟服务地址ID,可以返回虚拟服务地址的详细信息,如果不指定虚拟服务地址ID,则返回错误信息。
Request Parameters
Parameter name | Type | Description | Required |
---|---|---|---|
action | String | API 标识符 | Yes |
obj_id | String | 虚拟服务地址ID | Yes |
Response Elements
Name | Type | Description |
---|---|---|
message | String | 执行结果信息 |
code | Integer | HTTP Resonpe响应状态码 |
data | Array | JSON 格式的虚拟服务地址信息,每项参数可见下面 Data Item |
Data Item
Name | Type | Description |
---|---|---|
description | String | 虚拟服务地址描述 |
admin_state_up | Boolean | 管理员状态 |
cookie_name | String | COOKIE名称 |
connection_limit | Integer | 最大连接数 |
session_persistence | Dict | 会话持久化方法 |
id | String | 虚拟服务地址ID |
name | String | 虚拟服务地址名称 |
Example
Example Request:
Request Headers:
POST /api/ HTTP/1.1
Origin: https://console.plcloud.com
X-CSRFToken: 6An6xEuOJqW6dVDtlgzZr6FqgkSbJmqp
Content-Type: application/json
JSON Data:
{
"action": "GetLBVip",
"obj_id": "55a3b961-5fd8-49a7-9684-67e4dfc94111"
}
Example Response:
{
"message": "成功",
"code": 200,
"data": [
{
"description": "test",
"admin_state_up": true,
"cookie_name": "",
"connection_limit": 100,
"session_persistence": {
"type": "HTTP_COOKIE"
},
"id": "55a3b961-5fd8-49a7-9684-67e4dfc94111",
"name": "VIP"
}
]
}