1 Star 1 Fork 0

FlexLB/flexlb-api

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
embedded_spec.go 49.76 KB
一键复制 编辑 原始数据 按行查看 历史
王耀辉 提交于 2022-04-21 19:05 +08:00 . add license
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885
// Copyright (c) 2022 Yaohui Wang (yaohuiwang@outlook.com)
// FlexLB is licensed under Mulan PubL v2.
// You can use this software according to the terms and conditions of the Mulan PubL v2.
// You may obtain a copy of Mulan PubL v2 at:
// http://license.coscl.org.cn/MulanPubL-2.0
// THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
// EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
// MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
// See the Mulan PubL v2 for more details.
// Code generated by go-swagger; DO NOT EDIT.
package restapi
// This file was generated by the swagger tool.
// Editing this file might prove futile when you re-run the swagger generate command
import (
"encoding/json"
)
var (
// SwaggerJSON embedded version of the swagger document used at generation time
SwaggerJSON json.RawMessage
// FlatSwaggerJSON embedded flattened version of the swagger document used at generation time
FlatSwaggerJSON json.RawMessage
)
func init() {
SwaggerJSON = json.RawMessage([]byte(`{
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"schemes": [
"https",
"http"
],
"swagger": "2.0",
"info": {
"description": "Flexible load balancer API to control keepalived and haproxy\n",
"title": "flexlb",
"contact": {
"name": "Yaohui Wang",
"email": "yaohuiwang@outlook.com"
},
"version": "v1"
},
"basePath": "/flexlb/v1",
"paths": {
"/instances": {
"get": {
"description": "List Instances",
"produces": [
"application/json"
],
"tags": [
"Instance"
],
"operationId": "list",
"parameters": [
{
"pattern": "^[A-Za-z0-9\\-_.]{1,32}$",
"type": "string",
"x-nullable": true,
"description": "Instance name",
"name": "name",
"in": "query"
}
],
"responses": {
"200": {
"description": "List Instances succeeded",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Instance"
}
}
},
"400": {
"$ref": "#/responses/trait:standardErrors:400"
},
"401": {
"$ref": "#/responses/trait:standardErrors:401"
},
"403": {
"$ref": "#/responses/trait:standardErrors:403"
},
"404": {
"$ref": "#/responses/trait:standardErrors:404"
},
"500": {
"$ref": "#/responses/trait:standardErrors:500"
}
}
},
"put": {
"description": "Modify Instance",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Instance"
],
"operationId": "modify",
"parameters": [
{
"description": "Instance request",
"name": "config",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/InstanceConfig"
}
}
],
"responses": {
"200": {
"description": "Modify Instance succeeded",
"schema": {
"$ref": "#/definitions/Instance"
}
},
"400": {
"$ref": "#/responses/trait:standardErrors:400"
},
"401": {
"$ref": "#/responses/trait:standardErrors:401"
},
"403": {
"$ref": "#/responses/trait:standardErrors:403"
},
"404": {
"$ref": "#/responses/trait:standardErrors:404"
},
"500": {
"$ref": "#/responses/trait:standardErrors:500"
}
}
},
"post": {
"description": "Create Instance",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Instance"
],
"operationId": "create",
"parameters": [
{
"description": "Instance config",
"name": "config",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/InstanceConfig"
}
}
],
"responses": {
"200": {
"description": "Create Instance succeeded",
"schema": {
"$ref": "#/definitions/Instance"
}
},
"400": {
"$ref": "#/responses/trait:standardErrors:400"
},
"401": {
"$ref": "#/responses/trait:standardErrors:401"
},
"403": {
"$ref": "#/responses/trait:standardErrors:403"
},
"404": {
"$ref": "#/responses/trait:standardErrors:404"
},
"500": {
"$ref": "#/responses/trait:standardErrors:500"
}
}
}
},
"/instances/{name}": {
"get": {
"description": "Get Instance",
"produces": [
"application/json"
],
"tags": [
"Instance"
],
"operationId": "get",
"parameters": [
{
"pattern": "^[A-Za-z0-9\\-_.]{1,32}$",
"type": "string",
"x-nullable": false,
"description": "Instance name",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Get Instance succeeded",
"schema": {
"$ref": "#/definitions/Instance"
}
},
"400": {
"$ref": "#/responses/trait:standardErrors:400"
},
"401": {
"$ref": "#/responses/trait:standardErrors:401"
},
"403": {
"$ref": "#/responses/trait:standardErrors:403"
},
"404": {
"$ref": "#/responses/trait:standardErrors:404"
},
"500": {
"$ref": "#/responses/trait:standardErrors:500"
}
}
},
"delete": {
"description": "Delete Instance",
"produces": [
"application/json"
],
"tags": [
"Instance"
],
"operationId": "delete",
"parameters": [
{
"pattern": "^[A-Za-z0-9\\-_.]{1,32}$",
"type": "string",
"x-nullable": false,
"description": "Instance name",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Delete Instance succeeded",
"schema": {
"type": "object"
}
},
"400": {
"$ref": "#/responses/trait:standardErrors:400"
},
"401": {
"$ref": "#/responses/trait:standardErrors:401"
},
"403": {
"$ref": "#/responses/trait:standardErrors:403"
},
"404": {
"$ref": "#/responses/trait:standardErrors:404"
},
"500": {
"$ref": "#/responses/trait:standardErrors:500"
}
}
}
},
"/instances/{name}/start": {
"post": {
"description": "Start instance",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Instance"
],
"operationId": "start",
"parameters": [
{
"pattern": "^[A-Za-z0-9\\-_.]{1,32}$",
"type": "string",
"x-nullable": false,
"description": "Instance name",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Start instance succeeded",
"schema": {
"$ref": "#/definitions/Instance"
}
},
"400": {
"$ref": "#/responses/trait:standardErrors:400"
},
"401": {
"$ref": "#/responses/trait:standardErrors:401"
},
"403": {
"$ref": "#/responses/trait:standardErrors:403"
},
"404": {
"$ref": "#/responses/trait:standardErrors:404"
},
"500": {
"$ref": "#/responses/trait:standardErrors:500"
}
}
}
},
"/instances/{name}/stop": {
"post": {
"description": "Stop Instance",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Instance"
],
"operationId": "stop",
"parameters": [
{
"pattern": "^[A-Za-z0-9\\-_.]{1,32}$",
"type": "string",
"x-nullable": false,
"description": "Instance name",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Stop Instance succeeded",
"schema": {
"$ref": "#/definitions/Instance"
}
},
"400": {
"$ref": "#/responses/trait:standardErrors:400"
},
"401": {
"$ref": "#/responses/trait:standardErrors:401"
},
"403": {
"$ref": "#/responses/trait:standardErrors:403"
},
"404": {
"$ref": "#/responses/trait:standardErrors:404"
},
"500": {
"$ref": "#/responses/trait:standardErrors:500"
}
}
}
},
"/readyz": {
"get": {
"description": "Ready status",
"produces": [
"application/json"
],
"tags": [
"Service"
],
"operationId": "readyz",
"responses": {
"200": {
"description": "Ready status",
"schema": {
"$ref": "#/definitions/ReadyStatus"
}
}
}
}
}
},
"definitions": {
"BackendServer": {
"description": "Backend server",
"required": [
"name",
"ipaddress",
"port"
],
"properties": {
"check_ssl_options": {
"description": "Backend check commands",
"type": "object",
"properties": {
"ca_cert": {
"type": "string",
"x-nullable": true
},
"client_cert": {
"type": "string",
"x-nullable": false
},
"client_key": {
"type": "string",
"x-nullable": false
},
"verify": {
"type": "string",
"enum": [
"none"
],
"x-nullable": true
}
},
"x-nullable": true
},
"ipaddress": {
"description": "Backend server IP address",
"type": "string",
"pattern": "((^\\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\\s*$)|(^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*$))",
"x-nullable": false
},
"name": {
"description": "Backend server name",
"type": "string",
"pattern": "^[A-Za-z0-9\\-_.]{1,32}$",
"x-nullable": false
},
"options": {
"description": "Backend server options",
"type": "string",
"default": "",
"x-nullable": true
},
"port": {
"description": "Backend server port",
"type": "integer",
"format": "uint16",
"x-nullable": false
}
},
"additionalProperties": false
},
"Endpoint": {
"description": "Endpoint",
"required": [
"frontend_port",
"mode",
"balance",
"backend_servers"
],
"properties": {
"backend_check_commands": {
"description": "Backend check commands",
"type": "object",
"properties": {
"check_type": {
"type": "string",
"enum": [
"http-check",
"tcp-check"
],
"x-nullable": false,
"example": "http-check"
},
"commands": {
"description": "Backend TCP check commands",
"type": "array",
"items": {
"type": "string"
},
"x-nullable": true,
"example": [
"expect status 200"
]
}
},
"x-nullable": true
},
"backend_default_server": {
"description": "Backend default server options",
"type": "string",
"default": "inter 2s downinter 5s rise 2 fall 2 slowstart 60s maxconn 2000 maxqueue 2000 weight 100",
"x-nullable": true
},
"backend_options": {
"description": "Backend options",
"type": "array",
"items": {
"type": "string"
},
"x-nullable": true,
"example": [
"httpchk GET /"
]
},
"backend_servers": {
"description": "Backend servers",
"type": "array",
"items": {
"$ref": "#/definitions/BackendServer"
},
"x-nullable": false
},
"balance": {
"description": "Balance algorithm",
"type": "string",
"default": "roundrobin",
"x-nullable": false
},
"frontend_options": {
"description": "Frontend options",
"type": "string",
"default": "",
"x-nullable": true,
"example": "ssl"
},
"frontend_port": {
"description": "Frontend port",
"type": "integer",
"format": "uint16",
"x-nullable": false,
"example": 443
},
"frontend_ssl_options": {
"description": "Backend check commands",
"type": "object",
"properties": {
"ca_cert": {
"type": "string",
"x-nullable": true
},
"server_cert": {
"type": "string",
"x-nullable": false
},
"server_key": {
"type": "string",
"x-nullable": false
},
"verify": {
"type": "string",
"enum": [
"required",
"optional"
],
"x-nullable": true
}
},
"x-nullable": true
},
"mode": {
"description": "Protocol mode",
"type": "string",
"default": "tcp",
"enum": [
"tcp",
"udp",
"http"
],
"x-nullable": false
}
},
"additionalProperties": false
},
"Instance": {
"description": "Instance",
"required": [
"id",
"config",
"status"
],
"properties": {
"config": {
"x-nullable": false,
"$ref": "#/definitions/InstanceConfig"
},
"id": {
"description": "Instance ID",
"type": "integer",
"format": "uint8",
"maximum": 255,
"x-nullable": false
},
"last_modified": {
"description": "Last modified time",
"type": "integer",
"format": "int64",
"x-nullable": false
},
"status": {
"description": "Instance status",
"type": "object",
"additionalProperties": {
"type": "string"
},
"x-nullable": false
}
}
},
"InstanceConfig": {
"description": "Instance config",
"required": [
"name",
"frontend_interface",
"frontend_ipaddress",
"frontend_net_prefix",
"endpoints"
],
"properties": {
"endpoints": {
"description": "Endpoints",
"type": "array",
"items": {
"$ref": "#/definitions/Endpoint"
},
"x-nullable": false
},
"frontend_interface": {
"description": "Frontend network interface",
"type": "string",
"pattern": "^[A-Za-z0-9\\-_.]{1,32}$",
"x-nullable": false,
"example": "eth0"
},
"frontend_ipaddress": {
"description": "Frontend IP address",
"type": "string",
"pattern": "((^\\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\\s*$)|(^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*$))",
"x-nullable": false,
"example": "192.168.1.2"
},
"frontend_net_prefix": {
"description": "Frontend network prefix",
"type": "integer",
"format": "uint8",
"default": 32,
"maximum": 32,
"minimum": 8,
"x-nullable": false,
"example": 24
},
"name": {
"description": "Instance name",
"type": "string",
"pattern": "^[A-Za-z0-9\\-_.]{1,32}$",
"x-nullable": false
}
}
},
"ReadyStatus": {
"description": "Ready status",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"parameters": {
"trait:paged:limit": {
"maximum": 255,
"type": "integer",
"format": "uint8",
"name": "limit",
"in": "query"
},
"trait:paged:skip": {
"type": "string",
"name": "skip",
"in": "query"
}
},
"responses": {
"trait:standardErrors:400": {
"description": "",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
},
"trait:standardErrors:401": {
"description": "",
"schema": {
"type": "object"
}
},
"trait:standardErrors:403": {
"description": "",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
},
"trait:standardErrors:404": {
"description": "",
"schema": {
"type": "object",
"required": [
"status",
"error"
],
"properties": {
"error": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
},
"trait:standardErrors:500": {
"description": "",
"schema": {
"type": "object"
}
}
},
"tags": [
{
"description": "Instance",
"name": "Instance"
},
{
"description": "Service",
"name": "Service"
}
]
}`))
FlatSwaggerJSON = json.RawMessage([]byte(`{
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"schemes": [
"https",
"http"
],
"swagger": "2.0",
"info": {
"description": "Flexible load balancer API to control keepalived and haproxy\n",
"title": "flexlb",
"contact": {
"name": "Yaohui Wang",
"email": "yaohuiwang@outlook.com"
},
"version": "v1"
},
"basePath": "/flexlb/v1",
"paths": {
"/instances": {
"get": {
"description": "List Instances",
"produces": [
"application/json"
],
"tags": [
"Instance"
],
"operationId": "list",
"parameters": [
{
"pattern": "^[A-Za-z0-9\\-_.]{1,32}$",
"type": "string",
"x-nullable": true,
"description": "Instance name",
"name": "name",
"in": "query"
}
],
"responses": {
"200": {
"description": "List Instances succeeded",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Instance"
}
}
},
"400": {
"description": "",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
},
"401": {
"description": "",
"schema": {
"type": "object"
}
},
"403": {
"description": "",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
},
"404": {
"description": "",
"schema": {
"type": "object",
"required": [
"status",
"error"
],
"properties": {
"error": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
},
"500": {
"description": "",
"schema": {
"type": "object"
}
}
}
},
"put": {
"description": "Modify Instance",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Instance"
],
"operationId": "modify",
"parameters": [
{
"description": "Instance request",
"name": "config",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/InstanceConfig"
}
}
],
"responses": {
"200": {
"description": "Modify Instance succeeded",
"schema": {
"$ref": "#/definitions/Instance"
}
},
"400": {
"description": "",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
},
"401": {
"description": "",
"schema": {
"type": "object"
}
},
"403": {
"description": "",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
},
"404": {
"description": "",
"schema": {
"type": "object",
"required": [
"status",
"error"
],
"properties": {
"error": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
},
"500": {
"description": "",
"schema": {
"type": "object"
}
}
}
},
"post": {
"description": "Create Instance",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Instance"
],
"operationId": "create",
"parameters": [
{
"description": "Instance config",
"name": "config",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/InstanceConfig"
}
}
],
"responses": {
"200": {
"description": "Create Instance succeeded",
"schema": {
"$ref": "#/definitions/Instance"
}
},
"400": {
"description": "",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
},
"401": {
"description": "",
"schema": {
"type": "object"
}
},
"403": {
"description": "",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
},
"404": {
"description": "",
"schema": {
"type": "object",
"required": [
"status",
"error"
],
"properties": {
"error": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
},
"500": {
"description": "",
"schema": {
"type": "object"
}
}
}
}
},
"/instances/{name}": {
"get": {
"description": "Get Instance",
"produces": [
"application/json"
],
"tags": [
"Instance"
],
"operationId": "get",
"parameters": [
{
"pattern": "^[A-Za-z0-9\\-_.]{1,32}$",
"type": "string",
"x-nullable": false,
"description": "Instance name",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Get Instance succeeded",
"schema": {
"$ref": "#/definitions/Instance"
}
},
"400": {
"description": "",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
},
"401": {
"description": "",
"schema": {
"type": "object"
}
},
"403": {
"description": "",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
},
"404": {
"description": "",
"schema": {
"type": "object",
"required": [
"status",
"error"
],
"properties": {
"error": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
},
"500": {
"description": "",
"schema": {
"type": "object"
}
}
}
},
"delete": {
"description": "Delete Instance",
"produces": [
"application/json"
],
"tags": [
"Instance"
],
"operationId": "delete",
"parameters": [
{
"pattern": "^[A-Za-z0-9\\-_.]{1,32}$",
"type": "string",
"x-nullable": false,
"description": "Instance name",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Delete Instance succeeded",
"schema": {
"type": "object"
}
},
"400": {
"description": "",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
},
"401": {
"description": "",
"schema": {
"type": "object"
}
},
"403": {
"description": "",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
},
"404": {
"description": "",
"schema": {
"type": "object",
"required": [
"status",
"error"
],
"properties": {
"error": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
},
"500": {
"description": "",
"schema": {
"type": "object"
}
}
}
}
},
"/instances/{name}/start": {
"post": {
"description": "Start instance",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Instance"
],
"operationId": "start",
"parameters": [
{
"pattern": "^[A-Za-z0-9\\-_.]{1,32}$",
"type": "string",
"x-nullable": false,
"description": "Instance name",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Start instance succeeded",
"schema": {
"$ref": "#/definitions/Instance"
}
},
"400": {
"description": "",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
},
"401": {
"description": "",
"schema": {
"type": "object"
}
},
"403": {
"description": "",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
},
"404": {
"description": "",
"schema": {
"type": "object",
"required": [
"status",
"error"
],
"properties": {
"error": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
},
"500": {
"description": "",
"schema": {
"type": "object"
}
}
}
}
},
"/instances/{name}/stop": {
"post": {
"description": "Stop Instance",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Instance"
],
"operationId": "stop",
"parameters": [
{
"pattern": "^[A-Za-z0-9\\-_.]{1,32}$",
"type": "string",
"x-nullable": false,
"description": "Instance name",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Stop Instance succeeded",
"schema": {
"$ref": "#/definitions/Instance"
}
},
"400": {
"description": "",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
},
"401": {
"description": "",
"schema": {
"type": "object"
}
},
"403": {
"description": "",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
},
"404": {
"description": "",
"schema": {
"type": "object",
"required": [
"status",
"error"
],
"properties": {
"error": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
},
"500": {
"description": "",
"schema": {
"type": "object"
}
}
}
}
},
"/readyz": {
"get": {
"description": "Ready status",
"produces": [
"application/json"
],
"tags": [
"Service"
],
"operationId": "readyz",
"responses": {
"200": {
"description": "Ready status",
"schema": {
"$ref": "#/definitions/ReadyStatus"
}
}
}
}
}
},
"definitions": {
"BackendServer": {
"description": "Backend server",
"required": [
"name",
"ipaddress",
"port"
],
"properties": {
"check_ssl_options": {
"description": "Backend check commands",
"type": "object",
"properties": {
"ca_cert": {
"type": "string",
"x-nullable": true
},
"client_cert": {
"type": "string",
"x-nullable": false
},
"client_key": {
"type": "string",
"x-nullable": false
},
"verify": {
"type": "string",
"enum": [
"none"
],
"x-nullable": true
}
},
"x-nullable": true
},
"ipaddress": {
"description": "Backend server IP address",
"type": "string",
"pattern": "((^\\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\\s*$)|(^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*$))",
"x-nullable": false
},
"name": {
"description": "Backend server name",
"type": "string",
"pattern": "^[A-Za-z0-9\\-_.]{1,32}$",
"x-nullable": false
},
"options": {
"description": "Backend server options",
"type": "string",
"default": "",
"x-nullable": true
},
"port": {
"description": "Backend server port",
"type": "integer",
"format": "uint16",
"x-nullable": false
}
},
"additionalProperties": false
},
"BackendServerCheckSslOptions": {
"description": "Backend check commands",
"type": "object",
"properties": {
"ca_cert": {
"type": "string",
"x-nullable": true
},
"client_cert": {
"type": "string",
"x-nullable": false
},
"client_key": {
"type": "string",
"x-nullable": false
},
"verify": {
"type": "string",
"enum": [
"none"
],
"x-nullable": true
}
},
"x-nullable": true
},
"Endpoint": {
"description": "Endpoint",
"required": [
"frontend_port",
"mode",
"balance",
"backend_servers"
],
"properties": {
"backend_check_commands": {
"description": "Backend check commands",
"type": "object",
"properties": {
"check_type": {
"type": "string",
"enum": [
"http-check",
"tcp-check"
],
"x-nullable": false,
"example": "http-check"
},
"commands": {
"description": "Backend TCP check commands",
"type": "array",
"items": {
"type": "string"
},
"x-nullable": true,
"example": [
"expect status 200"
]
}
},
"x-nullable": true
},
"backend_default_server": {
"description": "Backend default server options",
"type": "string",
"default": "inter 2s downinter 5s rise 2 fall 2 slowstart 60s maxconn 2000 maxqueue 2000 weight 100",
"x-nullable": true
},
"backend_options": {
"description": "Backend options",
"type": "array",
"items": {
"type": "string"
},
"x-nullable": true,
"example": [
"httpchk GET /"
]
},
"backend_servers": {
"description": "Backend servers",
"type": "array",
"items": {
"$ref": "#/definitions/BackendServer"
},
"x-nullable": false
},
"balance": {
"description": "Balance algorithm",
"type": "string",
"default": "roundrobin",
"x-nullable": false
},
"frontend_options": {
"description": "Frontend options",
"type": "string",
"default": "",
"x-nullable": true,
"example": "ssl"
},
"frontend_port": {
"description": "Frontend port",
"type": "integer",
"format": "uint16",
"x-nullable": false,
"example": 443
},
"frontend_ssl_options": {
"description": "Backend check commands",
"type": "object",
"properties": {
"ca_cert": {
"type": "string",
"x-nullable": true
},
"server_cert": {
"type": "string",
"x-nullable": false
},
"server_key": {
"type": "string",
"x-nullable": false
},
"verify": {
"type": "string",
"enum": [
"required",
"optional"
],
"x-nullable": true
}
},
"x-nullable": true
},
"mode": {
"description": "Protocol mode",
"type": "string",
"default": "tcp",
"enum": [
"tcp",
"udp",
"http"
],
"x-nullable": false
}
},
"additionalProperties": false
},
"EndpointBackendCheckCommands": {
"description": "Backend check commands",
"type": "object",
"properties": {
"check_type": {
"type": "string",
"enum": [
"http-check",
"tcp-check"
],
"x-nullable": false,
"example": "http-check"
},
"commands": {
"description": "Backend TCP check commands",
"type": "array",
"items": {
"type": "string"
},
"x-nullable": true,
"example": [
"expect status 200"
]
}
},
"x-nullable": true
},
"EndpointFrontendSslOptions": {
"description": "Backend check commands",
"type": "object",
"properties": {
"ca_cert": {
"type": "string",
"x-nullable": true
},
"server_cert": {
"type": "string",
"x-nullable": false
},
"server_key": {
"type": "string",
"x-nullable": false
},
"verify": {
"type": "string",
"enum": [
"required",
"optional"
],
"x-nullable": true
}
},
"x-nullable": true
},
"Instance": {
"description": "Instance",
"required": [
"id",
"config",
"status"
],
"properties": {
"config": {
"x-nullable": false,
"$ref": "#/definitions/InstanceConfig"
},
"id": {
"description": "Instance ID",
"type": "integer",
"format": "uint8",
"maximum": 255,
"minimum": 0,
"x-nullable": false
},
"last_modified": {
"description": "Last modified time",
"type": "integer",
"format": "int64",
"minimum": 0,
"x-nullable": false
},
"status": {
"description": "Instance status",
"type": "object",
"additionalProperties": {
"type": "string"
},
"x-nullable": false
}
}
},
"InstanceConfig": {
"description": "Instance config",
"required": [
"name",
"frontend_interface",
"frontend_ipaddress",
"frontend_net_prefix",
"endpoints"
],
"properties": {
"endpoints": {
"description": "Endpoints",
"type": "array",
"items": {
"$ref": "#/definitions/Endpoint"
},
"x-nullable": false
},
"frontend_interface": {
"description": "Frontend network interface",
"type": "string",
"pattern": "^[A-Za-z0-9\\-_.]{1,32}$",
"x-nullable": false,
"example": "eth0"
},
"frontend_ipaddress": {
"description": "Frontend IP address",
"type": "string",
"pattern": "((^\\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\\s*$)|(^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*$))",
"x-nullable": false,
"example": "192.168.1.2"
},
"frontend_net_prefix": {
"description": "Frontend network prefix",
"type": "integer",
"format": "uint8",
"default": 32,
"maximum": 32,
"minimum": 8,
"x-nullable": false,
"example": 24
},
"name": {
"description": "Instance name",
"type": "string",
"pattern": "^[A-Za-z0-9\\-_.]{1,32}$",
"x-nullable": false
}
}
},
"ReadyStatus": {
"description": "Ready status",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"parameters": {
"trait:paged:limit": {
"maximum": 255,
"type": "integer",
"format": "uint8",
"name": "limit",
"in": "query"
},
"trait:paged:skip": {
"type": "string",
"name": "skip",
"in": "query"
}
},
"responses": {
"trait:standardErrors:400": {
"description": "",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
},
"trait:standardErrors:401": {
"description": "",
"schema": {
"type": "object"
}
},
"trait:standardErrors:403": {
"description": "",
"schema": {
"type": "object",
"required": [
"message"
],
"properties": {
"message": {
"type": "string"
}
}
}
},
"trait:standardErrors:404": {
"description": "",
"schema": {
"type": "object",
"required": [
"status",
"error"
],
"properties": {
"error": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
},
"trait:standardErrors:500": {
"description": "",
"schema": {
"type": "object"
}
}
},
"tags": [
{
"description": "Instance",
"name": "Instance"
},
{
"description": "Service",
"name": "Service"
}
]
}`))
}
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
Go
1
https://gitee.com/flexlb/flexlb-api.git
git@gitee.com:flexlb/flexlb-api.git
flexlb
flexlb-api
flexlb-api
v0.4.2

搜索帮助