NGINX Plus - API 정의서 (yaml)
- NGINX Plus의 경우, API 를 통한 NGINX 제어 가능
API Swagger
- 별도의 Swagger-UI 가 설치되어 있으면 해당 Swagger 활용 가능
- NGINX Plus : R26 버전 이상, Swagger-UI 삭제됨
- Swagger YAML : https://demo.nginx.com/swagger-ui/nginx_api.yaml
- Swagger 구성
NGINX API 제공 정보
API 를 활용한 모니터링 가능
Upstream / Key-Value Store 의 경우 UPDATE/PATCH/DELETE 가능
| 분류 | 항목 | 내용 |
| 기본정보 | General Info | 기본 API 제공항목 대 분류 확인 |
| Processes | NGINX 상태 확인 및 프로세스 재기동 가능 | |
| Connections | 커넥션 상태 확인 ( 및 누적 데이터 삭제 가능 ) | |
| Slabs | slabs 메모리 할당 여부 확인 | |
| Resolvers | resolver zone 정보 확인 | |
| SSL | SSL 통계 확인 ( 및 누적 데이터 삭제 가능 ) | |
| HTTP | HTTP | |
| HTTP Requests | HTTP Request 확인 | |
| HTTP Server Zones | Status Zone 이 설정되어 있는 항목에 대해 통계값 확인 ( 및 누적 데이터 삭제 가능 ) | |
| HTTP Location Zones | location zone 이 설정되어 있는 항목에 대해 통계값 확인 ( 및 누적 데이터 삭제 가능 ) | |
| HTTP Caches | Cache 상태 확인 가능 | |
| HTTP Limit conns | limit_conn 상태 확인 가능 | |
| HTTP Limit Reqs | limit_req 상태 확인 가능 | |
| HTTP Keyvals | Key_value Store 값 확인 및 업데이트 / 삭제 가능 | |
| HTTP Upstreams | upstream 항목에 대해 상태 확인 및 업데이트 가능 | |
| Stream | Stream | |
| Stream Server Zones | Status Zone 이 설정되어 있는 항목에 대해 통계값 확인 ( 및 누적 데이터 삭제 가능 ) | |
| Stream Limit Conns | limit_conn 상태 확인 가능 | |
| Stream Keyvals | Key_value Store 값 확인 및 업데이트 / 삭제 가능 | |
| Stream Upstreams | upstream 항목에 대해 상태 확인 및 업데이트 가능 | |
| Stream Zone Sync | NGINX Cluster 상태에서의 동기화 상태 여부 확인 |