Mercurial > hg > nginx-site
comparison xml/en/docs/http/ngx_http_api_module.xml @ 2914:3a2d342533fb
Updated docs for the upcoming NGINX Plus release.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Mon, 28 Nov 2022 17:42:29 +0000 |
parents | 8bd6f772005f |
children | a85e4d126bc7 |
comparison
equal
deleted
inserted
replaced
2913:a20b51e84c32 | 2914:3a2d342533fb |
---|---|
2149 <literal>session_reuses</literal> (<literal>integer</literal>) | 2149 <literal>session_reuses</literal> (<literal>integer</literal>) |
2150 </tag-name> | 2150 </tag-name> |
2151 <tag-desc> | 2151 <tag-desc> |
2152 The total number of session reuses during SSL handshake. | 2152 The total number of session reuses during SSL handshake. |
2153 </tag-desc> | 2153 </tag-desc> |
2154 <tag-name> | |
2155 <literal>no_common_protocol</literal> (<literal>integer</literal>) | |
2156 </tag-name> | |
2157 <tag-desc> | |
2158 The number of SSL handshakes failed because of no common protocol. | |
2159 </tag-desc> | |
2160 <tag-name> | |
2161 <literal>no_common_cipher</literal> (<literal>integer</literal>) | |
2162 </tag-name> | |
2163 <tag-desc> | |
2164 The number of SSL handshakes failed because of no shared cipher. | |
2165 </tag-desc> | |
2166 <tag-name> | |
2167 <literal>handshake_timeout</literal> (<literal>integer</literal>) | |
2168 </tag-name> | |
2169 <tag-desc> | |
2170 The number of SSL handshakes failed because of a timeout. | |
2171 </tag-desc> | |
2172 <tag-name> | |
2173 <literal>peer_rejected_cert</literal> (<literal>integer</literal>) | |
2174 </tag-name> | |
2175 <tag-desc> | |
2176 The number of failed SSL handshakes when nginx presented the certificate to the client but it was rejected with a corresponding alert message. | |
2177 </tag-desc> | |
2178 <tag-name> | |
2179 <literal>verify_failures</literal></tag-name> | |
2180 <tag-desc> | |
2181 SSL certificate verification errors<list type="tag"> | |
2182 <tag-name> | |
2183 <literal>no_cert</literal> (<literal>integer</literal>) | |
2184 </tag-name> | |
2185 <tag-desc> | |
2186 A client did not provide the required certificate. | |
2187 </tag-desc> | |
2188 <tag-name> | |
2189 <literal>expired_cert</literal> (<literal>integer</literal>) | |
2190 </tag-name> | |
2191 <tag-desc> | |
2192 An expired or not yet valid certificate was presented by a client. | |
2193 </tag-desc> | |
2194 <tag-name> | |
2195 <literal>revoked_cert</literal> (<literal>integer</literal>) | |
2196 </tag-name> | |
2197 <tag-desc> | |
2198 A revoked certificate was presented by a client. | |
2199 </tag-desc> | |
2200 <tag-name> | |
2201 <literal>hostname_mismatch</literal> (<literal>integer</literal>) | |
2202 </tag-name> | |
2203 <tag-desc> | |
2204 Server's certificate doesn't match the hostname. | |
2205 </tag-desc> | |
2206 <tag-name> | |
2207 <literal>other</literal> (<literal>integer</literal>) | |
2208 </tag-name> | |
2209 <tag-desc> | |
2210 Other SSL certificate verification errors. | |
2211 </tag-desc> | |
2212 </list> | |
2213 </tag-desc> | |
2154 </list> | 2214 </list> |
2155 <para>Example:</para> | 2215 <para>Example:</para> |
2156 <example> | 2216 <example> |
2157 { | 2217 { |
2158 "handshakes" : 79572, | 2218 "handshakes" : 79572, |
2159 "handshakes_failed" : 21025, | 2219 "handshakes_failed" : 21025, |
2160 "session_reuses" : 15762 | 2220 "session_reuses" : 15762, |
2221 "no_common_protocol" : 4, | |
2222 "no_common_cipher" : 2, | |
2223 "handshake_timeout" : 0, | |
2224 "peer_rejected_cert" : 0, | |
2225 "verify_failures" : { | |
2226 "no_cert" : 0, | |
2227 "expired_cert" : 2, | |
2228 "revoked_cert" : 1, | |
2229 "hostname_mismatch" : 2, | |
2230 "other" : 1 | |
2231 } | |
2161 }</example> | 2232 }</example> |
2162 </listitem> | 2233 </listitem> |
2163 <listitem id="def_nginx_slab_zone"> | 2234 <listitem id="def_nginx_slab_zone"> |
2164 <para>Shared memory zone with slab allocator:</para> | 2235 <para>Shared memory zone with slab allocator:</para> |
2165 <list type="tag"> | 2236 Shared memory zone with slab allocator<list type="tag"> |
2166 <tag-name> | 2237 <tag-name> |
2167 <literal>pages</literal></tag-name> | 2238 <literal>pages</literal></tag-name> |
2168 <tag-desc> | 2239 <tag-desc> |
2169 The number of free and used memory pages.<list type="tag"> | 2240 The number of free and used memory pages.<list type="tag"> |
2170 <tag-name> | 2241 <tag-name> |
2393 <literal>session_reuses</literal> (<literal>integer</literal>) | 2464 <literal>session_reuses</literal> (<literal>integer</literal>) |
2394 </tag-name> | 2465 </tag-name> |
2395 <tag-desc> | 2466 <tag-desc> |
2396 The total number of session reuses during SSL handshake. | 2467 The total number of session reuses during SSL handshake. |
2397 </tag-desc> | 2468 </tag-desc> |
2469 <tag-name> | |
2470 <literal>no_common_protocol</literal> (<literal>integer</literal>) | |
2471 </tag-name> | |
2472 <tag-desc> | |
2473 The number of SSL handshakes failed because of no common protocol. | |
2474 </tag-desc> | |
2475 <tag-name> | |
2476 <literal>no_common_cipher</literal> (<literal>integer</literal>) | |
2477 </tag-name> | |
2478 <tag-desc> | |
2479 The number of SSL handshakes failed because of no shared cipher. | |
2480 </tag-desc> | |
2481 <tag-name> | |
2482 <literal>handshake_timeout</literal> (<literal>integer</literal>) | |
2483 </tag-name> | |
2484 <tag-desc> | |
2485 The number of SSL handshakes failed because of a timeout. | |
2486 </tag-desc> | |
2487 <tag-name> | |
2488 <literal>peer_rejected_cert</literal> (<literal>integer</literal>) | |
2489 </tag-name> | |
2490 <tag-desc> | |
2491 The number of failed SSL handshakes when nginx presented the certificate to the client but it was rejected with a corresponding alert message. | |
2492 </tag-desc> | |
2493 <tag-name> | |
2494 <literal>verify_failures</literal></tag-name> | |
2495 <tag-desc> | |
2496 SSL certificate verification errors<list type="tag"> | |
2497 <tag-name> | |
2498 <literal>no_cert</literal> (<literal>integer</literal>) | |
2499 </tag-name> | |
2500 <tag-desc> | |
2501 A client did not provide the required certificate. | |
2502 </tag-desc> | |
2503 <tag-name> | |
2504 <literal>expired_cert</literal> (<literal>integer</literal>) | |
2505 </tag-name> | |
2506 <tag-desc> | |
2507 An expired or not yet valid certificate was presented by a client. | |
2508 </tag-desc> | |
2509 <tag-name> | |
2510 <literal>revoked_cert</literal> (<literal>integer</literal>) | |
2511 </tag-name> | |
2512 <tag-desc> | |
2513 A revoked certificate was presented by a client. | |
2514 </tag-desc> | |
2515 <tag-name> | |
2516 <literal>other</literal> (<literal>integer</literal>) | |
2517 </tag-name> | |
2518 <tag-desc> | |
2519 Other SSL certificate verification errors. | |
2520 </tag-desc> | |
2521 </list> | |
2522 </tag-desc> | |
2398 </list> | 2523 </list> |
2399 </tag-desc> | 2524 </tag-desc> |
2400 </list> | 2525 </list> |
2401 <para>Example:</para> | 2526 <para>Example:</para> |
2402 <example> | 2527 <example> |
2421 "received" : 172711587, | 2546 "received" : 172711587, |
2422 "sent" : 19415530115, | 2547 "sent" : 19415530115, |
2423 "ssl" : { | 2548 "ssl" : { |
2424 "handshakes" : 104303, | 2549 "handshakes" : 104303, |
2425 "handshakes_failed" : 1421, | 2550 "handshakes_failed" : 1421, |
2426 "session_reuses" : 54645 | 2551 "session_reuses" : 54645, |
2552 "no_common_protocol" : 4, | |
2553 "no_common_cipher" : 2, | |
2554 "handshake_timeout" : 0, | |
2555 "peer_rejected_cert" : 0, | |
2556 "verify_failures" : { | |
2557 "no_cert" : 0, | |
2558 "expired_cert" : 2, | |
2559 "revoked_cert" : 1, | |
2560 "other" : 1 | |
2561 } | |
2427 } | 2562 } |
2428 }</example> | 2563 }</example> |
2429 </listitem> | 2564 </listitem> |
2430 <listitem id="def_nginx_http_location_zone"> | 2565 <listitem id="def_nginx_http_location_zone"> |
2431 <para>HTTP Location Zone:</para> | 2566 <para>HTTP Location Zone:</para> |
2905 <literal>session_reuses</literal> (<literal>integer</literal>) | 3040 <literal>session_reuses</literal> (<literal>integer</literal>) |
2906 </tag-name> | 3041 </tag-name> |
2907 <tag-desc> | 3042 <tag-desc> |
2908 The total number of session reuses during SSL handshake. | 3043 The total number of session reuses during SSL handshake. |
2909 </tag-desc> | 3044 </tag-desc> |
3045 <tag-name> | |
3046 <literal>no_common_protocol</literal> (<literal>integer</literal>) | |
3047 </tag-name> | |
3048 <tag-desc> | |
3049 The number of SSL handshakes failed because of no common protocol. | |
3050 </tag-desc> | |
3051 <tag-name> | |
3052 <literal>handshake_timeout</literal> (<literal>integer</literal>) | |
3053 </tag-name> | |
3054 <tag-desc> | |
3055 The number of SSL handshakes failed because of a timeout. | |
3056 </tag-desc> | |
3057 <tag-name> | |
3058 <literal>peer_rejected_cert</literal> (<literal>integer</literal>) | |
3059 </tag-name> | |
3060 <tag-desc> | |
3061 The number of failed SSL handshakes when nginx presented the certificate to the upstream server but it was rejected with a corresponding alert message. | |
3062 </tag-desc> | |
3063 <tag-name> | |
3064 <literal>verify_failures</literal></tag-name> | |
3065 <tag-desc> | |
3066 SSL certificate verification errors<list type="tag"> | |
3067 <tag-name> | |
3068 <literal>expired_cert</literal> (<literal>integer</literal>) | |
3069 </tag-name> | |
3070 <tag-desc> | |
3071 An expired or not yet valid certificate was presented by an upstream server. | |
3072 </tag-desc> | |
3073 <tag-name> | |
3074 <literal>revoked_cert</literal> (<literal>integer</literal>) | |
3075 </tag-name> | |
3076 <tag-desc> | |
3077 A revoked certificate was presented by an upstream server. | |
3078 </tag-desc> | |
3079 <tag-name> | |
3080 <literal>hostname_mismatch</literal> (<literal>integer</literal>) | |
3081 </tag-name> | |
3082 <tag-desc> | |
3083 Server's certificate doesn't match the hostname. | |
3084 </tag-desc> | |
3085 <tag-name> | |
3086 <literal>other</literal> (<literal>integer</literal>) | |
3087 </tag-name> | |
3088 <tag-desc> | |
3089 Other SSL certificate verification errors. | |
3090 </tag-desc> | |
3091 </list> | |
3092 </tag-desc> | |
2910 </list> | 3093 </list> |
2911 </tag-desc> | 3094 </tag-desc> |
2912 <tag-name> | 3095 <tag-name> |
2913 <literal>max_conns</literal> (<literal>integer</literal>) | 3096 <literal>max_conns</literal> (<literal>integer</literal>) |
2914 </tag-name> | 3097 </tag-name> |
3118 "state" : "up", | 3301 "state" : "up", |
3119 "active" : 0, | 3302 "active" : 0, |
3120 "ssl" : { | 3303 "ssl" : { |
3121 "handshakes" : 620311, | 3304 "handshakes" : 620311, |
3122 "handshakes_failed" : 3432, | 3305 "handshakes_failed" : 3432, |
3123 "session_reuses" : 36442 | 3306 "session_reuses" : 36442, |
3307 "no_common_protocol" : 4, | |
3308 "handshake_timeout" : 0, | |
3309 "peer_rejected_cert" : 0, | |
3310 "verify_failures" : { | |
3311 "expired_cert" : 2, | |
3312 "revoked_cert" : 1, | |
3313 "hostname_mismatch" : 2, | |
3314 "other" : 1 | |
3315 } | |
3124 }, | 3316 }, |
3125 "max_conns" : 20, | 3317 "max_conns" : 20, |
3126 "requests" : 667231, | 3318 "requests" : 667231, |
3127 "header_time" : 20, | 3319 "header_time" : 20, |
3128 "response_time" : 36, | 3320 "response_time" : 36, |
3406 <literal>session_reuses</literal> (<literal>integer</literal>) | 3598 <literal>session_reuses</literal> (<literal>integer</literal>) |
3407 </tag-name> | 3599 </tag-name> |
3408 <tag-desc> | 3600 <tag-desc> |
3409 The total number of session reuses during SSL handshake. | 3601 The total number of session reuses during SSL handshake. |
3410 </tag-desc> | 3602 </tag-desc> |
3603 <tag-name> | |
3604 <literal>no_common_protocol</literal> (<literal>integer</literal>) | |
3605 </tag-name> | |
3606 <tag-desc> | |
3607 The number of SSL handshakes failed because of no common protocol. | |
3608 </tag-desc> | |
3609 <tag-name> | |
3610 <literal>no_common_cipher</literal> (<literal>integer</literal>) | |
3611 </tag-name> | |
3612 <tag-desc> | |
3613 The number of SSL handshakes failed because of no shared cipher. | |
3614 </tag-desc> | |
3615 <tag-name> | |
3616 <literal>handshake_timeout</literal> (<literal>integer</literal>) | |
3617 </tag-name> | |
3618 <tag-desc> | |
3619 The number of SSL handshakes failed because of a timeout. | |
3620 </tag-desc> | |
3621 <tag-name> | |
3622 <literal>peer_rejected_cert</literal> (<literal>integer</literal>) | |
3623 </tag-name> | |
3624 <tag-desc> | |
3625 The number of failed SSL handshakes when nginx presented the certificate to the client but it was rejected with a corresponding alert message. | |
3626 </tag-desc> | |
3627 <tag-name> | |
3628 <literal>verify_failures</literal></tag-name> | |
3629 <tag-desc> | |
3630 SSL certificate verification errors<list type="tag"> | |
3631 <tag-name> | |
3632 <literal>no_cert</literal> (<literal>integer</literal>) | |
3633 </tag-name> | |
3634 <tag-desc> | |
3635 A client did not provide the required certificate. | |
3636 </tag-desc> | |
3637 <tag-name> | |
3638 <literal>expired_cert</literal> (<literal>integer</literal>) | |
3639 </tag-name> | |
3640 <tag-desc> | |
3641 An expired or not yet valid certificate was presented by a client. | |
3642 </tag-desc> | |
3643 <tag-name> | |
3644 <literal>revoked_cert</literal> (<literal>integer</literal>) | |
3645 </tag-name> | |
3646 <tag-desc> | |
3647 A revoked certificate was presented by a client. | |
3648 </tag-desc> | |
3649 <tag-name> | |
3650 <literal>other</literal> (<literal>integer</literal>) | |
3651 </tag-name> | |
3652 <tag-desc> | |
3653 Other SSL certificate verification errors. | |
3654 </tag-desc> | |
3655 </list> | |
3656 </tag-desc> | |
3411 </list> | 3657 </list> |
3412 </tag-desc> | 3658 </tag-desc> |
3413 </list> | 3659 </list> |
3414 <para>Example:</para> | 3660 <para>Example:</para> |
3415 <example> | 3661 <example> |
3427 "received" : 4200363, | 3673 "received" : 4200363, |
3428 "sent" : 20489184, | 3674 "sent" : 20489184, |
3429 "ssl" : { | 3675 "ssl" : { |
3430 "handshakes" : 76455, | 3676 "handshakes" : 76455, |
3431 "handshakes_failed" : 432, | 3677 "handshakes_failed" : 432, |
3432 "session_reuses" : 28770 | 3678 "session_reuses" : 28770, |
3679 "no_common_protocol" : 4, | |
3680 "no_common_cipher" : 2, | |
3681 "handshake_timeout" : 0, | |
3682 "peer_rejected_cert" : 0, | |
3683 "verify_failures" : { | |
3684 "no_cert" : 0, | |
3685 "expired_cert" : 2, | |
3686 "revoked_cert" : 1, | |
3687 "other" : 1 | |
3688 } | |
3433 } | 3689 } |
3434 } | 3690 } |
3435 }</example> | 3691 }</example> |
3436 </listitem> | 3692 </listitem> |
3437 <listitem id="def_nginx_stream_limit_conn_zone"> | 3693 <listitem id="def_nginx_stream_limit_conn_zone"> |
3538 <tag-name> | 3794 <tag-name> |
3539 <literal>session_reuses</literal> (<literal>integer</literal>) | 3795 <literal>session_reuses</literal> (<literal>integer</literal>) |
3540 </tag-name> | 3796 </tag-name> |
3541 <tag-desc> | 3797 <tag-desc> |
3542 The total number of session reuses during SSL handshake. | 3798 The total number of session reuses during SSL handshake. |
3799 </tag-desc> | |
3800 <tag-name> | |
3801 <literal>no_common_protocol</literal> (<literal>integer</literal>) | |
3802 </tag-name> | |
3803 <tag-desc> | |
3804 The number of SSL handshakes failed because of no common protocol. | |
3805 </tag-desc> | |
3806 <tag-name> | |
3807 <literal>handshake_timeout</literal> (<literal>integer</literal>) | |
3808 </tag-name> | |
3809 <tag-desc> | |
3810 The number of SSL handshakes failed because of a timeout. | |
3811 </tag-desc> | |
3812 <tag-name> | |
3813 <literal>peer_rejected_cert</literal> (<literal>integer</literal>) | |
3814 </tag-name> | |
3815 <tag-desc> | |
3816 The number of failed SSL handshakes when nginx presented the certificate to the upstream server but it was rejected with a corresponding alert message. | |
3817 </tag-desc> | |
3818 <tag-name> | |
3819 <literal>verify_failures</literal></tag-name> | |
3820 <tag-desc> | |
3821 SSL certificate verification errors<list type="tag"> | |
3822 <tag-name> | |
3823 <literal>expired_cert</literal> (<literal>integer</literal>) | |
3824 </tag-name> | |
3825 <tag-desc> | |
3826 An expired or not yet valid certificate was presented by an upstream server. | |
3827 </tag-desc> | |
3828 <tag-name> | |
3829 <literal>revoked_cert</literal> (<literal>integer</literal>) | |
3830 </tag-name> | |
3831 <tag-desc> | |
3832 A revoked certificate was presented by an upstream server. | |
3833 </tag-desc> | |
3834 <tag-name> | |
3835 <literal>hostname_mismatch</literal> (<literal>integer</literal>) | |
3836 </tag-name> | |
3837 <tag-desc> | |
3838 Server's certificate doesn't match the hostname. | |
3839 </tag-desc> | |
3840 <tag-name> | |
3841 <literal>other</literal> (<literal>integer</literal>) | |
3842 </tag-name> | |
3843 <tag-desc> | |
3844 Other SSL certificate verification errors. | |
3845 </tag-desc> | |
3846 </list> | |
3543 </tag-desc> | 3847 </tag-desc> |
3544 </list> | 3848 </list> |
3545 </tag-desc> | 3849 </tag-desc> |
3546 <tag-name> | 3850 <tag-name> |
3547 <literal>max_conns</literal> (<literal>integer</literal>) | 3851 <literal>max_conns</literal> (<literal>integer</literal>) |
3674 "state" : "up", | 3978 "state" : "up", |
3675 "active" : 0, | 3979 "active" : 0, |
3676 "ssl" : { | 3980 "ssl" : { |
3677 "handshakes" : 200, | 3981 "handshakes" : 200, |
3678 "handshakes_failed" : 4, | 3982 "handshakes_failed" : 4, |
3679 "session_reuses" : 189 | 3983 "session_reuses" : 189, |
3984 "no_common_protocol" : 4, | |
3985 "handshake_timeout" : 0, | |
3986 "peer_rejected_cert" : 0, | |
3987 "verify_failures" : { | |
3988 "expired_cert" : 2, | |
3989 "revoked_cert" : 1, | |
3990 "hostname_mismatch" : 2, | |
3991 "other" : 1 | |
3992 } | |
3680 }, | 3993 }, |
3681 "max_conns" : 50, | 3994 "max_conns" : 50, |
3682 "connections" : 667231, | 3995 "connections" : 667231, |
3683 "sent" : 251946292, | 3996 "sent" : 251946292, |
3684 "received" : 19222475454, | 3997 "received" : 19222475454, |