nginx支持的所有內置變量

2024-08-30 12:23:44

字體：大中小

來源：轉載

供稿：網友

　　Nginx的配置文件是一個純文本文件，它一般位于Nginx安裝目錄的conf目錄下，整個配置文件是以block的形式組織的。每個block一般以一個大括號“{”來表示。block 可以分為幾個層次，整個配置文件中Main命令位于最高層，在Main層下面可以有Events、 HTTP等層級，而在HTTP層中又包含Server層，即server block, serverblock中又可分為location層，并且一個server block中可以包含多個location block。

　　而內置變量存放在ngx_http_core_module模塊中，變量的命名方式和apache服務器變量是一致的，這些變量代表著客戶端請求頭的內容，例如$http_user_agent, $http_cookie, 等等。下面是nginx支持的所有內置變量：

　　$arg_name

　　請求中的的參數名，即“?”后面的arg_name=arg_value形式的arg_name

　　$args

　　請求中的參數值

　　$binary_remote_addr

　　客戶端地址的二進制形式, 固定長度為4個字節

　　$body_bytes_sent

　　傳輸給客戶端的字節數，響應頭不計算在內；這個變量和Apache的mod_log_config模塊中的“%B”參數保持兼容

　　$bytes_sent

　　傳輸給客戶端的字節數 (1.3.8, 1.2.5)

　　$connection

　　TCP連接的序列號 (1.3.8, 1.2.5)

　　$connection_requests

　　TCP連接當前的請求數量 (1.3.8, 1.2.5)

　　$content_length

　　“Content-Length” 請求頭字段

　　$content_type

　　“Content-Type” 請求頭字段

　　$cookie_name

　　cookie名稱

　　$document_root

　　當前請求的文檔根目錄或別名

　　$document_uri

　　同 $uri

　　$host

　　優先級如下：HTTP請求行的主機名>”HOST”請求頭字段>符合請求的服務器名

　　$hostname

　　主機名

　　$http_name

　　匹配任意請求頭字段；變量名中的后半部分“name”可以替換成任意請求頭字段，如在配置文件中需要獲取http請求頭：“Accept-Language”，那么將“－”替換為下劃線，大寫字母替換為小寫，形如：$http_accept_language即可。

　　$https

　　如果開啟了SSL安全模式，值為“on”，否則為空字符串。

　　$is_args

　　如果請求中有參數，值為“?”，否則為空字符串。

　　$limit_rate

　　用于設置響應的速度限制，詳見 limit_rate。

　　$msec

　　當前的Unix時間戳 (1.3.9, 1.2.6)

　　$nginx_version

　　nginx版本

　　$pid

　　工作進程的PID

　　$pipe

　　如果請求來自管道通信，值為“p”，否則為“.” (1.3.12, 1.2.7)

　　$proxy_protocol_addr

　　獲取代理訪問服務器的客戶端地址，如果是直接訪問，該值為空字符串。(1.5.12)

　　$query_string

　　同 $args

　　$realpath_root

　　當前請求的文檔根目錄或別名的真實路徑，會將所有符號連接轉換為真實路徑。

　　$remote_addr

　　客戶端地址

　　$remote_port

　　客戶端端口

　　$remote_user

　　用于HTTP基礎認證服務的用戶名

　　$request

　　代表客戶端的請求地址

　　$request_body

　　客戶端的請求主體

　　此變量可在location中使用，將請求主體通過proxy_pass, fastcgi_pass, uwsgi_pass, 和 scgi_pass傳遞給下一級的代理服務器。

　　$request_body_file

　　將客戶端請求主體保存在臨時文件中。文件處理結束后，此文件需刪除。如果需要之一開啟此功能，需要設置client_body_in_file_only。如果將次文件傳遞給后端的代理服務器，需要禁用request body，即設置proxy_pass_request_body off，fastcgi_pass_request_body off, uwsgi_pass_request_body off, or scgi_pass_request_body off 。

　　$request_completion

　　如果請求成功，值為”OK”，如果請求未完成或者請求不是一個范圍請求的最后一部分，則為空。

　　$request_filename

　　當前連接請求的文件路徑，由root或alias指令與URI請求生成。

　　$request_length

　　請求的長度 (包括請求的地址, http請求頭和請求主體) (1.3.12, 1.2.7)

　　$request_method

　　HTTP請求方法，通常為“GET”或“POST”

　　$request_time

　　處理客戶端請求使用的時間 (1.3.9, 1.2.6); 從讀取客戶端的第一個字節開始計時。

　　$request_uri

　　這個變量等于包含一些客戶端請求參數的原始URI，它無法修改，請查看$uri更改或重寫URI，不包含主機名，例如：”/cnphp/test.php?arg=freemouse”。