Mercurial > hg > nginx-site

comparison yaml/nginx_api.yaml @ 2768:9dd8c203a54a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated docs for the upcoming NGINX Plus release.
author Yaroslav Zhuravlev <yar@nginx.com>
date Wed, 22 Sep 2021 13:47:23 +0300
parents 5280a40d933e
children 8bd6f772005f
comparison
equal deleted inserted replaced
2767:c56adb7148a4 2768:9dd8c203a54a
1 swagger: '2.0' 1 swagger: '2.0'
2 info: 2 info:
3 version: '6.0' 3 version: '7.0'
4 title: NGINX Plus REST API 4 title: NGINX Plus REST API
5 description: NGINX Plus REST 5 description: NGINX Plus REST
6 [API](https://nginx.org/en/docs/http/ngx_http_api_module.html) 6 [API](https://nginx.org/en/docs/http/ngx_http_api_module.html)
7 provides access to NGINX Plus status information, 7 provides access to NGINX Plus status information,
8 on-the-fly configuration of upstream servers and 8 on-the-fly configuration of upstream servers and
9 key-value pairs management for 9 key-value pairs management for
10 [http](https://nginx.org/en/docs/http/ngx_http_keyval_module.html) and 10 [http](https://nginx.org/en/docs/http/ngx_http_keyval_module.html) and
11 [stream](https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html). 11 [stream](https://nginx.org/en/docs/stream/ngx_stream_keyval_module.html).
12 basePath: /api/6 12 basePath: /api/7
13 tags: 13 tags:
14 - name: General Info 14 - name: General Info
15 - name: Processes 15 - name: Processes
16 - name: Connections 16 - name: Connections
17 - name: Slabs 17 - name: Slabs
2382 1xx: 0 2382 1xx: 0
2383 2xx: 727290 2383 2xx: 727290
2384 3xx: 4614 2384 3xx: 4614
2385 4xx: 934 2385 4xx: 934
2386 5xx: 1535 2386 5xx: 1535
2387 codes:
2388 200: 727270
2389 301: 4614
2390 404: 930
2391 503: 1535
2387 total: 734373 2392 total: 734373
2388 discarded: 2020 2393 discarded: 2020
2389 received: 180157219 2394 received: 180157219
2390 sent: 20183175459 2395 sent: 20183175459
2391 site2: 2396 site2:
2395 1xx: 0 2400 1xx: 0
2396 2xx: 112674 2401 2xx: 112674
2397 3xx: 45383 2402 3xx: 45383
2398 4xx: 2504 2403 4xx: 2504
2399 5xx: 4419 2404 5xx: 4419
2405 codes:
2406 200: 112674
2407 301: 45383
2408 404: 2504
2409 503: 4419
2400 total: 164980 2410 total: 164980
2401 discarded: 20326 2411 discarded: 20326
2402 received: 51575327 2412 received: 51575327
2403 sent: 2983241510 2413 sent: 2983241510
2404 NginxHTTPServerZone: 2414 NginxHTTPServerZone:
2411 that are currently being processed. 2421 that are currently being processed.
2412 requests: 2422 requests:
2413 type: integer 2423 type: integer
2414 description: The total number of client requests received from clients. 2424 description: The total number of client requests received from clients.
2415 responses: 2425 responses:
2416 description: The total number of responses sent to clients and the 2426 description: The total number of responses sent to clients, the
2417 number of responses with status codes 2427 number of responses with status codes
2418 “<code>1xx</code>”, “<code>2xx</code>”, “<code>3xx</code>”, 2428 “<code>1xx</code>”, “<code>2xx</code>”, “<code>3xx</code>”,
2419 “<code>4xx</code>”, and “<code>5xx</code>”. 2429 “<code>4xx</code>”, and “<code>5xx</code>”, and
2430 the number of responses per each status code.
2420 type: object 2431 type: object
2421 readOnly: true 2432 readOnly: true
2422 properties: 2433 properties:
2423 1xx: 2434 1xx:
2424 type: integer 2435 type: integer
2438 readOnly: true 2449 readOnly: true
2439 5xx: 2450 5xx:
2440 type: integer 2451 type: integer
2441 description: The number of responses with “<code>5xx</code>” status codes. 2452 description: The number of responses with “<code>5xx</code>” status codes.
2442 readOnly: true 2453 readOnly: true
2454 codes:
2455 type: object
2456 description: The number of responses per each status code.
2457 readOnly: true
2458 properties:
2459 codeNumber:
2460 type: integer
2461 description: The number of responses with this particular status code.
2462 readOnly: true
2443 total: 2463 total:
2444 type: integer 2464 type: integer
2445 description: The total number of responses sent to clients. 2465 description: The total number of responses sent to clients.
2446 readOnly: true 2466 readOnly: true
2447 discarded: 2467 discarded:
2461 1xx: 0 2481 1xx: 0
2462 2xx: 699482 2482 2xx: 699482
2463 3xx: 4522 2483 3xx: 4522
2464 4xx: 907 2484 4xx: 907
2465 5xx: 266 2485 5xx: 266
2486 codes:
2487 200: 699482
2488 301: 4522
2489 404: 907
2490 503: 266
2466 total: 705177 2491 total: 705177
2467 discarded: 1513 2492 discarded: 1513
2468 received: 172711587 2493 received: 172711587
2469 sent: 19415530115 2494 sent: 19415530115
2470 NginxHTTPLocationZonesMap: 2495 NginxHTTPLocationZonesMap:
2482 1xx: 0 2507 1xx: 0
2483 2xx: 727290 2508 2xx: 727290
2484 3xx: 4614 2509 3xx: 4614
2485 4xx: 934 2510 4xx: 934
2486 5xx: 1535 2511 5xx: 1535
2512 codes:
2513 200: 727290
2514 301: 4614
2515 404: 934
2516 503: 1535
2487 total: 734373 2517 total: 734373
2488 discarded: 2020 2518 discarded: 2020
2489 received: 180157219 2519 received: 180157219
2490 sent: 20183175459 2520 sent: 20183175459
2491 site2: 2521 site2:
2494 1xx: 0 2524 1xx: 0
2495 2xx: 112674 2525 2xx: 112674
2496 3xx: 45383 2526 3xx: 45383
2497 4xx: 2504 2527 4xx: 2504
2498 5xx: 4419 2528 5xx: 4419
2529 codes:
2530 200: 112674
2531 301: 45383
2532 404: 2504
2533 503: 4419
2499 total: 164980 2534 total: 164980
2500 discarded: 20326 2535 discarded: 20326
2501 received: 51575327 2536 received: 51575327
2502 sent: 2983241510 2537 sent: 2983241510
2503 NginxHTTPLocationZone: 2538 NginxHTTPLocationZone:
2506 properties: 2541 properties:
2507 requests: 2542 requests:
2508 type: integer 2543 type: integer
2509 description: The total number of client requests received from clients. 2544 description: The total number of client requests received from clients.
2510 responses: 2545 responses:
2511 description: The total number of responses sent to clients and the 2546 description: The total number of responses sent to clients, the
2512 number of responses with status codes 2547 number of responses with status codes
2513 “<code>1xx</code>”, “<code>2xx</code>”, “<code>3xx</code>”, 2548 “<code>1xx</code>”, “<code>2xx</code>”, “<code>3xx</code>”,
2514 “<code>4xx</code>”, and “<code>5xx</code>”. 2549 “<code>4xx</code>”, and “<code>5xx</code>”, and
2550 the number of responses per each status code.
2515 type: object 2551 type: object
2516 readOnly: true 2552 readOnly: true
2517 properties: 2553 properties:
2518 1xx: 2554 1xx:
2519 type: integer 2555 type: integer
2533 readOnly: true 2569 readOnly: true
2534 5xx: 2570 5xx:
2535 type: integer 2571 type: integer
2536 description: The number of responses with “<code>5xx</code>” status codes. 2572 description: The number of responses with “<code>5xx</code>” status codes.
2537 readOnly: true 2573 readOnly: true
2574 codes:
2575 type: object
2576 description: The number of responses per each status code.
2577 readOnly: true
2578 properties:
2579 codeNumber:
2580 type: integer
2581 description: The number of responses with this particular status code.
2582 readOnly: true
2538 total: 2583 total:
2539 type: integer 2584 type: integer
2540 description: The total number of responses sent to clients. 2585 description: The total number of responses sent to clients.
2541 readOnly: true 2586 readOnly: true
2542 discarded: 2587 discarded:
2555 1xx: 0 2600 1xx: 0
2556 2xx: 699482 2601 2xx: 699482
2557 3xx: 4522 2602 3xx: 4522
2558 4xx: 907 2603 4xx: 907
2559 5xx: 266 2604 5xx: 266
2605 codes:
2606 200: 112674
2607 301: 4522
2608 404: 2504
2609 503: 266
2560 total: 705177 2610 total: 705177
2561 discarded: 1513 2611 discarded: 1513
2562 received: 172711587 2612 received: 172711587
2563 sent: 19415530115 2613 sent: 19415530115
2564 NginxHTTPCachesMap: 2614 NginxHTTPCachesMap:
2858 1xx: 0 2908 1xx: 0
2859 2xx: 666310 2909 2xx: 666310
2860 3xx: 0 2910 3xx: 0
2861 4xx: 915 2911 4xx: 915
2862 5xx: 6 2912 5xx: 6
2913 codes:
2914 200: 666310
2915 404: 915
2916 503: 6
2863 total: 667231 2917 total: 667231
2864 sent: 251946292 2918 sent: 251946292
2865 received: 19222475454 2919 received: 19222475454
2866 fails: 0 2920 fails: 0
2867 unavail: 0 2921 unavail: 0
2885 1xx: 0 2939 1xx: 0
2886 2xx: 0 2940 2xx: 0
2887 3xx: 0 2941 3xx: 0
2888 4xx: 0 2942 4xx: 0
2889 5xx: 0 2943 5xx: 0
2944 codes: {}
2890 total: 0 2945 total: 0
2891 sent: 0 2946 sent: 0
2892 received: 0 2947 received: 0
2893 fails: 0 2948 fails: 0
2894 unavail: 0 2949 unavail: 0
2919 1xx: 0 2974 1xx: 0
2920 2xx: 666310 2975 2xx: 666310
2921 3xx: 0 2976 3xx: 0
2922 4xx: 915 2977 4xx: 915
2923 5xx: 6 2978 5xx: 6
2979 codes:
2980 200: 666310
2981 404: 915
2982 503: 6
2924 total: 667231 2983 total: 667231
2925 sent: 251946292 2984 sent: 251946292
2926 received: 19222475454 2985 received: 19222475454
2927 fails: 0 2986 fails: 0
2928 unavail: 0 2987 unavail: 0
2946 1xx: 0 3005 1xx: 0
2947 2xx: 0 3006 2xx: 0
2948 3xx: 0 3007 3xx: 0
2949 4xx: 0 3008 4xx: 0
2950 5xx: 0 3009 5xx: 0
3010 codes: {}
2951 total: 0 3011 total: 0
2952 sent: 0 3012 sent: 0
2953 received: 0 3013 received: 0
2954 fails: 0 3014 fails: 0
2955 unavail: 0 3015 unavail: 0
3019 1xx: 0 3079 1xx: 0
3020 2xx: 666310 3080 2xx: 666310
3021 3xx: 0 3081 3xx: 0
3022 4xx: 915 3082 4xx: 915
3023 5xx: 6 3083 5xx: 6
3084 codes:
3085 200: 666310
3086 404: 915
3087 503: 6
3024 total: 667231 3088 total: 667231
3025 sent: 251946292 3089 sent: 251946292
3026 received: 19222475454 3090 received: 19222475454
3027 fails: 0 3091 fails: 0
3028 unavail: 0 3092 unavail: 0
3047 1xx: 0 3111 1xx: 0
3048 2xx: 0 3112 2xx: 0
3049 3xx: 0 3113 3xx: 0
3050 4xx: 0 3114 4xx: 0
3051 5xx: 0 3115 5xx: 0
3116 codes: {}
3052 total: 0 3117 total: 0
3053 sent: 0 3118 sent: 0
3054 received: 0 3119 received: 0
3055 fails: 0 3120 fails: 0
3056 unavail: 0 3121 unavail: 0
3155 readOnly: true 3220 readOnly: true
3156 5xx: 3221 5xx:
3157 type: integer 3222 type: integer
3158 description: The number of responses with “<code>5xx</code>” status codes. 3223 description: The number of responses with “<code>5xx</code>” status codes.
3159 readOnly: true 3224 readOnly: true
3225 codes:
3226 type: object
3227 description: The number of responses per each status code.
3228 readOnly: true
3229 properties:
3230 codeNumber:
3231 type: integer
3232 description: The number of responses with this particular status code.
3233 readOnly: true
3160 total: 3234 total:
3161 type: integer 3235 type: integer
3162 description: The total number of responses obtained from this server. 3236 description: The total number of responses obtained from this server.
3163 readOnly: true 3237 readOnly: true
3164 sent: 3238 sent: