Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_api_module.xml @ 2494:78d4e25adf49

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documented "BodyReadError" in the API.
author Yaroslav Zhuravlev <yar@nginx.com>
date Wed, 29 Jan 2020 19:21:26 +0000
parents 407147d8020f
children 20dbb29cbe05
comparison
equal deleted inserted replaced
2493:407147d8020f 2494:78d4e25adf49
1009 invalid “<literal>weight</literal>” (<literal>UpstreamBadWeight</literal>), 1009 invalid “<literal>weight</literal>” (<literal>UpstreamBadWeight</literal>),
1010 invalid “<literal>max_conns</literal>” (<literal>UpstreamBadMaxConns</literal>), 1010 invalid “<literal>max_conns</literal>” (<literal>UpstreamBadMaxConns</literal>),
1011 invalid “<literal>max_fails</literal>” (<literal>UpstreamBadMaxFails</literal>), 1011 invalid “<literal>max_fails</literal>” (<literal>UpstreamBadMaxFails</literal>),
1012 invalid “<literal>fail_timeout</literal>” (<literal>UpstreamBadFailTimeout</literal>), 1012 invalid “<literal>fail_timeout</literal>” (<literal>UpstreamBadFailTimeout</literal>),
1013 invalid “<literal>slow_start</literal>” (<literal>UpstreamBadSlowStart</literal>), 1013 invalid “<literal>slow_start</literal>” (<literal>UpstreamBadSlowStart</literal>),
1014 reading request body failed <literal>BodyReadError</literal>),
1014 route is too long (<literal>UpstreamBadRoute</literal>), 1015 route is too long (<literal>UpstreamBadRoute</literal>),
1015 “<literal>service</literal>” is empty (<literal>UpstreamBadService</literal>), 1016 “<literal>service</literal>” is empty (<literal>UpstreamBadService</literal>),
1016 no resolver defined to resolve (<literal>UpstreamConfNoResolver</literal>), 1017 no resolver defined to resolve (<literal>UpstreamConfNoResolver</literal>),
1017 upstream “<value>name</value>” has no backup (<literal>UpstreamNoBackup</literal>), 1018 upstream “<value>name</value>” has no backup (<literal>UpstreamNoBackup</literal>),
1018 upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1019 upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1081 invalid “<literal>weight</literal>” (<literal>UpstreamBadWeight</literal>), 1082 invalid “<literal>weight</literal>” (<literal>UpstreamBadWeight</literal>),
1082 invalid “<literal>max_conns</literal>” (<literal>UpstreamBadMaxConns</literal>), 1083 invalid “<literal>max_conns</literal>” (<literal>UpstreamBadMaxConns</literal>),
1083 invalid “<literal>max_fails</literal>” (<literal>UpstreamBadMaxFails</literal>), 1084 invalid “<literal>max_fails</literal>” (<literal>UpstreamBadMaxFails</literal>),
1084 invalid “<literal>fail_timeout</literal>” (<literal>UpstreamBadFailTimeout</literal>), 1085 invalid “<literal>fail_timeout</literal>” (<literal>UpstreamBadFailTimeout</literal>),
1085 invalid “<literal>slow_start</literal>” (<literal>UpstreamBadSlowStart</literal>), 1086 invalid “<literal>slow_start</literal>” (<literal>UpstreamBadSlowStart</literal>),
1087 reading request body failed <literal>BodyReadError</literal>),
1086 route is too long (<literal>UpstreamBadRoute</literal>), 1088 route is too long (<literal>UpstreamBadRoute</literal>),
1087 “<literal>service</literal>” is empty (<literal>UpstreamBadService</literal>), 1089 “<literal>service</literal>” is empty (<literal>UpstreamBadService</literal>),
1088 server “<value>ID</value>” address is immutable (<literal>UpstreamServerImmutable</literal>), 1090 server “<value>ID</value>” address is immutable (<literal>UpstreamServerImmutable</literal>),
1089 server “<literal>ID</literal>” weight is immutable (<literal>UpstreamServerWeightImmutable</literal>), 1091 server “<literal>ID</literal>” weight is immutable (<literal>UpstreamServerWeightImmutable</literal>),
1090 upstream “<literal>name</literal>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1092 upstream “<literal>name</literal>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1192 <listitem>201 - Created</listitem> 1194 <listitem>201 - Created</listitem>
1193 <listitem>400 - Invalid JSON (<literal>KeyvalFormatError</literal>), 1195 <listitem>400 - Invalid JSON (<literal>KeyvalFormatError</literal>),
1194 invalid key format (<literal>KeyvalFormatError</literal>), 1196 invalid key format (<literal>KeyvalFormatError</literal>),
1195 key required (<literal>KeyvalFormatError</literal>), 1197 key required (<literal>KeyvalFormatError</literal>),
1196 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), 1198 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>),
1197 only one key can be added (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1199 only one key can be added (<literal>KeyvalFormatError</literal>),
1200 reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1198 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1201 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1199 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1202 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1200 <listitem>409 - Key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1203 <listitem>409 - Key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1201 <listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem> 1204 <listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem>
1202 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1205 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1220 <list type="bullet"> 1223 <list type="bullet">
1221 <listitem>204 - Success</listitem> 1224 <listitem>204 - Success</listitem>
1222 <listitem>400 - Invalid JSON (<literal>KeyvalFormatError</literal>), 1225 <listitem>400 - Invalid JSON (<literal>KeyvalFormatError</literal>),
1223 key required (<literal>KeyvalFormatError</literal>), 1226 key required (<literal>KeyvalFormatError</literal>),
1224 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), 1227 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>),
1225 only one key can be updated (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1228 only one key can be updated (<literal>KeyvalFormatError</literal>),
1229 reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1226 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), 1230 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>),
1227 keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1231 keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1228 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1232 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1229 <listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem> 1233 <listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem>
1230 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1234 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1543 invalid “<literal>fail_timeout</literal>” (<literal>UpstreamBadFailTimeout</literal>), 1547 invalid “<literal>fail_timeout</literal>” (<literal>UpstreamBadFailTimeout</literal>),
1544 invalid “<literal>slow_start</literal>” (<literal>UpstreamBadSlowStart</literal>), 1548 invalid “<literal>slow_start</literal>” (<literal>UpstreamBadSlowStart</literal>),
1545 “<literal>service</literal>” is empty (<literal>UpstreamBadService</literal>), 1549 “<literal>service</literal>” is empty (<literal>UpstreamBadService</literal>),
1546 no resolver defined to resolve (<literal>UpstreamConfNoResolver</literal>), 1550 no resolver defined to resolve (<literal>UpstreamConfNoResolver</literal>),
1547 upstream “<value>name</value>” has no backup (<literal>UpstreamNoBackup</literal>), 1551 upstream “<value>name</value>” has no backup (<literal>UpstreamNoBackup</literal>),
1548 upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1552 upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</literal>),
1553 reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1549 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1554 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1550 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1555 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1551 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1556 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1552 </list> 1557 </list>
1553 </listitem> 1558 </listitem>
1612 invalid “<literal>weight</literal>” (<literal>UpstreamBadWeight</literal>), 1617 invalid “<literal>weight</literal>” (<literal>UpstreamBadWeight</literal>),
1613 invalid “<literal>max_conns</literal>” (<literal>UpstreamBadMaxConns</literal>), 1618 invalid “<literal>max_conns</literal>” (<literal>UpstreamBadMaxConns</literal>),
1614 invalid “<literal>max_fails</literal>” (<literal>UpstreamBadMaxFails</literal>), 1619 invalid “<literal>max_fails</literal>” (<literal>UpstreamBadMaxFails</literal>),
1615 invalid “<literal>fail_timeout</literal>” (<literal>UpstreamBadFailTimeout</literal>), 1620 invalid “<literal>fail_timeout</literal>” (<literal>UpstreamBadFailTimeout</literal>),
1616 invalid “<literal>slow_start</literal>” (<literal>UpstreamBadSlowStart</literal>), 1621 invalid “<literal>slow_start</literal>” (<literal>UpstreamBadSlowStart</literal>),
1622 reading request body failed <literal>BodyReadError</literal>),
1617 “<literal>service</literal>” is empty (<literal>UpstreamBadService</literal>), 1623 “<literal>service</literal>” is empty (<literal>UpstreamBadService</literal>),
1618 server “<value>ID</value>” address is immutable (<literal>UpstreamServerImmutable</literal>), 1624 server “<value>ID</value>” address is immutable (<literal>UpstreamServerImmutable</literal>),
1619 server “<value>ID</value>” weight is immutable (<literal>UpstreamServerWeightImmutable</literal>), 1625 server “<value>ID</value>” weight is immutable (<literal>UpstreamServerWeightImmutable</literal>),
1620 upstream “<literal>name</literal>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1626 upstream “<literal>name</literal>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1621 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), 1627 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>),
1722 <listitem>201 - Created</listitem> 1728 <listitem>201 - Created</listitem>
1723 <listitem>400 - Invalid JSON (<literal>KeyvalFormatError</literal>), 1729 <listitem>400 - Invalid JSON (<literal>KeyvalFormatError</literal>),
1724 invalid key format (<literal>KeyvalFormatError</literal>), 1730 invalid key format (<literal>KeyvalFormatError</literal>),
1725 key required (<literal>KeyvalFormatError</literal>), 1731 key required (<literal>KeyvalFormatError</literal>),
1726 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), 1732 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>),
1727 only one key can be added (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1733 only one key can be added (<literal>KeyvalFormatError</literal>),
1734 reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1728 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1735 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1729 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1736 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1730 <listitem>409 - Key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1737 <listitem>409 - Key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1731 <listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem> 1738 <listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem>
1732 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1739 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1750 <list type="bullet"> 1757 <list type="bullet">
1751 <listitem>204 - Success</listitem> 1758 <listitem>204 - Success</listitem>
1752 <listitem>400 - Invalid JSON (<literal>KeyvalFormatError</literal>), 1759 <listitem>400 - Invalid JSON (<literal>KeyvalFormatError</literal>),
1753 key required (<literal>KeyvalFormatError</literal>), 1760 key required (<literal>KeyvalFormatError</literal>),
1754 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), 1761 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>),
1755 only one key can be updated (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1762 only one key can be updated (<literal>KeyvalFormatError</literal>),
1763 reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1756 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), 1764 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>),
1757 keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1765 keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1758 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1766 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1759 <listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem> 1767 <listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem>
1760 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1768 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>