1 Star 0 Fork 0

JokerDevops/kong

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
kong-admin-api.yml 14.57 KB
一键复制 编辑 原始数据 按行查看 历史
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605
components:
schemas:
tags:
required:
- tag
- entity_name
- entity_id
type: object
properties:
entity_id:
type: string
tag:
type: string
entity_name:
type: string
consumers:
required: []
type: object
properties:
tags:
type: array
username:
type: string
id:
type: string
format: uuid
custom_id:
type: string
created_at:
type: integer
format: int32
plugins:
required:
- name
- protocols
- enabled
type: object
properties:
tags:
type: array
enabled:
type: boolean
default: true
service:
$ref: '#/components/schemas/services'
default: ~
nullable: true
route:
$ref: '#/components/schemas/routes'
default: ~
nullable: true
created_at:
type: integer
format: int32
consumer:
$ref: '#/components/schemas/consumers'
default: ~
nullable: true
name:
type: string
id:
type: string
format: uuid
protocols:
default:
- grpc
- grpcs
- http
- https
enum:
- http
- https
- tcp
- tls
- udp
- grpc
- grpcs
type: array
config:
type: array
certificates:
required:
- cert
- key
type: object
properties:
tags:
type: array
key:
type: string
cert_alt:
type: string
key_alt:
type: string
cert:
type: string
created_at:
type: integer
format: int32
id:
type: string
format: uuid
ca_certificates:
required:
- cert
type: object
properties:
tags:
type: array
id:
type: string
format: uuid
cert:
type: string
created_at:
type: integer
format: int32
cert_digest:
type: string
snis:
required:
- name
- certificate
type: object
properties:
tags:
type: array
name:
type: string
id:
type: string
format: uuid
created_at:
type: integer
format: int32
certificate:
$ref: '#/components/schemas/certificates'
upstreams:
required:
- name
type: object
properties:
tags:
type: array
created_at:
type: integer
format: int32
slots:
type: integer
default: 10000
host_header:
type: string
algorithm:
type: string
default: round-robin
hash_on_header:
type: string
hash_on:
type: string
default: none
hash_fallback_header:
type: string
name:
type: string
id:
type: string
format: uuid
client_certificate:
$ref: '#/components/schemas/certificates'
hash_on_cookie_path:
type: string
default: /
hash_on_cookie:
type: string
healthchecks:
type: array
default:
passive:
unhealthy:
http_failures: 0
tcp_failures: 0
http_statuses:
- 429
- 500
- 503
timeouts: 0
type: http
healthy:
http_statuses:
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 226
- 300
- 301
- 302
- 303
- 304
- 305
- 306
- 307
- 308
successes: 0
active:
http_path: /
unhealthy:
tcp_failures: 0
timeouts: 0
http_failures: 0
interval: 0
http_statuses:
- 429
- 404
- 500
- 501
- 502
- 503
- 504
- 505
https_verify_certificate: true
concurrency: 10
timeout: 1
type: http
healthy:
successes: 0
interval: 0
http_statuses:
- 200
- 302
hash_fallback:
type: string
default: none
targets:
required:
- upstream
- target
type: object
properties:
upstream:
$ref: '#/components/schemas/upstreams'
target:
type: string
id:
type: string
format: uuid
weight:
type: integer
default: 100
created_at:
type: number
format: float
tags:
type: array
vaults_beta:
required:
- prefix
- name
type: object
properties:
tags:
type: array
name:
type: string
id:
type: string
format: uuid
config:
type: array
created_at:
type: integer
format: int32
prefix:
type: string
description:
type: string
updated_at:
type: integer
format: int32
clustering_data_planes:
required:
- id
- ip
- hostname
- sync_status
type: object
properties:
version:
type: string
id:
type: string
last_seen:
type: integer
format: int32
config_hash:
type: string
ip:
type: string
sync_status:
type: string
default: unknown
hostname:
type: string
workspaces:
required:
- name
type: object
properties:
name:
type: string
id:
type: string
format: uuid
config:
type: array
meta:
type: array
created_at:
type: integer
format: int32
comment:
type: string
parameters:
required:
- key
- value
type: object
properties:
value:
type: string
created_at:
type: integer
format: int32
key:
type: string
routes:
required:
- protocols
- https_redirect_status_code
- strip_path
- preserve_host
- request_buffering
- response_buffering
type: object
properties:
tags:
type: array
response_buffering:
type: boolean
default: true
regex_priority:
type: integer
default: 0
service:
$ref: '#/components/schemas/services'
https_redirect_status_code:
type: integer
default: 426
headers:
type: array
destinations:
type: array
hosts:
type: array
snis:
type: array
strip_path:
type: boolean
default: true
methods:
type: array
created_at:
type: integer
format: int32
updated_at:
type: integer
format: int32
paths:
type: array
name:
type: string
id:
type: string
format: uuid
path_handling:
type: string
default: v0
protocols:
type: array
default:
- http
- https
preserve_host:
type: boolean
default: false
sources:
type: array
request_buffering:
type: boolean
default: true
services:
required:
- protocol
- host
- port
- enabled
type: object
properties:
tags:
type: array
retries:
type: integer
default: 5
ca_certificates:
type: array
connect_timeout:
type: integer
default: 60000
write_timeout:
type: integer
default: 60000
read_timeout:
type: integer
default: 60000
client_certificate:
$ref: '#/components/schemas/certificates'
tls_verify:
type: boolean
port:
type: integer
default: 80
tls_verify_depth:
default: ~
type: integer
nullable: true
enabled:
type: boolean
default: true
path:
type: string
updated_at:
type: integer
format: int32
protocol:
type: string
default: http
id:
type: string
format: uuid
host:
type: string
name:
type: string
created_at:
type: integer
format: int32
info:
contact:
url: https://github.com/Kong/kong
name: Kong
version: 2.7.0
title: Kong Admin API
summary: Kong RESTful Admin API for administration purposes.
description: " {{site.base_gateway}} comes with an **internal** RESTful Admin
API for administration purposes.\n Requests to the Admin API can be sent
to any node in the cluster, and Kong will\n keep the configuration consistent
across all nodes.\n\n - `8001` is the default port on which the Admin API
listens.\n - `8444` is the default port for HTTPS traffic to the Admin
API.\n\n This API is designed for internal use and provides full control
over Kong, so\n care should be taken when setting up Kong environments
to avoid undue public\n exposure of this API. See [this document][secure-admin-api]
for a discussion\n of methods to secure the Admin API.\n "
license:
url: https://github.com/Kong/kong/blob/master/LICENSE
name: Apache 2.0
paths:
/clustering/status: []
/upstreams/{upstreams}/targets/{targets}/{address}/unhealthy:
post:
description: This method is not available when using DB-less mode.
summary: Set target address as unhealthy
/:
get:
summary: Retrieve node information
/cache/{key}:
delete:
description: This method is not available when using DB-less mode.
get: []
/certificates/{certificates}/snis: []
/upstreams/{upstreams}/targets/{targets}/unhealthy:
post:
description: This method is not available when using DB-less mode.
summary: Set target as unhealthy
/certificates/{certificates}:
put:
description: This method is not available when using DB-less mode.
get: []
patch:
description: This method is not available when using DB-less mode.
/upstreams/{upstreams}/targets:
post:
description: This method is not available when using DB-less mode.
get: []
/targets/:targets: []
/upstreams/{upstreams}/targets/{targets}/healthy:
post:
description: This method is not available when using DB-less mode.
summary: Set target as healthy
/upstreams/{upstreams}/targets/{targets}:
put:
description: This method is not available when using DB-less mode.
get: []
delete:
description: This method is not available when using DB-less mode.
summary: Delete Target
patch:
description: This method is not available when using DB-less mode.
summary: Update Target
/tags/{tags}:
get:
summary: ' List entity IDs by tag '
/plugins/enabled:
get:
summary: Retrieve Enabled Plugins
/upstreams/{upstreams}/targets/all:
get:
summary: List all Targets
/targets/{targets}/upstream: []
/certificates/{certificates}/snis/{snis}: []
/routes/:routes/plugins:
post: []
/plugins:
post:
description: This method is not available when using DB-less mode.
/cache:
delete:
description: This method is not available when using DB-less mode.
/targets: []
/config:
post:
description: This method is only available when using DB-less mode.
get:
description: This method is only available when using DB-less mode.
/consumers/{consumers}/plugins/{plugins}:
patch:
description: This method is not available when using DB-less mode.
/schemas/{name}:
get:
summary: Retrieve Entity Schema
/status:
get:
summary: Retrieve node status
/plugins/schema/{name}:
get: []
/schemas/plugins/{name}:
get:
summary: Retrieve Plugin Schema
/upstreams/{upstreams}/health:
get:
summary: Show Upstream health for node
/schemas/{db_entity_name}/validate:
post:
description: This method is not available when using DB-less mode.
summary: Validate a configuration against a schema
/plugins/{plugins}:
patch:
description: This method is not available when using DB-less mode.
/snis/{snis}/certificate: []
/upstreams/{upstreams}/targets/{targets}/{address}/healthy:
post:
description: This method is not available when using DB-less mode.
summary: Set target address as healthy
/routes/{routes}/plugins/{plugins}:
patch:
description: This method is not available when using DB-less mode.
/clustering/data-planes: []
/schemas/plugins/validate:
post:
description: This method is not available when using DB-less mode.
summary: Validate a plugin configuration against the schema
/services/{services}/plugins:
post:
description: This method is not available when using DB-less mode.
/services/{services}/plugins/{plugins}:
patch:
description: This method is not available when using DB-less mode.
/consumers:
get: []
/consumers/{consumers}/plugins:
post:
description: This method is not available when using DB-less mode.
/endpoints:
get:
summary: List available endpoints
servers:
- description: 8001 is the default port on which the Admin API listens.
url: http://localhost:8001
- description: 8444 is the default port for HTTPS traffic to the Admin API.
url: https://localhost:8444
openapi: 3.1.0
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/azdevops/kong.git
git@gitee.com:azdevops/kong.git
azdevops
kong
kong
master

搜索帮助