添加服务器组到负载均衡监听器(AddServerGroupToLoadBalancerListener)
API请求
URLs
POST zstack/v1/load-balancers/listeners/{listenerUuid}/servergroupsHeaders
Authorization: OAuth the-session-uuidBody
{
"params": {
"serverGroupUuid": "05a078a03cad32a6a4c5c05f418eb27a"
},
"systemTags": [],
"userTags": []
}Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"serverGroupUuid":"05a078a03cad32a6a4c5c05f418eb27a"}}' http://localhost:8080/zstack/v1/load-balancers/listeners/cb64a1d37cae35449ca3f9813150f073/servergroups参数列表
| 名字 | 类型 | 位置 | 描述 | 可选值 | 起始版本 |
|---|---|---|---|---|---|
| serverGroupUuid | String | body(包含在params结构中) | 负载均衡器服务器组uuid | 4.0.0 | |
| listenerUuid | String | url | 负载均衡器监听器uuid | 4.0.0 | |
| systemTags (可选) | List | body | 系统标签 | 4.0.0 | |
| userTags (可选) | List | body | 用户标签 | 4.0.0 |
API返回
返回示例
{
"inventory": {
"uuid": "2bdca7f6bea932cd8373468d971ef61f",
"name": "Test-Listener",
"loadBalancerUuid": "32a8cf1442b43724bef1aa2f94aa97e4",
"instancePort": 80.0,
"loadBalancerPort": 80.0,
"protocol": "http"
}
}| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| error | ErrorCode | 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error | 4.0.0 |
| inventory | LoadBalancerListenerInventory | 详情参考inventory | 4.0.0 |
#error
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| code | String | 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 | 4.0.0 |
| description | String | 错误的概要描述 | 4.0.0 |
| details | String | 错误的详细信息 | 4.0.0 |
| elaboration | String | 保留字段,默认为null | 4.0.0 |
| opaque | LinkedHashMap | 保留字段,默认为null | 4.0.0 |
| cause | ErrorCode | 根错误,引发当前错误的源错误,若无原错误,该字段为null | 4.0.0 |
#inventory
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| uuid | String | 资源的UUID,唯一标示该资源 | 4.0.0 |
| name | String | 资源名称 | 4.0.0 |
| description | String | 资源的详细描述 | 4.0.0 |
| loadBalancerUuid | String | 负载均衡器UUID | 4.0.0 |
| instancePort | Integer | 4.0.0 | |
| loadBalancerPort | Integer | 4.0.0 | |
| protocol | String | 4.0.0 | |
| serverGroupUuid | String | 4.0.0 | |
| createDate | Timestamp | 创建时间 | 4.0.0 |
| lastOpDate | Timestamp | 最后一次修改时间 | 4.0.0 |
| vmNicRefs | List | 详情参考vmNicRefs | 4.0.0 |
| aclRefs | List | 详情参考alcRefs | 4.0.0 |
| certificateRefs | List | 详情参考certificateRefs | 4.0.0 |
| serverGroupRefs | List | 详情参考serverGroupRefs | 4.0.0 |
#vmNicRefs
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| id | Long | 4.0.0 | |
| listenerUuid | String | 4.0.0 | |
| vmNicUuid | String | 云主机网卡UUID | 4.0.0 |
| status | String | 4.0.0 | |
| createDate | Timestamp | 创建时间 | 4.0.0 |
| lastOpDate | Timestamp | 最后一次修改时间 | 4.0.0 |
#alcRefs
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| id | Long | 资源唯一标识 | 4.0.0 |
| listenerUuid | String | 监听器唯一标识 | 4.0.0 |
| aclUuid | String | 访问策略组唯一标识 | 4.0.0 |
| type | String | 访问策略类型 | 4.0.0 |
| createDate | Timestamp | 创建时间 | 4.0.0 |
| lastOpDate | Timestamp | 最后一次修改时间 | 4.0.0 |
#certificateRefs
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| id | Long | 4.0.0 | |
| listenerUuid | String | 4.0.0 | |
| certificateUuid | String | 4.0.0 | |
| createDate | Timestamp | 创建时间 | 4.0.0 |
| lastOpDate | Timestamp | 最后一次修改时间 | 4.0.0 |
#serverGroupRefs
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| id | long | 4.0.0 | |
| listenerUuid | String | 4.0.0 | |
| serverGroupUuid | String | 4.0.0 | |
| createDate | Timestamp | 创建时间 | 4.0.0 |
| lastOpDate | Timestamp | 最后一次修改时间 | 4.0.0 |
SDK示例
Java
SDK
AddServerGroupToLoadBalancerListenerAction action = new AddServerGroupToLoadBalancerListenerAction();
action.serverGroupUuid = "05a078a03cad32a6a4c5c05f418eb27a";
action.listenerUuid = "cb64a1d37cae35449ca3f9813150f073";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AddServerGroupToLoadBalancerListenerAction.Result res = action.call();Python
SDK
AddServerGroupToLoadBalancerListenerAction action = AddServerGroupToLoadBalancerListenerAction()
action.serverGroupUuid = "05a078a03cad32a6a4c5c05f418eb27a"
action.listenerUuid = "cb64a1d37cae35449ca3f9813150f073"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
AddServerGroupToLoadBalancerListenerAction.Result res = action.call()