Skip to content

Latest commit

 

History

History
267 lines (186 loc) · 5.49 KB

TcpLbApi.md

File metadata and controls

267 lines (186 loc) · 5.49 KB

TcpLbApi

All URIs are relative to http://127.0.0.1:18776/api/v1/module

Method HTTP request Description
addTcpLb POST /tcp-lb add tcp-lb
describeTcpLb GET /tcp-lb/{tl}/detail get detailed info of one tcp-lb
getTcpLb GET /tcp-lb/{tl} get tcp-lb
listTcpLb GET /tcp-lb retrieve tcp-lb list
removeTcpLb DELETE /tcp-lb/{tl} remove tcp-lb
updateTcpLb PUT /tcp-lb/{tl} update tcp-lb

addTcpLb

addTcpLb(body)

add tcp-lb

Example

// Import classes:
//import vproxy.client.ApiException;
//import vproxy.client.model.TcpLbApi;


TcpLbApi apiInstance = new TcpLbApi();
TcpLbCreate body = new TcpLbCreate(); // TcpLbCreate | 
try {
    apiInstance.addTcpLb(body);
} catch (ApiException e) {
    System.err.println("Exception when calling TcpLbApi#addTcpLb");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body TcpLbCreate

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

describeTcpLb

TcpLbDetail describeTcpLb(tl)

get detailed info of one tcp-lb

Example

// Import classes:
//import vproxy.client.ApiException;
//import vproxy.client.model.TcpLbApi;


TcpLbApi apiInstance = new TcpLbApi();
String tl = "tl_example"; // String | name of the tcp-lb
try {
    TcpLbDetail result = apiInstance.describeTcpLb(tl);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TcpLbApi#describeTcpLb");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
tl String name of the tcp-lb

Return type

TcpLbDetail

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getTcpLb

TcpLb getTcpLb(tl)

get tcp-lb

Example

// Import classes:
//import vproxy.client.ApiException;
//import vproxy.client.model.TcpLbApi;


TcpLbApi apiInstance = new TcpLbApi();
String tl = "tl_example"; // String | name of the tcp-lb
try {
    TcpLb result = apiInstance.getTcpLb(tl);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TcpLbApi#getTcpLb");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
tl String name of the tcp-lb

Return type

TcpLb

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

listTcpLb

List<TcpLb> listTcpLb()

retrieve tcp-lb list

Example

// Import classes:
//import vproxy.client.ApiException;
//import vproxy.client.model.TcpLbApi;


TcpLbApi apiInstance = new TcpLbApi();
try {
    List<TcpLb> result = apiInstance.listTcpLb();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TcpLbApi#listTcpLb");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

List<TcpLb>

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

removeTcpLb

removeTcpLb(tl)

remove tcp-lb

Example

// Import classes:
//import vproxy.client.ApiException;
//import vproxy.client.model.TcpLbApi;


TcpLbApi apiInstance = new TcpLbApi();
String tl = "tl_example"; // String | name of the tcp-lb
try {
    apiInstance.removeTcpLb(tl);
} catch (ApiException e) {
    System.err.println("Exception when calling TcpLbApi#removeTcpLb");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
tl String name of the tcp-lb

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

updateTcpLb

updateTcpLb(tl, body)

update tcp-lb

Example

// Import classes:
//import vproxy.client.ApiException;
//import vproxy.client.model.TcpLbApi;


TcpLbApi apiInstance = new TcpLbApi();
String tl = "tl_example"; // String | name of the tcp-lb
TcpLbUpdate body = new TcpLbUpdate(); // TcpLbUpdate | 
try {
    apiInstance.updateTcpLb(tl, body);
} catch (ApiException e) {
    System.err.println("Exception when calling TcpLbApi#updateTcpLb");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
tl String name of the tcp-lb
body TcpLbUpdate

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json