モジュール ngx_http_api_module
ngx_http_api_module
モジュール (1.13.3) は、様々なステータス情報のアクセス、アップストリームサーバーグループの動的な設定、およびnginxを再設定することなくキーバリューペアの管理を行うためのREST APIを提供します。
このモジュールは、ngx_http_status_moduleおよびngx_http_upstream_conf_moduleモジュールに取って代わるものです。
PATCH
またはPOST
メソッドを使用する場合は、ペイロードがクライアントリクエストボディの読み取りのためのバッファサイズを超えないようにしてください。そうでない場合、413(リクエストエンティティが大きすぎる)エラーが返される可能性があります。
このモジュールは、当社の商用サブスクリプションの一部として提供されています。
設定例
http { upstream backend { zone http_backend 64k; server backend1.example.com weight=5; server backend2.example.com; } proxy_cache_path /data/nginx/cache_backend keys_zone=cache_backend:10m; server { server_name backend.example.com; location / { proxy_pass http://backend; proxy_cache cache_backend; health_check; } status_zone server_backend; } keyval_zone zone=one:32k state=one.keyval; keyval $arg_text $text zone=one; server { listen 127.0.0.1; location /api { api write=on; allow 127.0.0.1; deny all; } } } stream { upstream backend { zone stream_backend 64k; server backend1.example.com:12345 weight=5; server backend2.example.com:12345; } server { listen 127.0.0.1:12345; proxy_pass backend; status_zone server_backend; health_check; } }
すべてのAPIリクエストには、サポートされているAPIバージョンがURIに含まれています。この設定によるAPIリクエストの例
http://127.0.0.1/api/9/ http://127.0.0.1/api/9/nginx http://127.0.0.1/api/9/connections http://127.0.0.1/api/9/workers http://127.0.0.1/api/9/http/requests http://127.0.0.1/api/9/http/server_zones/server_backend http://127.0.0.1/api/9/http/caches/cache_backend http://127.0.0.1/api/9/http/upstreams/backend http://127.0.0.1/api/9/http/upstreams/backend/servers/ http://127.0.0.1/api/9/http/upstreams/backend/servers/1 http://127.0.0.1/api/9/http/keyvals/one?key=arg1 http://127.0.0.1/api/9/stream/ http://127.0.0.1/api/9/stream/server_zones/server_backend http://127.0.0.1/api/9/stream/upstreams/ http://127.0.0.1/api/9/stream/upstreams/backend http://127.0.0.1/api/9/stream/upstreams/backend/servers/1
ディレクティブ
構文 |
api [ |
---|---|
デフォルト | — |
コンテキスト |
location |
周囲のlocationでREST APIインターフェースを有効にします。このlocationへのアクセスは制限する必要があります。
write
パラメータは、APIが読み取り専用か読み書き可能かを決定します。デフォルトでは、APIは読み取り専用です。
すべてのAPIリクエストには、サポートされているAPIバージョンをURIに含める必要があります。リクエストURIがlocationプレフィックスと等しい場合、サポートされているAPIバージョンのリストが返されます。現在のAPIバージョンは「9
」です。
リクエスト行のオプションの「fields
」引数は、要求されたオブジェクトのどのフィールドを出力するかを指定します。
http://127.0.0.1/api/9/nginx?fields=version,build
構文 |
status_zone |
---|---|
デフォルト | — |
コンテキスト |
server 、location 、if in location |
このディレクティブはバージョン1.13.12で登場しました。
指定されたzone
に仮想httpまたはstreamサーバーのステータス情報を収集できるようにします。複数のサーバーが同じゾーンを共有できます。
1.17.0以降、ステータス情報はlocationごとに収集できます。特別な値off
は、ネストされたlocationブロックでの統計情報の収集を無効にします。統計情報は、処理が終了するlocationのコンテキストで収集されることに注意してください。リクエスト処理中に内部リダイレクトが発生した場合、元のlocationとは異なる場合があります。
互換性
- /licenseデータはバージョン9 (1.27.2)で追加されました。
- /workers/データはバージョン9で追加されました。
- 詳細な失敗カウンタがバージョン8 (1.23.2)でSSL統計に追加されました。
- 各HTTPアップストリーム、サーバーゾーン、およびストリームアップストリーム、サーバーゾーンの
ssl
データは、バージョン8 (1.21.6)で追加されました。 - 各HTTPアップストリーム、サーバーゾーン、およびロケーションゾーンの
responses
内のcodes
データは、バージョン7で追加されました。 - /stream/limit_conns/データはバージョン6で追加されました。
- /http/limit_conns/データはバージョン6で追加されました。
- /http/limit_reqs/データはバージョン6で追加されました。
- キーバリューペアの「
expire
」パラメータは、バージョン5以降設定または変更できます。 - /resolvers/データはバージョン5で追加されました。
- /http/location_zones/データはバージョン5で追加されました。
- nginxエラーオブジェクトの
path
フィールドとmethod
フィールドはバージョン4で削除されました。これらのフィールドは以前のAPIバージョンには存在しますが、空の値が表示されます。 - /stream/zone_sync/データはバージョン3で追加されました。
- drainパラメータはバージョン2で追加されました。
- /stream/keyvals/データはバージョン2で追加されました。
エンドポイント
-
/
-
サポートされているメソッド
-
GET
- ルートエンドポイントのリストを返すルートエンドポイントのリストを返します。
可能な応答
- 200 - 成功、文字列の配列を返す
- 404 - 不明なバージョン (
UnknownVersion
)、エラーを返す
-
-
/nginx
-
サポートされているメソッド
-
/processes
-
サポートされているメソッド
-
/connections
-
サポートされているメソッド
-
GET
- クライアント接続統計を返すクライアント接続の統計を返します。
リクエストパラメータ
fields
(string
、オプション)- 接続統計のどのフィールドを出力するかを制限します。
可能な応答
- 200 - 成功、Connectionsを返す
- 404 - 不明なバージョン (
UnknownVersion
)、エラーを返す
-
DELETE
- クライアント接続統計をリセットする受理およびドロップされたクライアント接続の統計をリセットします。
可能な応答
-
-
/slabs/
-
サポートされているメソッド
-
GET
- すべてのスラブのステータスを返すスラブアロケータを持つ各共有メモリゾーンのスラブのステータスを返します。
リクエストパラメータ
fields
(string
、オプション)- スラブゾーンのどのフィールドを出力するかを制限します。「
fields
」値が空の場合、ゾーン名のみが出力されます。
可能な応答
- 200 - 成功、すべてのスラブの「スラブアロケータを持つ共有メモリゾーン」オブジェクトのコレクションを返す
- 404 - 不明なバージョン (
UnknownVersion
)、エラーを返す
-
-
/slabs/{slabZoneName}
- すべてのメソッドで共通のパラメータ
slabZoneName
(string
、必須)- スラブアロケータを持つ共有メモリゾーンの名前。
サポートされているメソッド
-
GET
- スラブのステータスを返す特定のスラブアロケータを持つ共有メモリゾーンのスラブのステータスを返します。
リクエストパラメータ
fields
(string
、オプション)- スラブゾーンのどのフィールドを出力するかを制限します。
可能な応答
- 200 - 成功、スラブアロケータを持つ共有メモリゾーンを返す
- 404 - スラブが見つからない (
SlabNotFound
)、不明なバージョン (UnknownVersion
)、エラーを返す
-
DELETE
- スラブ統計をリセットする各メモリスロットの「
reqs
」および「fails
」メトリックをリセットします。可能な応答
-
/http/
-
サポートされているメソッド
-
GET
- HTTP関連のエンドポイントのリストを返す最初のレベルのHTTPエンドポイントのリストを返します。
可能な応答
- 200 - 成功、文字列の配列を返す
- 404 - 不明なバージョン (
UnknownVersion
)、エラーを返す
-
-
/http/requests
-
サポートされているメソッド
-
GET
- HTTPリクエスト統計を返すクライアントHTTPリクエストのステータスを返します。
リクエストパラメータ
fields
(string
、オプション)- クライアントHTTPリクエスト統計のどのフィールドを出力するかを制限します。
可能な応答
- 200 - 成功、HTTP Requestsを返す
- 404 - 不明なバージョン (
UnknownVersion
)、エラーを返す
-
DELETE
- HTTPリクエスト統計をリセットする合計クライアントHTTPリクエストの数をリセットします。
可能な応答
-
-
/http/server_zones/
-
サポートされているメソッド
-
GET
- すべてのHTTPサーバーゾーンのステータスを返す各HTTPサーバーゾーンのステータス情報を返します。
リクエストパラメータ
fields
(string
、オプション)- サーバーゾーンのどのフィールドを出力するかを制限します。「
fields
」値が空の場合、サーバーゾーン名のみが出力されます。
可能な応答
- 200 - 成功、すべてのHTTPサーバーゾーンの「HTTP Server Zone」オブジェクトのコレクションを返す
- 404 - 不明なバージョン (
UnknownVersion
)、エラーを返す
-
-
/http/server_zones/{httpServerZoneName}
- すべてのメソッドで共通のパラメータ
httpServerZoneName
(string
、必須)- HTTPサーバーゾーンの名前。
サポートされているメソッド
-
GET
- HTTPサーバーゾーンのステータスを返す特定のHTTPサーバーゾーンのステータスを返します。
リクエストパラメータ
fields
(string
、オプション)- サーバーゾーンのどのフィールドを出力するかを制限します。
可能な応答
- 200 - 成功、HTTP Server Zoneを返す
- 404 - サーバーゾーンが見つからない (
ServerZoneNotFound
)、不明なバージョン (UnknownVersion
)、エラーを返す
-
DELETE
- HTTPサーバーゾーンの統計をリセットする特定のHTTPサーバーゾーンで、受理および破棄されたリクエスト、レスポンス、送受信されたバイト数、SSLハンドシェイクとセッション再利用のカウンタの統計をリセットします。
可能な応答
-
/http/location_zones/
-
サポートされているメソッド
-
GET
- すべてのHTTPロケーションゾーンのステータスを返す各HTTPロケーションゾーンのステータス情報を返します。
リクエストパラメータ
fields
(string
、オプション)- ロケーションゾーンのどのフィールドを出力するかを制限します。「
fields
」値が空の場合、ゾーン名のみが出力されます。
可能な応答
- 200 - 成功、すべてのHTTPロケーションゾーンの「HTTP Location Zone」オブジェクトのコレクションを返す
- 404 - 不明なバージョン (
UnknownVersion
)、エラーを返す
-
-
/http/location_zones/{httpLocationZoneName}
- すべてのメソッドで共通のパラメータ
httpLocationZoneName
(string
、必須)- HTTPロケーションゾーンの名前。
サポートされているメソッド
-
GET
- HTTPロケーションゾーンのステータスを返す特定のHTTPロケーションゾーンのステータスを返します。
リクエストパラメータ
fields
(string
、オプション)- ロケーションゾーンのどのフィールドを出力するかを制限します。
可能な応答
- 200 - 成功、HTTP Location Zoneを返す
- 404 - ロケーションゾーンが見つからない (
LocationZoneNotFound
)、不明なバージョン (UnknownVersion
)、エラーを返す
-
DELETE
- ロケーションゾーンの統計をリセットする。特定のロケーションゾーンで、受理および破棄されたリクエスト、レスポンス、送受信されたバイト数の統計をリセットします。
可能な応答
-
/http/caches/
-
サポートされているメソッド
-
GET
- すべてのキャッシュのステータスを返すproxy_cache_pathおよびその他の「
*_cache_path
」ディレクティブで設定された各キャッシュのステータスを返します。リクエストパラメータ
fields
(string
、オプション)- キャッシュゾーンの出力するフィールドを制限します。「
fields
」値が空の場合、キャッシュゾーンの名前のみが出力されます。
可能な応答
-
-
/http/caches/{httpCacheZoneName}
- すべてのメソッドで共通のパラメータ
httpCacheZoneName
(string
, 必須)- キャッシュゾーンの名前。
サポートされているメソッド
-
GET
- キャッシュのステータスを返す特定のキャッシュのステータスを返します。
リクエストパラメータ
fields
(string
、オプション)- キャッシュゾーンの出力するフィールドを制限します。
可能な応答
-
DELETE
- キャッシュ統計をリセットする特定のキャッシュゾーンにおけるキャッシュヒット/ミス統計をリセットします。
可能な応答
-
/http/limit_conns/
-
サポートされているメソッド
-
GET
- すべてのHTTP limit_connゾーンのステータスを返す各HTTP limit_connゾーンのステータス情報を返します。
リクエストパラメータ
fields
(string
、オプション)- limit_connゾーンの出力するフィールドを制限します。「
fields
」値が空の場合、ゾーン名のみが出力されます。
可能な応答
-
-
/http/limit_conns/{httpLimitConnZoneName}
- すべてのメソッドで共通のパラメータ
httpLimitConnZoneName
(string
, 必須)- limit_connゾーンの名前。
サポートされているメソッド
-
GET
- HTTP limit_connゾーンのステータスを返す特定のHTTP limit_connゾーンのステータスを返します。
リクエストパラメータ
fields
(string
、オプション)- limit_connゾーンの出力するフィールドを制限します。
可能な応答
-
DELETE
- HTTP limit_connゾーンの統計をリセットする接続制限統計をリセットします。
可能な応答
-
/http/limit_reqs/
-
サポートされているメソッド
-
GET
- すべてのHTTP limit_reqゾーンのステータスを返す各HTTP limit_reqゾーンのステータス情報を返します。
リクエストパラメータ
fields
(string
、オプション)- limit_reqゾーンの出力するフィールドを制限します。「
fields
」値が空の場合、ゾーン名のみが出力されます。
可能な応答
- 200 - 成功。すべてのHTTP limit_reqの "HTTPリクエストレート制限" オブジェクトのコレクションを返します。
- 404 - 不明なバージョン (
UnknownVersion
)、エラーを返す
-
-
/http/limit_reqs/{httpLimitReqZoneName}
- すべてのメソッドで共通のパラメータ
httpLimitReqZoneName
(string
, 必須)- limit_reqゾーンの名前。
サポートされているメソッド
-
GET
- HTTP limit_reqゾーンのステータスを返す特定のHTTP limit_reqゾーンのステータスを返します。
リクエストパラメータ
fields
(string
、オプション)- limit_reqゾーンの出力するフィールドを制限します。
可能な応答
- 200 - 成功。HTTPリクエストレート制限を返します。
- 404 - limit_reqが見つかりません (
LimitReqNotFound
)、不明なバージョン (UnknownVersion
)。エラーを返します。
-
DELETE
- HTTP limit_reqゾーンの統計をリセットするリクエスト制限統計をリセットします。
可能な応答
-
/http/upstreams/
-
サポートされているメソッド
-
GET
- すべてのHTTPアップストリームサーバーグループのステータスを返す各HTTPアップストリームサーバーグループとそのサーバーのステータスを返します。
リクエストパラメータ
fields
(string
、オプション)- アップストリームサーバーグループの出力するフィールドを制限します。「
fields
」値が空の場合、アップストリームの名前のみが出力されます。
可能な応答
- 200 - 成功。すべてのHTTPアップストリームの "HTTPアップストリーム" オブジェクトのコレクションを返します。
- 404 - 不明なバージョン (
UnknownVersion
)、エラーを返す
-
-
/http/upstreams/{httpUpstreamName}/
- すべてのメソッドで共通のパラメータ
httpUpstreamName
(string
, 必須)- HTTPアップストリームサーバーグループの名前。
サポートされているメソッド
-
GET
- HTTPアップストリームサーバーグループのステータスを返す特定のHTTPアップストリームサーバーグループとそのサーバーのステータスを返します。
リクエストパラメータ
fields
(string
、オプション)- アップストリームサーバーグループの出力するフィールドを制限します。
可能な応答
- 200 - 成功。HTTPアップストリームを返します。
- 400 - アップストリームは静的です (
UpstreamStatic
)。エラーを返します。 - 404 - 不明なバージョン (
UnknownVersion
)、アップストリームが見つかりません (UpstreamNotFound
)。エラーを返します。
-
DELETE
- HTTPアップストリームサーバーグループの統計をリセットするアップストリームサーバーグループ内の各アップストリームサーバーとキュー統計の統計をリセットします。
可能な応答
-
/http/upstreams/{httpUpstreamName}/servers/
- すべてのメソッドで共通のパラメータ
httpUpstreamName
(string
, 必須)- アップストリームサーバーグループの名前。
サポートされているメソッド
-
GET
- HTTPアップストリームサーバーグループ内のすべてのサーバーの構成を返す特定のHTTPアップストリームサーバーグループ内の各サーバーの構成を返します。
可能な応答
- 200 - 成功。HTTPアップストリームサーバーの配列を返します。
- 400 - アップストリームは静的です (
UpstreamStatic
)。エラーを返します。 - 404 - 不明なバージョン (
UnknownVersion
)、アップストリームが見つかりません (UpstreamNotFound
)。エラーを返します。
-
POST
- HTTPアップストリームサーバーグループにサーバーを追加するHTTPアップストリームサーバーグループに新しいサーバーを追加します。サーバーパラメーターはJSON形式で指定します。
リクエストパラメータ
postHttpUpstreamServer
(HTTPアップストリームサーバー, 必須)- 新しいサーバーのアドレスとその他のオプションパラメーターをJSON形式で指定します。「
ID
」、「backup
」、および「service
」パラメーターは変更できません。
可能な応答
- 201 - 作成済み。HTTPアップストリームサーバーを返します。
- 400 - アップストリームは静的です (
UpstreamStatic
)、無効な「parameter
」値 (UpstreamConfFormatError
)、 「server
」引数がありません (UpstreamConfFormatError
)、不明なパラメーター「name
」(UpstreamConfFormatError
)、ネストされたオブジェクトまたはリスト (UpstreamConfFormatError
)、構文解析時の「error
」(UpstreamBadAddress
)、サービスアップストリーム「host
」にポートを含めることができません (UpstreamBadAddress
)、サービスアップストリーム「host
」にはドメイン名が必要です (UpstreamBadAddress
)、無効な「weight
」(UpstreamBadWeight
)、無効な「max_conns
」(UpstreamBadMaxConns
)、無効な「max_fails
」(UpstreamBadMaxFails
)、無効な「fail_timeout
」(UpstreamBadFailTimeout
)、無効な「slow_start
」(UpstreamBadSlowStart
)、リクエストボディの読み込みに失敗しました (BodyReadError
)、ルートが長すぎます (UpstreamBadRoute
)、 「service
」が空です (UpstreamBadService
)、解決するためのレゾルバーが定義されていません (UpstreamConfNoResolver
)、アップストリーム「name
」にバックアップがありません (UpstreamNoBackup
)、アップストリーム「name
」のメモリが不足しています (UpstreamOutOfMemory
)。エラーを返します。 - 404 - 不明なバージョン (
UnknownVersion
)、アップストリームが見つかりません (UpstreamNotFound
)。エラーを返します。 - 405 - メソッドが無効 (
MethodDisabled
)、エラーを返す - 409 - エントリが存在します (
EntryExists
)。エラーを返します。 - 415 - JSONエラー (
JsonError
)。エラーを返します。
-
/http/upstreams/{httpUpstreamName}/servers/{httpUpstreamServerId}
- すべてのメソッドで共通のパラメータ
httpUpstreamName
(string
, 必須)- アップストリームサーバーグループの名前。
httpUpstreamServerId
(string
, 必須)- サーバーのID。
サポートされているメソッド
-
GET
- HTTPアップストリームサーバーグループ内のサーバーの構成を返すHTTPアップストリームサーバーグループ内の特定のサーバーの構成を返します。
可能な応答
- 200 - 成功。HTTPアップストリームサーバーを返します。
- 400 - アップストリームは静的です (
UpstreamStatic
)、無効なサーバーID (UpstreamBadServerId
)。エラーを返します。 - 404 - ID「
id
」のサーバーが存在しません (UpstreamServerNotFound
)、不明なバージョン (UnknownVersion
)、アップストリームが見つかりません (UpstreamNotFound
)。エラーを返します。
-
PATCH
- HTTPアップストリームサーバーグループ内のサーバーを変更するHTTPアップストリームサーバーグループ内の特定のサーバーの設定を変更します。サーバーパラメーターはJSON形式で指定します。
リクエストパラメータ
patchHttpUpstreamServer
(HTTPアップストリームサーバー, 必須)- JSON形式で指定されたサーバーパラメーター。「
ID
」、「backup
」、および「service
」パラメーターは変更できません。
可能な応答
- 200 - 成功。HTTPアップストリームサーバーを返します。
- 400 - アップストリームは静的です (
UpstreamStatic
)、無効な「parameter
」値 (UpstreamConfFormatError
)、不明なパラメーター「name
」(UpstreamConfFormatError
)、ネストされたオブジェクトまたはリスト (UpstreamConfFormatError
)、構文解析時の「error
」(UpstreamBadAddress
)、無効な「server
」引数 (UpstreamBadAddress
)、無効なサーバーID (UpstreamBadServerId
)、無効な「weight
」(UpstreamBadWeight
)、無効な「max_conns
」(UpstreamBadMaxConns
)、無効な「max_fails
」(UpstreamBadMaxFails
)、無効な「fail_timeout
」(UpstreamBadFailTimeout
)、無効な「slow_start
」(UpstreamBadSlowStart
)、リクエストボディの読み込みに失敗しました (BodyReadError
)、ルートが長すぎます (UpstreamBadRoute
)、 「service
」が空です (UpstreamBadService
)、サーバー「ID
」のアドレスは変更できません (UpstreamServerImmutable
)、サーバー「ID
」のweightは変更できません (UpstreamServerWeightImmutable
)、アップストリーム「name
」のメモリが不足しています (UpstreamOutOfMemory
)。エラーを返します。 - 404 - ID「
id
」のサーバーが存在しません (UpstreamServerNotFound
)、不明なバージョン (UnknownVersion
)、アップストリームが見つかりません (UpstreamNotFound
)。エラーを返します。 - 405 - メソッドが無効 (
MethodDisabled
)、エラーを返す - 415 - JSONエラー (
JsonError
)。エラーを返します。
-
DELETE
- HTTPアップストリームサーバーグループからサーバーを削除するHTTPアップストリームサーバーグループからサーバーを削除します。
可能な応答
- 200 - 成功。HTTPアップストリームサーバーの配列を返します。
- 400 - アップストリームは静的です (
UpstreamStatic
)、無効なサーバーID (UpstreamBadServerId
)、サーバー「id
」は削除できません (UpstreamServerImmutable
)。エラーを返します。 - 404 - ID「
id
」のサーバーが存在しません (UpstreamServerNotFound
)、不明なバージョン (UnknownVersion
)、アップストリームが見つかりません (UpstreamNotFound
)。エラーを返します。 - 405 - メソッドが無効 (
MethodDisabled
)、エラーを返す
-
/http/keyvals/
-
サポートされているメソッド
-
GET
- すべてのHTTP keyvalゾーンからキーバリューペアを返す各HTTP keyval共有メモリゾーンのキーバリューペアを返します。
リクエストパラメータ
fields
(string
、オプション)- 「
fields
」値が空の場合、HTTP keyvalゾーン名のみが出力されます。
可能な応答
- 200 - 成功。すべてのHTTP keyvalsの "HTTP Keyval共有メモリゾーン" オブジェクトのコレクションを返します。
- 404 - 不明なバージョン (
UnknownVersion
)、エラーを返す
-
-
/http/keyvals/{httpKeyvalZoneName}
- すべてのメソッドで共通のパラメータ
httpKeyvalZoneName
(string
, 必須)- HTTP keyval共有メモリゾーンの名前。
サポートされているメソッド
-
GET
- HTTP keyvalゾーンからキーバリューペアを返す特定のHTTP keyval共有メモリゾーンに格納されているキーバリューペアを返します。
リクエストパラメータ
key
(string
, オプション)- HTTP keyvalゾーンから特定のキーバリューペアを取得します。
可能な応答
- 200 - 成功。HTTP Keyval共有メモリゾーンを返します。
- 404 - Keyvalが見つかりません (
KeyvalNotFound
)、keyvalキーが見つかりません (KeyvalKeyNotFound
)、不明なバージョン (UnknownVersion
)。エラーを返します。
-
POST
- HTTP keyvalゾーンにキーバリューペアを追加するHTTP keyval共有メモリゾーンに新しいキーバリューペアを追加します。HTTP keyval共有メモリゾーンが空の場合、複数のキーバリューペアを入力できます。
リクエストパラメータ
Key-value
(HTTP Keyval共有メモリゾーン, 必須)- キーバリューペアはJSON形式で指定します。HTTP keyval共有メモリゾーンが空の場合、複数のキーバリューペアを入力できます。キーバリューペアには、
expire
パラメーターを使用してミリ秒単位の有効期限時間を指定できます。これは、keyval_zoneディレクティブのtimeout
パラメーターを上書きします。
可能な応答
- 201 - 作成済み
- 400 - 無効なJSON (
KeyvalFormatError
)、無効なキー形式 (KeyvalFormatError
)、キーが必要です (KeyvalFormatError
)、keyvalタイムアウトが無効です (KeyvalFormatError
)、追加できるキーは1つだけです (KeyvalFormatError
)、リクエストボディの読み込みに失敗しました (BodyReadError
)。エラーを返します。 - 404 - Keyvalが見つかりません (
KeyvalNotFound
)、不明なバージョン (UnknownVersion
)。エラーを返します。 - 405 - メソッドが無効 (
MethodDisabled
)、エラーを返す - 409 - エントリが存在します (
EntryExists
)、キーは既に存在します (KeyvalKeyExists
)。エラーを返します。 - 413 - リクエストエンティティが大きすぎます。エラーを返します。
- 415 - JSONエラー (
JsonError
)。エラーを返します。
-
PATCH
- キーバリューの変更またはキーの削除キーバリューペアの選択されたキーの値を変更します。キーの値を
null
に設定することでキーを削除し、キーバリューペアの有効期限を変更します。クラスタ内のkeyvalゾーンの同期が有効になっている場合、ターゲットクラスタノードでのみキーを削除します。ミリ秒単位の有効期限は、expire
パラメータでキーバリューペアに指定でき、timeout
パラメータをkeyval_zoneディレクティブで上書きします。リクエストパラメータ
httpKeyvalZoneKeyValue
(HTTP Keyval共有メモリゾーン、必須)- キーの新しい値はJSON形式で指定します。
可能な応答
- 204 - 成功
- 400 - 無効なJSON(
KeyvalFormatError
)、キーが必要(KeyvalFormatError
)、keyvalタイムアウトが無効(KeyvalFormatError
)、更新できるキーは1つのみ(KeyvalFormatError
)、リクエストボディの読み込みに失敗(BodyReadError
)、エラーを返します。 - 404 - Keyvalが見つかりません (
KeyvalNotFound
)、keyvalキーが見つかりません (KeyvalKeyNotFound
)、不明なバージョン (UnknownVersion
)。エラーを返します。 - 405 - メソッドが無効 (
MethodDisabled
)、エラーを返す - 413 - リクエストエンティティが大きすぎます。エラーを返します。
- 415 - JSONエラー (
JsonError
)。エラーを返します。
-
DELETE
- HTTP keyvalゾーンを空にするHTTP keyval共有メモリゾーンからすべてのキーバリューペアを削除します。クラスタ内のkeyvalゾーンの同期が有効になっている場合、ターゲットクラスタノードでのみkeyvalゾーンを空にします。
可能な応答
-
/stream/
-
サポートされているメソッド
-
GET
- ストリーム関連エンドポイントのリストを返す最上位レベルのストリームエンドポイントのリストを返します。
可能な応答
- 200 - 成功、文字列の配列を返す
- 404 - 不明なバージョン (
UnknownVersion
)、エラーを返す
-
-
/stream/server_zones/
-
サポートされているメソッド
-
GET
- すべてのストリームサーバーゾーンのステータスを返す各ストリームサーバーゾーンのステータス情報を返します。
リクエストパラメータ
fields
(string
、オプション)- サーバーゾーンのどのフィールドを出力するかを制限します。「
fields
」値が空の場合、サーバーゾーン名のみが出力されます。
可能な応答
- 200 - 成功、すべてのストリームサーバーゾーンの"ストリームサーバーゾーン"オブジェクトのコレクションを返します。
- 404 - 不明なバージョン (
UnknownVersion
)、エラーを返す
-
-
/stream/server_zones/{streamServerZoneName}
- すべてのメソッドで共通のパラメータ
streamServerZoneName
(string
、必須)- ストリームサーバーゾーンの名前。
サポートされているメソッド
-
GET
- ストリームサーバーゾーンのステータスを返す特定のストリームサーバーゾーンのステータスを返します。
リクエストパラメータ
fields
(string
、オプション)- サーバーゾーンのどのフィールドを出力するかを制限します。
可能な応答
- 200 - 成功、ストリームサーバーゾーンを返します。
- 404 - サーバーゾーンが見つからない (
ServerZoneNotFound
)、不明なバージョン (UnknownVersion
)、エラーを返す
-
DELETE
- ストリームサーバーゾーンの統計情報をリセットする特定のストリームサーバーゾーンで、受け入れられた接続と破棄された接続、セッション、送受信バイト数、SSLハンドシェイクとセッション再利用のカウンターの統計情報をリセットします。
可能な応答
-
/stream/limit_conns/
-
サポートされているメソッド
-
GET
- すべてのストリームlimit_connゾーンのステータスを返す各ストリームlimit_connゾーンのステータス情報を返します。
リクエストパラメータ
fields
(string
、オプション)- limit_connゾーンの出力するフィールドを制限します。「
fields
」値が空の場合、ゾーン名のみが出力されます。
可能な応答
-
-
/stream/limit_conns/{streamLimitConnZoneName}
- すべてのメソッドで共通のパラメータ
streamLimitConnZoneName
(string
、必須)- limit_connゾーンの名前。
サポートされているメソッド
-
GET
- ストリームlimit_connゾーンのステータスを返す特定のストリームlimit_connゾーンのステータスを返します。
リクエストパラメータ
fields
(string
、オプション)- limit_connゾーンの出力されるフィールドを制限します。
可能な応答
-
DELETE
- ストリームlimit_connゾーンの統計情報をリセットする接続制限統計をリセットします。
可能な応答
-
/stream/upstreams/
-
サポートされているメソッド
-
GET
- すべてのストリームアップストリームサーバーグループのステータスを返す各ストリームアップストリームサーバーグループとそのサーバーのステータスを返します。
リクエストパラメータ
fields
(string
、オプション)- アップストリームサーバーグループの出力するフィールドを制限します。「
fields
」値が空の場合、アップストリームの名前のみが出力されます。
可能な応答
- 200 - 成功、すべてのストリームアップストリームの"ストリームアップストリーム"オブジェクトのコレクションを返します。
- 404 - 不明なバージョン (
UnknownVersion
)、エラーを返す
-
-
/stream/upstreams/{streamUpstreamName}/
- すべてのメソッドで共通のパラメータ
streamUpstreamName
(string
、必須)- ストリームアップストリームサーバーグループの名前。
サポートされているメソッド
-
GET
- ストリームアップストリームサーバーグループのステータスを返す特定のストリームアップストリームサーバーグループとそのサーバーのステータスを返します。
リクエストパラメータ
fields
(string
、オプション)- アップストリームサーバーグループの出力するフィールドを制限します。
可能な応答
- 200 - 成功、ストリームアップストリームを返します。
- 400 - アップストリームは静的です (
UpstreamStatic
)。エラーを返します。 - 404 - 不明なバージョン (
UnknownVersion
)、アップストリームが見つかりません (UpstreamNotFound
)。エラーを返します。
-
DELETE
- ストリームアップストリームサーバーグループの統計情報をリセットするアップストリームサーバーグループ内の各アップストリームサーバーの統計情報をリセットします。
可能な応答
-
/stream/upstreams/{streamUpstreamName}/servers/
- すべてのメソッドで共通のパラメータ
streamUpstreamName
(string
、必須)- アップストリームサーバーグループの名前。
サポートされているメソッド
-
GET
- ストリームアップストリームサーバーグループ内のすべてのサーバーの構成を返す特定のストリームアップストリームサーバーグループ内の各サーバーの構成を返します。
可能な応答
- 200 - 成功、ストリームアップストリームサーバーの配列を返します。
- 400 - アップストリームは静的です (
UpstreamStatic
)。エラーを返します。 - 404 - 不明なバージョン (
UnknownVersion
)、アップストリームが見つかりません (UpstreamNotFound
)。エラーを返します。
-
POST
- ストリームアップストリームサーバーグループにサーバーを追加するストリームアップストリームサーバーグループに新しいサーバーを追加します。サーバーパラメータはJSON形式で指定します。
リクエストパラメータ
postStreamUpstreamServer
(ストリームアップストリームサーバー、必須)- 新しいサーバーのアドレスとその他のオプションパラメーターをJSON形式で指定します。「
ID
」、「backup
」、および「service
」パラメーターは変更できません。
可能な応答
- 201 - 作成済み、ストリームアップストリームサーバーを返します。
- 400 - アップストリームは静的(
UpstreamStatic
)、無効な“パラメータ
”値(UpstreamConfFormatError
)、"server"引数が不足(UpstreamConfFormatError
)、不明なパラメータ“name
”(UpstreamConfFormatError
)、ネストされたオブジェクトまたはリスト(UpstreamConfFormatError
)、解析中の“error
”(UpstreamBadAddress
)、サーバー“host
”にポートがない(UpstreamBadAddress
)、サービスアップストリーム“host
”にポートがあってはならない(UpstreamBadAddress
)、サービスアップストリーム“host
”にはドメイン名が必要(UpstreamBadAddress
)、無効な“weight
”(UpstreamBadWeight
)、無効な“max_conns
”(UpstreamBadMaxConns
)、無効な“max_fails
”(UpstreamBadMaxFails
)、無効な“fail_timeout
”(UpstreamBadFailTimeout
)、無効な“slow_start
”(UpstreamBadSlowStart
)、“service
”が空(UpstreamBadService
)、解決するためのリゾルバーが定義されていない(UpstreamConfNoResolver
)、アップストリーム“name
”にバックアップがない(UpstreamNoBackup
)、アップストリーム“name
”のメモリが不足(UpstreamOutOfMemory
)、リクエストボディの読み込みに失敗(BodyReadError
)、エラーを返します。 - 404 - 不明なバージョン (
UnknownVersion
)、アップストリームが見つかりません (UpstreamNotFound
)。エラーを返します。 - 405 - メソッドが無効 (
MethodDisabled
)、エラーを返す - 409 - エントリが存在します (
EntryExists
)。エラーを返します。 - 415 - JSONエラー (
JsonError
)。エラーを返します。
-
/stream/upstreams/{streamUpstreamName}/servers/{streamUpstreamServerId}
- すべてのメソッドで共通のパラメータ
streamUpstreamName
(string
、必須)- アップストリームサーバーグループの名前。
streamUpstreamServerId
(string
、必須)- サーバーのID。
サポートされているメソッド
-
GET
- ストリームアップストリームサーバーグループ内のサーバーの構成を返すストリームアップストリームサーバーグループ内の特定のサーバーの構成を返します。
可能な応答
- 200 - 成功、ストリームアップストリームサーバーを返します。
- 400 - アップストリームは静的です (
UpstreamStatic
)、無効なサーバーID (UpstreamBadServerId
)。エラーを返します。 - 404 - 不明なバージョン(
UnknownVersion
)、アップストリームが見つからない(UpstreamNotFound
)、ID“id
”のサーバーが存在しない(UpstreamServerNotFound
)、エラーを返します。
-
PATCH
- ストリームアップストリームサーバーグループ内のサーバーを変更するストリームアップストリームサーバーグループ内の特定のサーバーの設定を変更します。サーバーパラメータはJSON形式で指定します。
リクエストパラメータ
patchStreamUpstreamServer
(ストリームアップストリームサーバー、必須)- JSON形式で指定されたサーバーパラメーター。「
ID
」、「backup
」、および「service
」パラメーターは変更できません。
可能な応答
- 200 - 成功、ストリームアップストリームサーバーを返します。
- 400 - アップストリームは静的(
UpstreamStatic
)、無効な“パラメータ
”値(UpstreamConfFormatError
)、不明なパラメータ“name
”(UpstreamConfFormatError
)、ネストされたオブジェクトまたはリスト(UpstreamConfFormatError
)、解析中の“error
”(UpstreamBadAddress
)、無効な"server"引数(UpstreamBadAddress
)、サーバー“host
”にポートがない(UpstreamBadAddress
)、無効なサーバーID(UpstreamBadServerId
)、無効な“weight
”(UpstreamBadWeight
)、無効な“max_conns
”(UpstreamBadMaxConns
)、無効な“max_fails
”(UpstreamBadMaxFails
)、無効な“fail_timeout
”(UpstreamBadFailTimeout
)、無効な“slow_start
”(UpstreamBadSlowStart
)、リクエストボディの読み込みに失敗(BodyReadError
)、“service
”が空(UpstreamBadService
)、サーバー“ID
”のアドレスは変更できない(UpstreamServerImmutable
)、サーバー“ID
”のweightは変更できない(UpstreamServerWeightImmutable
)、アップストリーム“name
”のメモリが不足(UpstreamOutOfMemory
)、エラーを返します。 - 404 - ID「
id
」のサーバーが存在しません (UpstreamServerNotFound
)、不明なバージョン (UnknownVersion
)、アップストリームが見つかりません (UpstreamNotFound
)。エラーを返します。 - 405 - メソッドが無効 (
MethodDisabled
)、エラーを返す - 415 - JSONエラー (
JsonError
)。エラーを返します。
-
DELETE
- ストリームアップストリームサーバーグループからサーバーを削除するストリームサーバーグループからサーバーを削除します。
可能な応答
- 200 - 成功、ストリームアップストリームサーバーの配列を返します。
- 400 - アップストリームは静的です (
UpstreamStatic
)、無効なサーバーID (UpstreamBadServerId
)、サーバー「id
」は削除できません (UpstreamServerImmutable
)。エラーを返します。 - 404 - ID「
id
」のサーバーが存在しません (UpstreamServerNotFound
)、不明なバージョン (UnknownVersion
)、アップストリームが見つかりません (UpstreamNotFound
)。エラーを返します。 - 405 - メソッドが無効 (
MethodDisabled
)、エラーを返す
-
/stream/keyvals/
-
サポートされているメソッド
-
GET
- すべてのストリームkeyvalゾーンからキーバリューペアを返す各ストリームkeyval共有メモリゾーンのキーバリューペアを返します。
リクエストパラメータ
fields
(string
、オプション)- “
fields
”の値が空の場合、ストリームkeyvalゾーン名のみが出力されます。
可能な応答
- 200 - 成功、すべてのストリームkeyvalの"ストリームKeyval共有メモリゾーン"オブジェクトのコレクションを返します。
- 404 - 不明なバージョン (
UnknownVersion
)、エラーを返す
-
-
/stream/keyvals/{streamKeyvalZoneName}
- すべてのメソッドで共通のパラメータ
streamKeyvalZoneName
(string
、必須)- ストリームkeyval共有メモリゾーンの名前。
サポートされているメソッド
-
GET
- ストリームkeyvalゾーンからキーバリューペアを返す特定のストリームkeyval共有メモリゾーンに格納されているキーバリューペアを返します。
リクエストパラメータ
key
(string
, オプション)- ストリームkeyvalゾーンから特定のキーバリューペアを取得します。
可能な応答
- 200 - 成功、ストリームKeyval共有メモリゾーンを返します。
- 404 - Keyvalが見つかりません (
KeyvalNotFound
)、keyvalキーが見つかりません (KeyvalKeyNotFound
)、不明なバージョン (UnknownVersion
)。エラーを返します。
-
POST
- ストリームkeyvalゾーンにキーバリューペアを追加するストリームkeyval共有メモリゾーンに新しいキーバリューペアを追加します。ストリームkeyval共有メモリゾーンが空の場合、複数のキーバリューペアを入力できます。
リクエストパラメータ
Key-value
(ストリームKeyval共有メモリゾーン、必須)- キーバリューペアはJSON形式で指定します。ストリームkeyval共有メモリゾーンが空の場合、複数のキーバリューペアを入力できます。ミリ秒単位の有効期限は、
expire
パラメータでキーバリューペアに指定でき、timeout
パラメータをkeyval_zoneディレクティブで上書きします。
可能な応答
- 201 - 作成済み
- 400 - 無効なJSON (
KeyvalFormatError
)、無効なキー形式 (KeyvalFormatError
)、キーが必要です (KeyvalFormatError
)、keyvalタイムアウトが無効です (KeyvalFormatError
)、追加できるキーは1つだけです (KeyvalFormatError
)、リクエストボディの読み込みに失敗しました (BodyReadError
)。エラーを返します。 - 404 - Keyvalが見つかりません (
KeyvalNotFound
)、不明なバージョン (UnknownVersion
)。エラーを返します。 - 405 - メソッドが無効 (
MethodDisabled
)、エラーを返す - 409 - エントリが存在します (
EntryExists
)、キーは既に存在します (KeyvalKeyExists
)。エラーを返します。 - 413 - リクエストエンティティが大きすぎます。エラーを返します。
- 415 - JSONエラー (
JsonError
)。エラーを返します。
-
PATCH
- キーバリューの変更またはキーの削除キーバリューペアの選択されたキーの値を変更します。キーの値を
null
に設定することでキーを削除し、キーバリューペアの有効期限を変更します。クラスタ内のkeyvalゾーンの同期が有効になっている場合、ターゲットクラスタノードでのみキーを削除します。有効期限は、expire
パラメータでミリ秒単位で指定し、timeout
パラメータをkeyval_zoneディレクティブで上書きします。リクエストパラメータ
streamKeyvalZoneKeyValue
(ストリームKeyval共有メモリゾーン、必須)- キーの新しい値はJSON形式で指定します。
可能な応答
- 204 - 成功
- 400 - 無効なJSON(
KeyvalFormatError
)、キーが必要(KeyvalFormatError
)、keyvalタイムアウトが無効(KeyvalFormatError
)、更新できるキーは1つのみ(KeyvalFormatError
)、リクエストボディの読み込みに失敗(BodyReadError
)、エラーを返します。 - 404 - Keyvalが見つかりません (
KeyvalNotFound
)、keyvalキーが見つかりません (KeyvalKeyNotFound
)、不明なバージョン (UnknownVersion
)。エラーを返します。 - 405 - メソッドが無効 (
MethodDisabled
)、エラーを返す - 413 - リクエストエンティティが大きすぎます。エラーを返します。
- 415 - JSONエラー (
JsonError
)。エラーを返します。
-
DELETE
- ストリームkeyvalゾーンを空にするストリームkeyval共有メモリゾーンからすべてのキーバリューペアを削除します。クラスタ内のkeyvalゾーンの同期が有効になっている場合、ターゲットクラスタノードでのみkeyvalゾーンを空にします。
可能な応答
-
/stream/zone_sync/
-
サポートされているメソッド
-
GET
- ノードの同期ステータスを返すクラスタノードの同期ステータスを返します。
可能な応答
- 200 - 成功、ストリームゾーン同期ノードを返します。
- 404 - 不明なバージョン (
UnknownVersion
)、エラーを返す
-
-
/resolvers/
-
サポートされているメソッド
-
/resolvers/{resolverZoneName}
- すべてのメソッドで共通のパラメータ
resolverZoneName
(string
、必須)- リゾルバゾーンの名前。
サポートされているメソッド
-
GET
- リゾルバゾーンの統計情報を返す特定のリゾルバゾーンに保存されている統計情報を返します。
リクエストパラメータ
fields
(string
、オプション)- リゾルバゾーンの出力するフィールド(リクエスト、レスポンス、または両方)を制限します。
可能な応答
-
DELETE
- リゾルバゾーンの統計情報をリセットします。特定のリゾルバゾーンの統計情報をリセットします。
可能な応答
-
/ssl
-
サポートされているメソッド
-
GET
- SSL統計情報を返すSSL統計情報を返します。
リクエストパラメータ
fields
(string
、オプション)- 出力するSSL統計情報のフィールドを制限します。
可能な応答
-
DELETE
- SSL統計情報をリセットします。SSLハンドシェイクとセッション再利用のカウンタをリセットします。
可能な応答
-
-
/license
-
サポートされているメソッド
-
/workers/
-
サポートされているメソッド
-
GET
- 全ワーカープロセスの統計情報を返すアクセプトされた接続数、ドロップされた接続数、アクティブな接続数、アイドル状態の接続数、合計リクエスト数、現在のリクエスト数など、全ワーカープロセスの統計情報を返します。
リクエストパラメータ
fields
(string
、オプション)- ワーカープロセスの統計情報の出力フィールドを制限します。
可能な応答
-
DELETE
- 全ワーカープロセスの統計情報をリセットします。アクセプトされた接続数、ドロップされた接続数、アクティブな接続数、アイドル状態の接続数、合計リクエスト数、現在のリクエスト数など、全ワーカープロセスの統計情報をリセットします。
可能な応答
-
-
/workers/{workerId}
- すべてのメソッドで共通のパラメータ
workerId
(string
、必須)- ワーカープロセスのID。
サポートされているメソッド
-
GET
- ワーカープロセスの状態を返す特定のワーカープロセスの状態を返します。
リクエストパラメータ
fields
(string
、オプション)- ワーカープロセスの統計情報の出力フィールドを制限します。
可能な応答
-
DELETE
- ワーカープロセスの統計情報をリセットします。アクセプトされた接続数、ドロップされた接続数、アクティブな接続数、アイドル状態の接続数、合計リクエスト数、現在のリクエスト数をリセットします。
可能な応答
レスポンスオブジェクト
-
nginx
nginxに関する一般情報-
version
(string
) - nginxのバージョン。
-
build
(string
) - nginxビルドの名前。
-
address
(string
) - ステータスリクエストを受け付けたサーバのアドレス。
-
generation
(integer
) - 設定の再読み込みの総数。再設定
-
load_timestamp
(string
) - 最後の設定の再読み込み時刻(ミリ秒単位のISO 8601形式)。
-
timestamp
(string
) - 現在の時刻(ミリ秒単位のISO 8601形式)。
-
pid
(integer
) - ステータスリクエストを処理したワーカープロセスのID。
-
ppid
(integer
) - ワーカープロセスを開始したマスタープロセスのID。
例
{ "nginx" : { "version" : "1.21.6", "build" : "nginx-plus-r27", "address" : "206.251.255.64", "generation" : 6, "load_timestamp" : "2022-06-28T11:15:44.467Z", "timestamp" : "2022-06-28T09:26:07.305Z", "pid" : 32212, "ppid" : 32210 } }
-
-
プロセス
-
respawned
(integer
) - 異常終了して再起動された子プロセスの総数。
例
{ "respawned" : 0 }
-
-
接続
アクセプトされた接続数、ドロップされた接続数、アクティブな接続数、アイドル状態の接続数。-
accepted
(integer
) - アクセプトされたクライアント接続の総数。
-
dropped
(integer
) - ドロップされたクライアント接続の総数。
-
active
(integer
) - アクティブなクライアント接続の現在の数。
-
idle
(integer
) - アイドル状態のクライアント接続の現在の数。
例
{ "accepted" : 4968119, "dropped" : 0, "active" : 5, "idle" : 117 }
-
-
SSL
-
handshakes
(integer
) - 成功したSSLハンドシェイクの総数。
-
handshakes_failed
(integer
) - 失敗したSSLハンドシェイクの総数。
-
session_reuses
(integer
) - SSLハンドシェイク中のセッション再利用の総数。
-
no_common_protocol
(integer
) - 共通のプロトコルがないために失敗したSSLハンドシェイクの数。
-
no_common_cipher
(integer
) - 共通の暗号がないために失敗したSSLハンドシェイクの数。
-
handshake_timeout
(integer
) - タイムアウトのために失敗したSSLハンドシェイクの数。
-
peer_rejected_cert
(integer
) - nginxがクライアントに証明書を提示したが、対応する警告メッセージで拒否された場合のSSLハンドシェイク失敗の数。
-
verify_failures
- SSL証明書の検証エラー
-
no_cert
(integer
) - クライアントが必要な証明書を提供しなかった。
-
expired_cert
(integer
) - 期限切れまたはまだ有効でない証明書がクライアントによって提示された。
-
revoked_cert
(integer
) - 失効した証明書がクライアントによって提示された。
-
hostname_mismatch
(integer
) - サーバの証明書がホスト名と一致しない。
-
other
(integer
) - その他のSSL証明書の検証エラー。
-
例
{ "handshakes" : 79572, "handshakes_failed" : 21025, "session_reuses" : 15762, "no_common_protocol" : 4, "no_common_cipher" : 2, "handshake_timeout" : 0, "peer_rejected_cert" : 0, "verify_failures" : { "no_cert" : 0, "expired_cert" : 2, "revoked_cert" : 1, "hostname_mismatch" : 2, "other" : 1 } }
-
-
スラブアロケータを使用した共有メモリゾーン
スラブアロケータを使用した共有メモリゾーン-
pages
- 空きメモリページ数と使用済みメモリページ数。
-
used
(integer
) - 現在使用されているメモリページ数。
-
free
(integer
) - 現在の空きメモリページ数。
-
-
slots
-
メモリのスロット(8、16、32、64、128など)のステータスデータ。
"メモリスロット"オブジェクトのコレクション
例
{ "pages" : { "used" : 1143, "free" : 2928 }, "slots" : { "8" : { "used" : 0, "free" : 0, "reqs" : 0, "fails" : 0 }, "16" : { "used" : 0, "free" : 0, "reqs" : 0, "fails" : 0 }, "32" : { "used" : 0, "free" : 0, "reqs" : 0, "fails" : 0 }, "64" : { "used" : 1, "free" : 63, "reqs" : 1, "fails" : 0 }, "128" : { "used" : 0, "free" : 0, "reqs" : 0, "fails" : 0 }, "256" : { "used" : 18078, "free" : 178, "reqs" : 1635736, "fails" : 0 } } }
-
-
メモリスロット
-
used
(integer
) - 現在使用されているメモリスロット数。
-
free
(integer
) - 現在の空きメモリスロット数。
-
reqs
(integer
) - 指定されたサイズのメモリを割り当てようとした回数の合計。
-
fails
(integer
) - 指定されたサイズのメモリ割り当てに失敗した回数。
-
-
HTTPリクエスト
-
total
(integer
) - クライアントリクエストの総数。
-
current
(integer
) - クライアントリクエストの現在数。
例
{ "total" : 10624511, "current" : 4 }
-
-
HTTPサーバゾーン
-
processing
(integer
) - 現在処理中のクライアントリクエスト数。
-
requests
(integer
) - クライアントから受信したクライアントリクエストの総数。
-
responses
- クライアントに送信されたレスポンスの総数、ステータスコード「
1xx
」、「2xx
」、「3xx
」、「4xx
」、「5xx
」のレスポンス数、および各ステータスコードごとのレスポンス数。-
1xx
(integer
) - 「
1xx
」ステータスコードのレスポンス数。 -
2xx
(integer
) - 「
2xx
」ステータスコードのレスポンス数。 -
3xx
(integer
) - 「
3xx
」ステータスコードのレスポンス数。 -
4xx
(integer
) - 「
4xx
」ステータスコードのレスポンス数。 -
5xx
(integer
) - 「
5xx
」ステータスコードのレスポンス数。 -
codes
- 各ステータスコードごとのレスポンス数。
-
codeNumber
(integer
) - この特定のステータスコードのレスポンス数。
-
-
total
(integer
) - クライアントに送信されたレスポンスの総数。
-
-
discarded
(integer
) - レスポンスを送信せずに完了したリクエストの総数。
-
received
(integer
) - クライアントから受信したバイト数の合計。
-
sent
(integer
) - クライアントに送信されたバイト数の合計。
-
ssl
-
-
handshakes
(integer
) - 成功したSSLハンドシェイクの総数。
-
handshakes_failed
(integer
) - 失敗したSSLハンドシェイクの総数。
-
session_reuses
(integer
) - SSLハンドシェイク中のセッション再利用の総数。
-
no_common_protocol
(integer
) - 共通のプロトコルがないために失敗したSSLハンドシェイクの数。
-
no_common_cipher
(integer
) - 共通の暗号がないために失敗したSSLハンドシェイクの数。
-
handshake_timeout
(integer
) - タイムアウトのために失敗したSSLハンドシェイクの数。
-
peer_rejected_cert
(integer
) - nginxがクライアントに証明書を提示したが、対応する警告メッセージで拒否された場合のSSLハンドシェイク失敗の数。
-
verify_failures
- SSL証明書の検証エラー
-
no_cert
(integer
) - クライアントが必要な証明書を提供しなかった。
-
expired_cert
(integer
) - 期限切れまたはまだ有効でない証明書がクライアントによって提示された。
-
revoked_cert
(integer
) - 失効した証明書がクライアントによって提示された。
-
other
(integer
) - その他のSSL証明書の検証エラー。
-
-
例
{ "processing" : 1, "requests" : 706690, "responses" : { "1xx" : 0, "2xx" : 699482, "3xx" : 4522, "4xx" : 907, "5xx" : 266, "codes" : { "200" : 699482, "301" : 4522, "404" : 907, "503" : 266 }, "total" : 705177 }, "discarded" : 1513, "received" : 172711587, "sent" : 19415530115, "ssl" : { "handshakes" : 104303, "handshakes_failed" : 1421, "session_reuses" : 54645, "no_common_protocol" : 4, "no_common_cipher" : 2, "handshake_timeout" : 0, "peer_rejected_cert" : 0, "verify_failures" : { "no_cert" : 0, "expired_cert" : 2, "revoked_cert" : 1, "other" : 1 } } }
-
-
HTTPロケーションゾーン
-
requests
(integer
) - クライアントから受信したクライアントリクエストの総数。
-
responses
- クライアントに送信されたレスポンスの総数、ステータスコード「
1xx
」、「2xx
」、「3xx
」、「4xx
」、「5xx
」のレスポンス数、および各ステータスコードごとのレスポンス数。-
1xx
(integer
) - 「
1xx
」ステータスコードのレスポンス数。 -
2xx
(integer
) - 「
2xx
」ステータスコードのレスポンス数。 -
3xx
(integer
) - 「
3xx
」ステータスコードのレスポンス数。 -
4xx
(integer
) - 「
4xx
」ステータスコードのレスポンス数。 -
5xx
(integer
) - 「
5xx
」ステータスコードのレスポンス数。 -
codes
- 各ステータスコードごとのレスポンス数。
-
codeNumber
(integer
) - この特定のステータスコードのレスポンス数。
-
-
total
(integer
) - クライアントに送信されたレスポンスの総数。
-
-
discarded
(integer
) - レスポンスを送信せずに完了したリクエストの総数。
-
received
(integer
) - クライアントから受信したバイト数の合計。
-
sent
(integer
) - クライアントに送信されたバイト数の合計。
例
{ "requests" : 706690, "responses" : { "1xx" : 0, "2xx" : 699482, "3xx" : 4522, "4xx" : 907, "5xx" : 266, "codes" : { "200" : 112674, "301" : 4522, "404" : 2504, "503" : 266 }, "total" : 705177 }, "discarded" : 1513, "received" : 172711587, "sent" : 19415530115 }
-
-
HTTPキャッシュ
-
size
(integer
) - キャッシュの現在のサイズ。
-
max_size
(integer
) - 設定で指定されたキャッシュの最大サイズの制限。
-
cold
(boolean
) - 「キャッシュローダー」プロセスがまだディスクからキャッシュにデータを読み込んでいるかどうかを示すブール値。
-
hit
-
-
responses
(integer
) - キャッシュから読み取られた有効なレスポンスの総数。有効
-
bytes
(integer
) - キャッシュから読み取られたバイト数の合計。
-
-
stale
-
-
responses
(integer
) - キャッシュから読み取られた期限切れのレスポンスの総数(proxy_cache_use_staleおよびその他の「
*_cache_use_stale
」ディレクティブを参照)。 -
bytes
(integer
) - キャッシュから読み取られたバイト数の合計。
-
-
updating
-
-
responses
(integer
) - レスポンスの更新中にキャッシュから読み取られた期限切れのレスポンスの総数(proxy_cache_use_staleおよびその他の「
*_cache_use_stale
」ディレクティブを参照)。 -
bytes
(integer
) - キャッシュから読み取られたバイト数の合計。
-
-
revalidated
-
-
responses
(integer
) - 期限切れで再検証されたレスポンスの総数(proxy_cache_revalidateおよびその他の「
*_cache_revalidate
」ディレクティブを参照)。 -
bytes
(integer
) - キャッシュから読み取られたバイト数の合計。
-
-
miss
-
-
responses
(integer
) - キャッシュに見つからなかったレスポンスの総数。
-
bytes
(integer
) - プロキシされたサーバから読み取られたバイト数の合計。
-
responses_written
(integer
) - キャッシュに書き込まれたレスポンスの総数。
-
bytes_written
(integer
) - キャッシュに書き込まれたバイト数の合計。
-
-
expired
-
-
responses
(integer
) - キャッシュから取得されなかった期限切れのレスポンスの総数。
-
bytes
(integer
) - プロキシされたサーバから読み取られたバイト数の合計。
-
responses_written
(integer
) - キャッシュに書き込まれたレスポンスの総数。
-
bytes_written
(integer
) - キャッシュに書き込まれたバイト数の合計。
-
-
bypass
-
-
responses
(integer
) - proxy_cache_bypassおよびその他の「
*_cache_bypass
」ディレクティブにより、キャッシュでルックアップされなかったレスポンスの総数。 -
bytes
(integer
) - プロキシされたサーバから読み取られたバイト数の合計。
-
responses_written
(integer
) - キャッシュに書き込まれたレスポンスの総数。
-
bytes_written
(integer
) - キャッシュに書き込まれたバイト数の合計。
-
例
{ "size" : 530915328, "max_size" : 536870912, "cold" : false, "hit" : { "responses" : 254032, "bytes" : 6685627875 }, "stale" : { "responses" : 0, "bytes" : 0 }, "updating" : { "responses" : 0, "bytes" : 0 }, "revalidated" : { "responses" : 0, "bytes" : 0 }, "miss" : { "responses" : 1619201, "bytes" : 53841943822 }, "expired" : { "responses" : 45859, "bytes" : 1656847080, "responses_written" : 44992, "bytes_written" : 1641825173 }, "bypass" : { "responses" : 200187, "bytes" : 5510647548, "responses_written" : 200173, "bytes_written" : 44992 } }
-
-
HTTP接続制限
-
passed
(integer
) - 制限されず、制限済みとしてカウントされなかった接続の総数。
-
rejected
(integer
) - 拒否された接続の総数。
-
rejected_dry_run
(integer
) - ドライランモードで拒否済みとしてカウントされた接続の総数。
例
{ "passed" : 15, "rejected" : 0, "rejected_dry_run" : 2 }
-
-
HTTPリクエストレート制限
-
passed
(integer
) - 制限されず、制限済みとしてカウントされなかったリクエストの総数。
-
delayed
(integer
) - 遅延されたリクエストの総数。
-
rejected
(integer
) - 拒否されたリクエストの総数。
-
delayed_dry_run
(integer
) - ドライランモードで遅延済みとしてカウントされたリクエストの総数。
-
rejected_dry_run
(integer
) - ドライランモードで拒否済みとしてカウントされたリクエストの総数。
例
{ "passed" : 15, "delayed" : 4, "rejected" : 0, "delayed_dry_run" : 1, "rejected_dry_run" : 2 }
-
-
HTTPアップストリーム
-
peers
- の配列
-
id
(integer
) - サーバーのID。
-
server
(string
) - サーバのアドレス。
-
service
(string
) - service パラメータは、server ディレクティブで指定されます。
-
name
(string
) - server ディレクティブで指定されたサーバーの名前です。
-
backup
(boolean
) - サーバーがバックアップサーバーであるかどうかを示すブール値です。
-
weight
(integer
) - サーバーのウェイトです。
-
state
(string
) - 現在の状態です。「
up
」、「draining
」、「down
」、「unavail
」、「checking
」、「unhealthy
」のいずれかになります。 -
active
(integer
) - アクティブな接続の現在の数です。
-
ssl
-
-
handshakes
(integer
) - 成功したSSLハンドシェイクの総数。
-
handshakes_failed
(integer
) - 失敗したSSLハンドシェイクの総数。
-
session_reuses
(integer
) - SSLハンドシェイク中のセッション再利用の総数。
-
no_common_protocol
(integer
) - 共通のプロトコルがないために失敗したSSLハンドシェイクの数。
-
handshake_timeout
(integer
) - タイムアウトのために失敗したSSLハンドシェイクの数。
-
peer_rejected_cert
(integer
) - Nginxが証明書をアップストリームサーバーに提示しましたが、対応する警告メッセージで拒否された場合のSSLハンドシェイクの失敗数です。
-
verify_failures
- SSL証明書の検証エラー
-
expired_cert
(integer
) - アップストリームサーバーから期限切れの、またはまだ有効でない証明書が提示されました。
-
revoked_cert
(integer
) - アップストリームサーバーから失効した証明書が提示されました。
-
hostname_mismatch
(integer
) - サーバの証明書がホスト名と一致しない。
-
other
(integer
) - その他のSSL証明書の検証エラー。
-
-
-
max_conns
(integer
) - サーバーのmax_conns制限です。
-
requests
(integer
) - このサーバーに転送されたクライアントリクエストの総数です。
-
responses
-
-
1xx
(integer
) - 「
1xx
」ステータスコードのレスポンス数。 -
2xx
(integer
) - 「
2xx
」ステータスコードのレスポンス数。 -
3xx
(integer
) - 「
3xx
」ステータスコードのレスポンス数。 -
4xx
(integer
) - 「
4xx
」ステータスコードのレスポンス数。 -
5xx
(integer
) - 「
5xx
」ステータスコードのレスポンス数。 -
codes
- 各ステータスコードごとのレスポンス数。
-
codeNumber
(integer
) - この特定のステータスコードのレスポンス数。
-
-
total
(integer
) - このサーバーから取得されたレスポンスの総数です。
-
-
sent
(integer
) - このサーバーに送信されたバイトの総数です。
-
received
(integer
) - このサーバーから受信したバイトの総数です。
-
fails
(integer
) - サーバーとの通信を試みたものの失敗した回数の総数です。
-
unavail
(integer
) - 失敗した試行回数がmax_failsしきい値に達したために、クライアントリクエストに対してサーバーが利用できなくなった回数(状態「
unavail
」)です。 -
health_checks
-
downtime
(integer
) - サーバーが「
unavail
」、「checking
」、「unhealthy
」の状態にあった合計時間です。 -
downstart
(string
) - サーバーが「
unavail
」、「checking
」、「unhealthy
」になった時間です。ミリ秒単位のISO 8601形式です。 -
selected
(string
) - 最後にリクエストの処理のためにサーバーが選択された時間です。ミリ秒単位のISO 8601形式です。
-
header_time
(integer
) - サーバーからレスポンスヘッダーを取得する平均時間です。
-
response_time
(integer
) - サーバーから完全なレスポンスを取得する平均時間です。
-
-
keepalive
(integer
) - アイドル状態のキープアライブ接続の現在の数です。
-
zombies
(integer
) - グループから削除されたものの、アクティブなクライアントリクエストをまだ処理しているサーバーの現在の数です。
-
zone
(string
) - グループの設定とランタイムの状態を保持する共有メモリゾーンの名前です。
-
queue
- リクエストキューについては、以下のデータが提供されます。
-
size
(integer
) - キュー内のリクエストの現在の数です。
-
max_size
(integer
) - 同時にキューに存在できるリクエストの最大数です。
-
overflows
(integer
) - キューオーバーフローのため拒否されたリクエストの総数です。
-
例
{ "upstream_backend" : { "peers" : [ { "id" : 0, "server" : "10.0.0.1:8088", "name" : "10.0.0.1:8088", "backup" : false, "weight" : 5, "state" : "up", "active" : 0, "ssl" : { "handshakes" : 620311, "handshakes_failed" : 3432, "session_reuses" : 36442, "no_common_protocol" : 4, "handshake_timeout" : 0, "peer_rejected_cert" : 0, "verify_failures" : { "expired_cert" : 2, "revoked_cert" : 1, "hostname_mismatch" : 2, "other" : 1 } }, "max_conns" : 20, "requests" : 667231, "header_time" : 20, "response_time" : 36, "responses" : { "1xx" : 0, "2xx" : 666310, "3xx" : 0, "4xx" : 915, "5xx" : 6, "codes" : { "200" : 666310, "404" : 915, "503" : 6 }, "total" : 667231 }, "sent" : 251946292, "received" : 19222475454, "fails" : 0, "unavail" : 0, "health_checks" : { "checks" : 26214, "fails" : 0, "unhealthy" : 0, "last_passed" : true }, "downtime" : 0, "downstart" : "2022-06-28T11:09:21.602Z", "selected" : "2022-06-28T15:01:25.000Z" }, { "id" : 1, "server" : "10.0.0.1:8089", "name" : "10.0.0.1:8089", "backup" : true, "weight" : 1, "state" : "unhealthy", "active" : 0, "max_conns" : 20, "requests" : 0, "responses" : { "1xx" : 0, "2xx" : 0, "3xx" : 0, "4xx" : 0, "5xx" : 0, "codes" : { }, "total" : 0 }, "sent" : 0, "received" : 0, "fails" : 0, "unavail" : 0, "health_checks" : { "checks" : 26284, "fails" : 26284, "unhealthy" : 1, "last_passed" : false }, "downtime" : 262925617, "downstart" : "2022-06-28T11:09:21.602Z", "selected" : "2022-06-28T15:01:25.000Z" } ], "keepalive" : 0, "zombies" : 0, "zone" : "upstream_backend" } }
-
-
HTTP アップストリームサーバー
HTTP アップストリームサーバーの動的に構成可能なパラメータです。-
id
(integer
) - HTTP アップストリームサーバーのIDです。IDは自動的に割り当てられ、変更できません。
-
server
(string
) - HTTP アップストリームサーバーのaddressパラメータと同じです。サーバーを追加する際に、ドメイン名として指定できます。この場合、ドメイン名に対応するIPアドレスの変更が監視され、Nginxを再起動することなくアップストリーム設定に自動的に適用されます。これには、「
http
」ブロック内のresolverディレクティブが必要です。HTTP アップストリームサーバーのresolveパラメータも参照してください。 -
service
(string
) - HTTP アップストリームサーバーのserviceパラメータと同じです。このパラメータは変更できません。
-
weight
(integer
) - HTTP アップストリームサーバーのweightパラメータと同じです。
-
max_conns
(integer
) - HTTP アップストリームサーバーのmax_connsパラメータと同じです。
-
max_fails
(integer
) - HTTP アップストリームサーバーのmax_failsパラメータと同じです。
-
fail_timeout
(string
) - HTTP アップストリームサーバーのfail_timeoutパラメータと同じです。
-
slow_start
(string
) - HTTP アップストリームサーバーのslow_startパラメータと同じです。
-
route
(string
) - HTTP アップストリームサーバーのrouteパラメータと同じです。
-
backup
(boolean
) true
の場合、バックアップサーバーを追加します。このパラメータは変更できません。-
down
(boolean
) - HTTP アップストリームサーバーのdownパラメータと同じです。
-
drain
(boolean
) - HTTP アップストリームサーバーのdrainパラメータと同じです。
-
parent
(string
) - 解決済みサーバーの親サーバーIDです。IDは自動的に割り当てられ、変更できません。
-
host
(string
) - 解決済みサーバーのホスト名です。ホスト名は自動的に割り当てられ、変更できません。
例
{ "id" : 1, "server" : "10.0.0.1:8089", "weight" : 4, "max_conns" : 0, "max_fails" : 0, "fail_timeout" : "10s", "slow_start" : "10s", "route" : "", "backup" : true, "down" : true }
-
-
HTTP Keyval 共有メモリゾーン
GETメソッドを使用する場合のHTTP keyval共有メモリゾーンの内容です。例
{ "key1" : "value1", "key2" : "value2", "key3" : "value3" }
-
HTTP Keyval 共有メモリゾーン
POSTまたはPATCHメソッドを使用する場合のHTTP keyval共有メモリゾーンの内容です。例
{ "key1" : "value1", "key2" : "value2", "key3" : { "value" : "value3", "expire" : 30000 } }
-
ストリームサーバーゾーン
-
processing
(integer
) - 現在処理中のクライアント接続の数です。
-
connections
(integer
) - クライアントから受け入れた接続の総数です。
-
sessions
- 完了したセッションの総数、およびステータスコード「
2xx
」、「4xx
」、または「5xx
」で完了したセッションの数です。 -
discarded
(integer
) - セッションを作成せずに完了した接続の総数です。
-
received
(integer
) - クライアントから受信したバイト数の合計。
-
sent
(integer
) - クライアントに送信されたバイト数の合計。
-
ssl
-
-
handshakes
(integer
) - 成功したSSLハンドシェイクの総数。
-
handshakes_failed
(integer
) - 失敗したSSLハンドシェイクの総数。
-
session_reuses
(integer
) - SSLハンドシェイク中のセッション再利用の総数。
-
no_common_protocol
(integer
) - 共通のプロトコルがないために失敗したSSLハンドシェイクの数。
-
no_common_cipher
(integer
) - 共通の暗号がないために失敗したSSLハンドシェイクの数。
-
handshake_timeout
(integer
) - タイムアウトのために失敗したSSLハンドシェイクの数。
-
peer_rejected_cert
(integer
) - nginxがクライアントに証明書を提示したが、対応する警告メッセージで拒否された場合のSSLハンドシェイク失敗の数。
-
verify_failures
- SSL証明書の検証エラー
-
no_cert
(integer
) - クライアントが必要な証明書を提供しなかった。
-
expired_cert
(integer
) - 期限切れまたはまだ有効でない証明書がクライアントによって提示された。
-
revoked_cert
(integer
) - 失効した証明書がクライアントによって提示された。
-
other
(integer
) - その他のSSL証明書の検証エラー。
-
-
例
{ "dns" : { "processing" : 1, "connections" : 155569, "sessions" : { "2xx" : 155564, "4xx" : 0, "5xx" : 0, "total" : 155569 }, "discarded" : 0, "received" : 4200363, "sent" : 20489184, "ssl" : { "handshakes" : 76455, "handshakes_failed" : 432, "session_reuses" : 28770, "no_common_protocol" : 4, "no_common_cipher" : 2, "handshake_timeout" : 0, "peer_rejected_cert" : 0, "verify_failures" : { "no_cert" : 0, "expired_cert" : 2, "revoked_cert" : 1, "other" : 1 } } } }
-
-
ストリーム接続の制限
-
passed
(integer
) - 制限されず、制限済みとしてカウントされなかった接続の総数。
-
rejected
(integer
) - 拒否された接続の総数。
-
rejected_dry_run
(integer
) - ドライランモードで拒否されたとカウントされた接続の総数です。
例
{ "passed" : 15, "rejected" : 0, "rejected_dry_run" : 2 }
-
-
ストリームアップストリーム
-
peers
- の配列
-
id
(integer
) - サーバーのID。
-
server
(string
) - サーバーのアドレスです。
-
service
(string
) - serviceパラメータは、serverディレクティブで指定されます。
-
name
(string
) - serverディレクティブで指定されたサーバーの名前です。
-
backup
(boolean
) - サーバーがバックアップサーバーであるかどうかを示すブール値です。
-
weight
(integer
) - サーバーのウェイトです。
-
state
(string
) - 現在の状態です。「
up
」、「down
」、「unavail
」、「checking
」、「unhealthy
」のいずれかになります。 -
active
(integer
) - 現在の接続数です。
-
ssl
-
-
handshakes
(integer
) - 成功したSSLハンドシェイクの総数。
-
handshakes_failed
(integer
) - 失敗したSSLハンドシェイクの総数。
-
session_reuses
(integer
) - SSLハンドシェイク中のセッション再利用の総数。
-
no_common_protocol
(integer
) - 共通のプロトコルがないために失敗したSSLハンドシェイクの数。
-
handshake_timeout
(integer
) - タイムアウトのために失敗したSSLハンドシェイクの数。
-
peer_rejected_cert
(integer
) - Nginxが証明書をアップストリームサーバーに提示しましたが、対応する警告メッセージで拒否された場合のSSLハンドシェイクの失敗数です。
-
verify_failures
- SSL証明書の検証エラー
-
expired_cert
(integer
) - アップストリームサーバーから期限切れの、またはまだ有効でない証明書が提示されました。
-
revoked_cert
(integer
) - アップストリームサーバーから失効した証明書が提示されました。
-
hostname_mismatch
(integer
) - サーバの証明書がホスト名と一致しない。
-
other
(integer
) - その他のSSL証明書の検証エラー。
-
-
-
max_conns
(integer
) - サーバーのmax_conns制限です。
-
connections
(integer
) - このサーバーに転送されたクライアント接続の総数です。
-
connect_time
(integer
) - アップストリームサーバーへの接続の平均時間です。
-
first_byte_time
(integer
) - 最初のデータバイトを受信する平均時間です。
-
response_time
(integer
) - 最後のデータバイトを受信する平均時間です。
-
sent
(integer
) - このサーバーに送信されたバイトの総数です。
-
received
(integer
) - このサーバーから受信したバイトの総数です。
-
fails
(integer
) - サーバーとの通信を試みたものの失敗した回数の総数です。
-
unavail
(integer
) - 失敗した試行回数がmax_failsしきい値に達したために、クライアント接続に対してサーバーが利用できなくなった回数(状態「
unavail
」)です。 -
health_checks
-
downtime
(integer
) - サーバーが「
unavail
」、「checking
」、「unhealthy
」の状態にあった合計時間です。 -
downstart
(string
) - サーバーが「
unavail
」、「checking
」、「unhealthy
」になった時間です。ミリ秒単位のISO 8601形式です。 -
selected
(string
) - 最後に接続の処理のためにサーバーが選択された時間です。ミリ秒単位のISO 8601形式です。
-
-
zombies
(integer
) - グループから削除されたものの、アクティブなクライアント接続をまだ処理しているサーバーの現在の数です。
-
zone
(string
) - グループの設定とランタイムの状態を保持する共有メモリゾーンの名前です。
例
{ "dns" : { "peers" : [ { "id" : 0, "server" : "10.0.0.1:12347", "name" : "10.0.0.1:12347", "backup" : false, "weight" : 5, "state" : "up", "active" : 0, "ssl" : { "handshakes" : 200, "handshakes_failed" : 4, "session_reuses" : 189, "no_common_protocol" : 4, "handshake_timeout" : 0, "peer_rejected_cert" : 0, "verify_failures" : { "expired_cert" : 2, "revoked_cert" : 1, "hostname_mismatch" : 2, "other" : 1 } }, "max_conns" : 50, "connections" : 667231, "sent" : 251946292, "received" : 19222475454, "fails" : 0, "unavail" : 0, "health_checks" : { "checks" : 26214, "fails" : 0, "unhealthy" : 0, "last_passed" : true }, "downtime" : 0, "downstart" : "2022-06-28T11:09:21.602Z", "selected" : "2022-06-28T15:01:25.000Z" }, { "id" : 1, "server" : "10.0.0.1:12348", "name" : "10.0.0.1:12348", "backup" : true, "weight" : 1, "state" : "unhealthy", "active" : 0, "max_conns" : 50, "connections" : 0, "sent" : 0, "received" : 0, "fails" : 0, "unavail" : 0, "health_checks" : { "checks" : 26284, "fails" : 26284, "unhealthy" : 1, "last_passed" : false }, "downtime" : 262925617, "downstart" : "2022-06-28T11:09:21.602Z", "selected" : "2022-06-28T15:01:25.000Z" } ], "zombies" : 0, "zone" : "dns" } }
-
-
ストリームアップストリームサーバー
ストリームアップストリームサーバーの動的に構成可能なパラメータです。-
id
(integer
) - ストリームアップストリームサーバーのIDです。IDは自動的に割り当てられ、変更できません。
-
server
(string
) - ストリームアップストリームサーバーのaddressパラメータと同じです。サーバーを追加する際に、ドメイン名として指定できます。この場合、ドメイン名に対応するIPアドレスの変更が監視され、Nginxを再起動することなくアップストリーム設定に自動的に適用されます。これには、「
stream
」ブロック内のresolverディレクティブが必要です。ストリームアップストリームサーバーのresolveパラメータも参照してください。 -
service
(string
) - ストリームアップストリームサーバーのserviceパラメータと同じです。このパラメータは変更できません。
-
weight
(integer
) - ストリームアップストリームサーバーのweightパラメータと同じです。
-
max_conns
(integer
) - ストリームアップストリームサーバーのmax_connsパラメータと同じです。
-
max_fails
(integer
) - ストリームアップストリームサーバーのmax_failsパラメータと同じです。
-
fail_timeout
(string
) - ストリームアップストリームサーバーのfail_timeoutパラメータと同じです。
-
slow_start
(string
) - ストリームアップストリームサーバーのslow_startパラメータと同じです。
-
backup
(boolean
) true
の場合、バックアップサーバーを追加します。このパラメータは変更できません。-
down
(boolean
) - ストリームアップストリームサーバーのdownパラメータと同じです。
-
parent
(string
) - 解決済みサーバーの親サーバーIDです。IDは自動的に割り当てられ、変更できません。
-
host
(string
) - 解決済みサーバーのホスト名です。ホスト名は自動的に割り当てられ、変更できません。
例
{ "id" : 0, "server" : "10.0.0.1:12348", "weight" : 1, "max_conns" : 0, "max_fails" : 1, "fail_timeout" : "10s", "slow_start" : 0, "backup" : false, "down" : false }
-
-
ストリームKeyval共有メモリゾーン
GETメソッドを使用する場合のストリームkeyval共有メモリゾーンの内容です。例
{ "key1" : "value1", "key2" : "value2", "key3" : "value3" }
-
ストリームKeyval共有メモリゾーン
POSTまたはPATCHメソッドを使用する場合のストリームkeyval共有メモリゾーンの内容です。例
{ "key1" : "value1", "key2" : "value2", "key3" : { "value" : "value3", "expire" : 30000 } }
-
ストリームゾーン同期ノード
-
zones
-
共有メモリゾーンごとの同期情報です。
"Sync Zone" オブジェクトの集合です。
-
status
- クラスタ内のノードごとの同期情報です。
-
bytes_in
(integer
) - このノードで受信したバイト数です。
-
msgs_in
(integer
) - このノードで受信したメッセージ数です。
-
msgs_out
(integer
) - このノードから送信されたメッセージ数です。
-
bytes_out
(整数型
) - このノードによって送信されたバイト数。
-
nodes_online
(整数型
) - このノードが接続しているピアの数。
-
例
{ "zones" : { "zone1" : { "records_pending" : 2061, "records_total" : 260575 }, "zone2" : { "records_pending" : 0, "records_total" : 14749 } }, "status" : { "bytes_in" : 1364923761, "msgs_in" : 337236, "msgs_out" : 346717, "bytes_out" : 1402765472, "nodes_online" : 15 } }
-
-
同期ゾーン
共有メモリゾーンの同期状態。-
records_pending
(整数型
) - クラスタに送信する必要があるレコードの数。
-
records_total
(整数型
) - 共有メモリゾーンに格納されているレコードの総数。
-
-
レゾルバゾーン
特定のレゾルバゾーンごとのDNSリクエストとレスポンスの統計情報。-
リクエスト
-
-
name
(整数型
) - 名前をアドレスに解決するためのリクエストの総数。
-
srv
(整数型
) - SRVレコードを解決するためのリクエストの総数。
-
addr
(整数型
) - アドレスを名前に解決するためのリクエストの総数。
-
-
responses
-
-
noerror
(整数型
) - 正常なレスポンスの総数。
-
formerr
(整数型
) - FORMERR(
フォーマットエラー
)レスポンスの総数。 -
servfail
(整数型
) - SERVFAIL(
サーバーエラー
)レスポンスの総数。 -
nxdomain
(整数型
) - NXDOMAIN(
ホストが見つかりません
)レスポンスの総数。 -
notimp
(整数型
) - NOTIMP(
未実装
)レスポンスの総数。 -
refused
(整数型
) - REFUSED(
操作が拒否されました
)レスポンスの総数。 -
timedout
(整数型
) - タイムアウトしたリクエストの総数。
-
unknown
(整数型
) - 不明なエラーで完了したリクエストの総数。
-
例
{ "resolver_zone1" : { "requests" : { "name" : 25460, "srv" : 130, "addr" : 2580 }, "responses" : { "noerror" : 26499, "formerr" : 0, "servfail" : 3, "nxdomain" : 0, "notimp" : 0, "refused" : 0, "timedout" : 243, "unknown" : 478 } } }
-
-
ライセンス
NGINX Plusインスタンスのライセンスと使用状況レポートの状態。-
eval
(ブール型
) - NGINX Plusライセンスがトライアル版かどうかを示します。
-
active_till
(整数型
) - ライセンスの有効期限のUnixタイムスタンプ。
-
レポート
-
-
healthy
(ブール型
) - 最近のレポート送信失敗にもかかわらず、レポート状態が正常と見なされるかどうかを示します。
-
fails
(integer
) - 使用状況レポートが正常に送信されるたびにリセットされる、レポート送信失敗の回数。
-
grace
(整数型
) - レポート送信失敗後、トラフィック処理が停止されるまでの秒数。
-
例
{ "eval" : false, "active_till" : 1749268757, "reporting" : { "healthy" : true, "fails" : 2, "grace" : 15551961 } }
-
-
ワーカープロセス
各ワーカープロセスごとの統計情報。-
id
(integer
) - ワーカープロセスのID。
-
pid
(integer
) - オペレーティングシステムで使用されるワーカープロセスのPID識別子。
-
接続
- ワーカープロセスごとの、受理された、ドロップされた、アクティブな、アイドル状態の接続の数。
-
accepted
(integer
) - ワーカープロセスによって受理されたクライアント接続の総数。
-
dropped
(integer
) - ワーカープロセスによってドロップされたクライアント接続の総数。
-
active
(integer
) - 現在ワーカープロセスによって処理されているアクティブなクライアント接続の数。
-
idle
(integer
) - 現在ワーカープロセスによって処理されているアイドル状態のクライアント接続の数。
-
-
http
-
-
リクエスト
- ワーカープロセスによって処理されたクライアントリクエストの総数。
-
total
(integer
) - ワーカープロセスによって受信されたクライアントリクエストの総数。
-
current
(integer
) - 現在ワーカープロセスによって処理されているクライアントリクエストの数。
-
-
例
{ "id" : 0, "pid" : 32212, "connections" : { "accepted" : 1, "dropped" : 0, "active" : 1, "idle" : 0 }, "http" : { "requests" : { "total" : 15, "current" : 1 } } }
-
-
エラー
nginxエラーオブジェクト。-
エラー
-
-
status
(整数型
) - HTTPエラーコード。
-
text
(文字列型
) - エラーの説明。
-
code
(文字列型
) - 内部nginxエラーコード。
-
-
request_id
(文字列型
) - $request_id 変数の値と等しいリクエストのID。
-
href
(文字列型
) - 参照ドキュメントへのリンク。
-