Skip to content

Latest commit

 

History

History
256 lines (208 loc) · 16.3 KB

README.md

File metadata and controls

256 lines (208 loc) · 16.3 KB

swagger-java-client

vproxy

  • API version: 1.0.0
    • Build date: 2020-01-09T11:11:04.239+08:00

The vproxy http controller api.

Automatically generated by the Swagger Codegen

Requirements

Building the API client library requires:

  1. Java 1.7+
  2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>io.swagger</groupId>
  <artifactId>swagger-java-client</artifactId>
  <version>1.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "io.swagger:swagger-java-client:1.0.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/swagger-java-client-1.0.0.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import vproxy.client.*;
import vproxy.client.auth.*;
import vproxy.client.model.*;
import vproxy.client.model.CertKeyApi;

import java.io.File;
import java.util.*;

public class CertKeyApiExample {

    public static void main(String[] args) {
        
        CertKeyApi apiInstance = new CertKeyApi();
        CertKeyCreate body = new CertKeyCreate(); // CertKeyCreate | 
        try {
            apiInstance.addCertKey(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling CertKeyApi#addCertKey");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://localhost/api/v1/module

Class Method HTTP request Description
CertKeyApi addCertKey POST /cert-key add cert-key
CertKeyApi describeCertKey GET /cert-key/{ck}/detail get detailed info of one cert-key
CertKeyApi getCertKey GET /cert-key/{ck} get cert-key
CertKeyApi listCertKey GET /cert-key retrieve cert-key list
CertKeyApi removeCertKey DELETE /cert-key/{ck} remove cert-key
DnsServerApi addDnsServer POST /dns-server add dns-server
DnsServerApi describeDnsServer GET /dns-server/{dns}/detail get detailed info of one dns-server
DnsServerApi getDnsServer GET /dns-server/{dns} get dns-server
DnsServerApi listDnsServer GET /dns-server retrieve dns-server list
DnsServerApi removeDnsServer DELETE /dns-server/{dns} remove dns-server
DnsServerApi updateDnsServer PUT /dns-server/{dns} update dns-server
EventLoopApi addEventLoop POST /event-loop-group/{elg}/event-loop add event-loop into event-loop-group
EventLoopApi describeEventLoop GET /event-loop-group/{elg}/event-loop/{el}/detail get detailed info of one event-loop in event-loop-group
EventLoopApi getEventLoop GET /event-loop-group/{elg}/event-loop/{el} get event-loop in event-loop-group
EventLoopApi listEventLoop GET /event-loop-group/{elg}/event-loop retrieve event-loop list from event-loop-group
EventLoopApi removeEventLoop DELETE /event-loop-group/{elg}/event-loop/{el} remove event-loop from event-loop-group
EventLoopGroupApi addEventLoopGroup POST /event-loop-group add event-loop-group
EventLoopGroupApi describeEventLoopGroup GET /event-loop-group/{elg}/detail get detailed info of one event-loop-group
EventLoopGroupApi getEventLoopGroup GET /event-loop-group/{elg} get event-loop-group
EventLoopGroupApi listEventLoopGroup GET /event-loop-group retrieve event-loop-group list
EventLoopGroupApi removeEventLoopGroup DELETE /event-loop-group/{elg} remove event-loop-group
SecurityGroupApi addSecurityGroup POST /security-group add security-group
SecurityGroupApi describeSecurityGroup GET /security-group/{secg}/detail get detailed info of one security-group
SecurityGroupApi getSecurityGroup GET /security-group/{secg} get security-group
SecurityGroupApi listSecurityGroup GET /security-group retrieve security-group list
SecurityGroupApi removeSecurityGroup DELETE /security-group/{secg} remove security-group
SecurityGroupApi updateSecurityGroup PUT /security-group/{secg} update security-group
SecurityGroupRuleApi addSecurityGroupRule POST /security-group/{secg}/security-group-rule add security-group-rule into security-group
SecurityGroupRuleApi describeSecurityGroupRule GET /security-group/{secg}/security-group-rule/{secgr}/detail get detailed info of one security-group-rule in security-group
SecurityGroupRuleApi getSecurityGroupRule GET /security-group/{secg}/security-group-rule/{secgr} get security-group-rule in security-group
SecurityGroupRuleApi listSecurityGroupRule GET /security-group/{secg}/security-group-rule retrieve security-group-rule list from security-group
SecurityGroupRuleApi removeSecurityGroupRule DELETE /security-group/{secg}/security-group-rule/{secgr} remove security-group-rule from security-group
ServerApi addServer POST /server-group/{sg}/server add server into server-group
ServerApi describeServer GET /server-group/{sg}/server/{svr}/detail get detailed info of one server in server-group
ServerApi getServer GET /server-group/{sg}/server/{svr} get server in server-group
ServerApi listServer GET /server-group/{sg}/server retrieve server list from server-group
ServerApi removeServer DELETE /server-group/{sg}/server/{svr} remove server from server-group
ServerApi updateServer PUT /server-group/{sg}/server/{svr} update server in server-group
ServerGroupApi addServerGroup POST /server-group add server-group
ServerGroupApi addServerGroupInUpstream POST /upstream/{ups}/server-group add server-group into upstream
ServerGroupApi describeServerGroup GET /server-group/{sg}/detail get detailed info of one server-group
ServerGroupApi describeServerGroupInUpstream GET /upstream/{ups}/server-group/{sg}/detail get detailed info of one server-group in upstream
ServerGroupApi getServerGroup GET /server-group/{sg} get server-group
ServerGroupApi getServerGroupInUpstream GET /upstream/{ups}/server-group/{sg} get server-group in upstream
ServerGroupApi listServerGroup GET /server-group retrieve server-group list
ServerGroupApi listServerGroupInUpstream GET /upstream/{ups}/server-group retrieve server-group list from upstream
ServerGroupApi removeServerGroup DELETE /server-group/{sg} remove server-group
ServerGroupApi removeServerGroupInUpstream DELETE /upstream/{ups}/server-group/{sg} remove server-group from upstream
ServerGroupApi updateServerGroup PUT /server-group/{sg} update server-group
ServerGroupApi updateServerGroupInUpstream PUT /upstream/{ups}/server-group/{sg} update server-group in upstream
SmartGroupDelegateApi addSmartGroupDelegate POST /smart-group-delegate add smart-group-delegate
SmartGroupDelegateApi describeSmartGroupDelegate GET /smart-group-delegate/{sgd}/detail get detailed info of one smart-group-delegate
SmartGroupDelegateApi getSmartGroupDelegate GET /smart-group-delegate/{sgd} get smart-group-delegate
SmartGroupDelegateApi listSmartGroupDelegate GET /smart-group-delegate retrieve smart-group-delegate list
SmartGroupDelegateApi removeSmartGroupDelegate DELETE /smart-group-delegate/{sgd} remove smart-group-delegate
SmartNodeDelegateApi addSmartNodeDelegate POST /smart-node-delegate add smart-node-delegate
SmartNodeDelegateApi describeSmartNodeDelegate GET /smart-node-delegate/{snd}/detail get detailed info of one smart-node-delegate
SmartNodeDelegateApi getSmartNodeDelegate GET /smart-node-delegate/{snd} get smart-node-delegate
SmartNodeDelegateApi listSmartNodeDelegate GET /smart-node-delegate retrieve smart-node-delegate list
SmartNodeDelegateApi removeSmartNodeDelegate DELETE /smart-node-delegate/{snd} remove smart-node-delegate
Socks5ServerApi addSocks5Server POST /socks5-server add socks5-server
Socks5ServerApi describeSocks5Server GET /socks5-server/{socks5}/detail get detailed info of one socks5-server
Socks5ServerApi getSocks5Server GET /socks5-server/{socks5} get socks5-server
Socks5ServerApi listSocks5Server GET /socks5-server retrieve socks5-server list
Socks5ServerApi removeSocks5Server DELETE /socks5-server/{socks5} remove socks5-server
Socks5ServerApi updateSocks5Server PUT /socks5-server/{socks5} update socks5-server
TcpLbApi addTcpLb POST /tcp-lb add tcp-lb
TcpLbApi describeTcpLb GET /tcp-lb/{tl}/detail get detailed info of one tcp-lb
TcpLbApi getTcpLb GET /tcp-lb/{tl} get tcp-lb
TcpLbApi listTcpLb GET /tcp-lb retrieve tcp-lb list
TcpLbApi removeTcpLb DELETE /tcp-lb/{tl} remove tcp-lb
TcpLbApi updateTcpLb PUT /tcp-lb/{tl} update tcp-lb
UpstreamApi addUpstream POST /upstream add upstream
UpstreamApi describeUpstream GET /upstream/{ups}/detail get detailed info of one upstream
UpstreamApi getUpstream GET /upstream/{ups} get upstream
UpstreamApi listUpstream GET /upstream retrieve upstream list
UpstreamApi removeUpstream DELETE /upstream/{ups} remove upstream

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization. Authentication schemes defined for the API:

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author