Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_api_module_head.xml @ 2469:98fd810c13e0

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 Dec 2019 13:23:05 +0300
parents dd3ac7eefeed
children 407147d8020f
comparison
equal deleted inserted replaced
2468:409e1f755037 2469:98fd810c13e0
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/5/ 104 http://127.0.0.1/api/6/
105 http://127.0.0.1/api/5/nginx 105 http://127.0.0.1/api/6/nginx
106 http://127.0.0.1/api/5/connections 106 http://127.0.0.1/api/6/connections
107 http://127.0.0.1/api/5/http/requests 107 http://127.0.0.1/api/6/http/requests
108 http://127.0.0.1/api/5/http/server_zones/server_backend 108 http://127.0.0.1/api/6/http/server_zones/server_backend
109 http://127.0.0.1/api/5/http/caches/cache_backend 109 http://127.0.0.1/api/6/http/caches/cache_backend
110 http://127.0.0.1/api/5/http/upstreams/backend 110 http://127.0.0.1/api/6/http/upstreams/backend
111 http://127.0.0.1/api/5/http/upstreams/backend/servers/ 111 http://127.0.0.1/api/6/http/upstreams/backend/servers/
112 http://127.0.0.1/api/5/http/upstreams/backend/servers/1 112 http://127.0.0.1/api/6/http/upstreams/backend/servers/1
113 http://127.0.0.1/api/5/http/keyvals/one?key=arg1 113 http://127.0.0.1/api/6/http/keyvals/one?key=arg1
114 http://127.0.0.1/api/5/stream/ 114 http://127.0.0.1/api/6/stream/
115 http://127.0.0.1/api/5/stream/server_zones/server_backend 115 http://127.0.0.1/api/6/stream/server_zones/server_backend
116 http://127.0.0.1/api/5/stream/upstreams/ 116 http://127.0.0.1/api/6/stream/upstreams/
117 http://127.0.0.1/api/5/stream/upstreams/backend 117 http://127.0.0.1/api/6/stream/upstreams/backend
118 http://127.0.0.1/api/5/stream/upstreams/backend/servers/1 118 http://127.0.0.1/api/6/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>5</literal>”. 149 The current API version is “<literal>6</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/5/nginx?fields=version,build 156 http://127.0.0.1/api/6/nginx?fields=version,build
157 </example> 157 </example>
158 </para> 158 </para>
159 159
160 </directive> 160 </directive>
161 161
197 197
198 <para> 198 <para>
199 <list type="bullet"> 199 <list type="bullet">
200 200
201 <listitem> 201 <listitem>
202 The <link id="stream_limit_conns_">/stream/limit_conns/</link> data
203 were added in <link id="api_version">version</link> 6.
204 </listitem>
205
206 <listitem>
207 The <link id="http_limit_conns_">/http/limit_conns/</link> data
208 were added in <link id="api_version">version</link> 6.
209 </listitem>
210
211 <listitem>
212 The <link id="http_limit_reqs_">/http/limit_reqs/</link> data
213 were added in <link id="api_version">version</link> 6.
214 </listitem>
215
216 <listitem>
202 The “<literal>expire</literal>” parameter of a 217 The “<literal>expire</literal>” parameter of a
203 <link doc="ngx_http_keyval_module.xml">key-value</link> pair can be 218 <link doc="ngx_http_keyval_module.xml">key-value</link> pair can be
204 <link id="postHttpKeyvalZoneData">set</link> or 219 <link id="postHttpKeyvalZoneData">set</link> or
205 <link id="patchHttpKeyvalZoneKeyValue">changed</link> 220 <link id="patchHttpKeyvalZoneKeyValue">changed</link>
206 since <link id="api_version">version</link> 5. 221 since <link id="api_version">version</link> 5.