Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_api_module_head.xml @ 2424:dd3ac7eefeed

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 Ruslan Ermilov <ru@nginx.com>
date Mon, 02 Sep 2019 14:12:20 +0300
parents d5e576eb7677
children 98fd810c13e0
comparison
equal deleted inserted replaced
2423:21f1376238b0 2424:dd3ac7eefeed
99 </example> 99 </example>
100 All API requests include 100 All API requests include
101 a supported API <link id="api_version">version</link> in the URI. 101 a supported API <link id="api_version">version</link> in the URI.
102 Examples of API requests with this configuration: 102 Examples of API requests with this configuration:
103 <example> 103 <example>
104 http://127.0.0.1/api/4/ 104 http://127.0.0.1/api/5/
105 http://127.0.0.1/api/4/nginx 105 http://127.0.0.1/api/5/nginx
106 http://127.0.0.1/api/4/connections 106 http://127.0.0.1/api/5/connections
107 http://127.0.0.1/api/4/http/requests 107 http://127.0.0.1/api/5/http/requests
108 http://127.0.0.1/api/4/http/server_zones/server_backend 108 http://127.0.0.1/api/5/http/server_zones/server_backend
109 http://127.0.0.1/api/4/http/caches/cache_backend 109 http://127.0.0.1/api/5/http/caches/cache_backend
110 http://127.0.0.1/api/4/http/upstreams/backend 110 http://127.0.0.1/api/5/http/upstreams/backend
111 http://127.0.0.1/api/4/http/upstreams/backend/servers/ 111 http://127.0.0.1/api/5/http/upstreams/backend/servers/
112 http://127.0.0.1/api/4/http/upstreams/backend/servers/1 112 http://127.0.0.1/api/5/http/upstreams/backend/servers/1
113 http://127.0.0.1/api/4/http/keyvals/one?key=arg1 113 http://127.0.0.1/api/5/http/keyvals/one?key=arg1
114 http://127.0.0.1/api/4/stream/ 114 http://127.0.0.1/api/5/stream/
115 http://127.0.0.1/api/4/stream/server_zones/server_backend 115 http://127.0.0.1/api/5/stream/server_zones/server_backend
116 http://127.0.0.1/api/4/stream/upstreams/ 116 http://127.0.0.1/api/5/stream/upstreams/
117 http://127.0.0.1/api/4/stream/upstreams/backend 117 http://127.0.0.1/api/5/stream/upstreams/backend
118 http://127.0.0.1/api/4/stream/upstreams/backend/servers/1 118 http://127.0.0.1/api/5/stream/upstreams/backend/servers/1
119 </example> 119 </example>
120 </para> 120 </para>
121 121
122 </section> 122 </section>
123 123
144 144
145 <para id="api_version"> 145 <para id="api_version">
146 All API requests should contain a supported API version in the URI. 146 All API requests should contain a supported API version in the URI.
147 If the request URI equals the location prefix, 147 If the request URI equals the location prefix,
148 the list of supported API versions is returned. 148 the list of supported API versions is returned.
149 The current API version is “<literal>4</literal>”. 149 The current API version is “<literal>5</literal>”.
150 </para> 150 </para>
151 151
152 <para> 152 <para>
153 The optional “<literal>fields</literal>” argument in the request line 153 The optional “<literal>fields</literal>” argument in the request line
154 specifies which fields of the requested objects will be output: 154 specifies which fields of the requested objects will be output:
155 <example> 155 <example>
156 http://127.0.0.1/api/4/nginx?fields=version,build 156 http://127.0.0.1/api/5/nginx?fields=version,build
157 </example> 157 </example>
158 </para> 158 </para>
159 159
160 </directive> 160 </directive>
161 161
162 162
163 <directive name="status_zone"> 163 <directive name="status_zone">
164 <syntax><value>zone</value></syntax> 164 <syntax><value>zone</value></syntax>
165 <default/> 165 <default/>
166 <context>server</context> 166 <context>server</context>
167 <context>location</context>
168 <context>if in location</context>
167 <appeared-in>1.13.12</appeared-in> 169 <appeared-in>1.13.12</appeared-in>
168 170
169 <para> 171 <para>
170 Enables collection of virtual 172 Enables collection of virtual
171 <link doc="ngx_http_core_module.xml" id="server">http</link> 173 <link doc="ngx_http_core_module.xml" id="server">http</link>
173 <link doc="../stream/ngx_stream_core_module.xml" id="server">stream</link> 175 <link doc="../stream/ngx_stream_core_module.xml" id="server">stream</link>
174 server status information in the specified <value>zone</value>. 176 server status information in the specified <value>zone</value>.
175 Several servers may share the same zone. 177 Several servers may share the same zone.
176 </para> 178 </para>
177 179
180 <para id="status_zone_location">
181 Starting from 1.17.0, status information can be collected
182 per <link doc="ngx_http_core_module.xml" id="location"/>.
183 The special value <literal>off</literal> disables statistics collection
184 in nested location blocks.
185 Note that the statistics is collected
186 in the context of a location where processing ends.
187 It may be different from the original location, if an
188 <link doc="ngx_http_core_module.xml" id="internal">internal
189 redirect</link> happens during request processing.
190 </para>
191
178 </directive> 192 </directive>
179 193
180 </section> 194 </section>
181 195
182 <section id="compatibility" name="Compatibility"> 196 <section id="compatibility" name="Compatibility">
183 197
184 <para> 198 <para>
185 <list type="bullet"> 199 <list type="bullet">
200
201 <listitem>
202 The “<literal>expire</literal>” parameter of a
203 <link doc="ngx_http_keyval_module.xml">key-value</link> pair can be
204 <link id="postHttpKeyvalZoneData">set</link> or
205 <link id="patchHttpKeyvalZoneKeyValue">changed</link>
206 since <link id="api_version">version</link> 5.
207 </listitem>
208
209 <listitem>
210 The <link id="resolvers_">/resolvers/</link> data
211 were added in <link id="api_version">version</link> 5.
212 </listitem>
213
214 <listitem>
215 The <link id="http_location_zones_">/http/location_zones/</link> data
216 were added in <link id="api_version">version</link> 5.
217 </listitem>
186 218
187 <listitem> 219 <listitem>
188 The <literal>path</literal> and <literal>method</literal> fields of 220 The <literal>path</literal> and <literal>method</literal> fields of
189 <link id="def_nginx_error">nginx error object</link> 221 <link id="def_nginx_error">nginx error object</link>
190 were removed in <link id="api_version">version</link> 4. 222 were removed in <link id="api_version">version</link> 4.