获取监听器可加载L3网络(GetCandidateL3NetworksForLoadBalancer)
API请求
URLs
GET zstack/v1/load-balancers/listeners/{listenerUuid}/networks/candidatesHeaders
Authorization: OAuth the-session-uuidCurl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/load-balancers/listeners/6ecc19bdec0139499e3abf6c51bca683/networks/candidates?limit=1000.0&start=0.0参数列表
| 名字 | 类型 | 位置 | 描述 | 可选值 | 起始版本 |
|---|---|---|---|---|---|
| listenerUuid | String | url | 3.9.0 | ||
| limit (可选) | Integer | query | 3.9.0 | ||
| start (可选) | Integer | query | 3.9.0 | ||
| systemTags (可选) | List | query | 系统标签 | 3.9.0 | |
| userTags (可选) | List | query | 用户标签 | 3.9.0 |
API返回
返回示例
{
"inventories": [
{
"name": "Test-L3Network",
"l2NetworkUuid": "7631f86a65af335fb1496afe8e7ac9ee"
}
]
}| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| error | ErrorCode | 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error | 3.9.0 |
| inventories | List | 详情参考inventories | 3.9.0 |
#error
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| code | String | 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 | 3.9.0 |
| description | String | 错误的概要描述 | 3.9.0 |
| details | String | 错误的详细信息 | 3.9.0 |
| elaboration | String | 保留字段，默认为null | 3.9.0 |
| opaque | LinkedHashMap | 保留字段，默认为null | 3.9.0 |
| cause | ErrorCode | 根错误，引发当前错误的源错误，若无原错误，该字段为null | 3.9.0 |
#inventories
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| uuid | String | 资源的UUID，唯一标示该资源 | 3.9.0 |
| name | String | 资源名称 | 3.9.0 |
| description | String | 资源的详细描述 | 3.9.0 |
| type | String | 3.9.0 | |
| zoneUuid | String | 区域UUID | 3.9.0 |
| l2NetworkUuid | String | 二层网络UUID | 3.9.0 |
| state | String | 3.9.0 | |
| dnsDomain | String | 3.9.0 | |
| system | Boolean | 3.9.0 | |
| category | String | 3.9.0 | |
| ipVersion | Integer | 3.9.0 | |
| createDate | Timestamp | 创建时间 | 3.9.0 |
| lastOpDate | Timestamp | 最后一次修改时间 | 3.9.0 |
| dns | List | 3.9.0 | |
| ipRanges | List | 详情参考ipRanges | 3.9.0 |
| networkServices | List | 详情参考networkServices | 3.9.0 |
| hostRoute | List | 详情参考hostRoute | 3.9.0 |
#ipRanges
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| uuid | String | 资源的UUID，唯一标示该资源 | 3.9.0 |
| l3NetworkUuid | String | 三层网络UUID | 3.9.0 |
| name | String | 资源名称 | 3.9.0 |
| description | String | 资源的详细描述 | 3.9.0 |
| startIp | String | 3.9.0 | |
| endIp | String | 3.9.0 | |
| netmask | String | 3.9.0 | |
| gateway | String | 3.9.0 | |
| networkCidr | String | 3.9.0 | |
| ipVersion | Integer | 3.9.0 | |
| addressMode | String | 3.9.0 | |
| prefixLen | Integer | 3.9.0 | |
| createDate | Timestamp | 创建时间 | 3.9.0 |
| lastOpDate | Timestamp | 最后一次修改时间 | 3.9.0 |
#networkServices
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| l3NetworkUuid | String | 三层网络UUID | 3.9.0 |
| networkServiceProviderUuid | String | 网络服务提供模块UUID | 3.9.0 |
| networkServiceType | String | 3.9.0 |
#hostRoute
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| id | Long | 3.9.0 | |
| l3NetworkUuid | String | 三层网络UUID | 3.9.0 |
| prefix | String | 3.9.0 | |
| nexthop | String | 3.9.0 | |
| createDate | Timestamp | 创建时间 | 3.9.0 |
| lastOpDate | Timestamp | 最后一次修改时间 | 3.9.0 |
SDK示例
Java
SDK
GetCandidateL3NetworksForLoadBalancerAction action = new GetCandidateL3NetworksForLoadBalancerAction();
action.listenerUuid = "6ecc19bdec0139499e3abf6c51bca683";
action.limit = 1000.0;
action.start = 0.0;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetCandidateL3NetworksForLoadBalancerAction.Result res = action.call();Python
SDK
GetCandidateL3NetworksForLoadBalancerAction action = GetCandidateL3NetworksForLoadBalancerAction()
action.listenerUuid = "6ecc19bdec0139499e3abf6c51bca683"
action.limit = 1000.0
action.start = 0.0
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetCandidateL3NetworksForLoadBalancerAction.Result res = action.call()