@ -1,23 +1,31 @@
# HTTP 客户端 {#http-ke-hu-duan}
---
toc_priority: 19
toc_title: HTTP客户端
---
HTTP 接口可以让你通过任何平台和编程语言来使用 ClickHouse。我们用 Java 和 Perl 以及 shell 脚本来访问它。在其他的部门中， ，
# HTTP客户端 {#http-interface}
默认情况下，
如果你发送了一个不带参数的 GET 请求，它会返回一个字符串 «Ok.»（结尾有换行）。可以将它用在健康检查脚本中。
HTTP接口允许您在任何编程语言的任何平台上使用ClickHouse。我们使用它在Java和Perl以及shell脚本中工作。在其他部门中， ，
默认情况下，`clickhouse-server`会在`8123`端口上监控HTTP请求（ ）
如果你发送了一个未携带任何参数的`GET /`请求，它会返回一个字符串 «Ok.»（结尾有换行）。可以将它用在健康检查脚本中。
如果你发送了一个未携带任何参数的`GET /`请求，
``` bash
$ curl 'http://localhost:8123/'
Ok.
```
通过 URL 中的 `query` 参数来发送请求，或者发送 POST 请求，或者将查询的开头部分放在 URL 的 `query` 参数中，其他部分放在 POST 中（ ） 的大小会限制在 16 KB，
通过URL中的 `query` 参数来发送请求， ， ， （ ） ，
如果请求成功，将会收到 200 的响应状态码和响应主体中的结果。
如果发生了某个异常，将会收到 500 的响应状态码和响应主体中的异常描述信息。
如果请求成功，
如果发生了某个异常，
当使用 GET 方法请求时，`readonly` 会被设置。换句话说，若要作修改数据的查询，只能发送 POST 方法的请求。可以将查询通过 POST 主体发送，也可以通过 URL 参数发送。
当使用GET方法请求时， ， ， ，
例:
示 例:
``` bash
$ curl 'http://localhost:8123/?query=SELECT%201'
@ -26,13 +34,14 @@ $ curl 'http://localhost:8123/?query=SELECT%201'
$ wget -nv -O- 'http://localhost:8123/?query=SELECT 1'
1
$ GET 'http://localhost:8123/?query=SELECT 1'
1
$ echo -ne 'GET /?query=SELECT%201 HTTP/1.0\r\n\r\n' | nc localhost 8123
HTTP/1.0 200 OK
Date: Wed, 27 Nov 2019 10:30:18 GMT
Connection: Close
Date: Fri, 16 Nov 2012 19:21:50 GMT
Content-Type: text/tab-separated-values; charset=UTF-8
X-ClickHouse-Server-Display-Name: clickhouse.ru-central1.internal
X-ClickHouse-Query-Id: 5abe861c-239c-467f-b955-8a201abb8b7f
X-ClickHouse-Summary: {"read_rows":"0","read_bytes":"0","written_rows":"0","written_bytes":"0","total_rows_to_read":"0"}
1
```
@ -50,7 +59,22 @@ $ echo '1' | curl 'http://localhost:8123/?query=SELECT' --data-binary @-
1
```
如果一部分请求是通过参数发送的，另外一部分通过 POST 主体发送，两部分查询之间会一行空行插入。
如您所见， ，
尽管wget本身会对所有内容进行转义， ， ，
``` bash
$ echo 'SELECT 1' | curl 'http://localhost:8123/' --data-binary @-
1
$ echo 'SELECT 1' | curl 'http://localhost:8123/?query=' --data-binary @-
1
$ echo '1' | curl 'http://localhost:8123/?query=SELECT' --data-binary @-
1
```
如果部分查询是在参数中发送的， ，
错误示例：
``` bash
@ -60,8 +84,11 @@ ECT 1
, expected One of: SHOW TABLES, SHOW DATABASES, SELECT, INSERT, CREATE, ATTACH, RENAME, DROP, DETACH, USE, SET, OPTIMIZE., e.what() = DB::Exception
```
默认情况下，返回的数据是 TabSeparated 格式的，更多信息，见 «\[数据格式\]» 部分。
可以使用 FORMAT 设置查询来请求不同格式。
默认情况下，返回的数据是`TabSeparated`格式的，更多信息，见[Formats](../interfaces/formats/)部分。
您可以使用查询的FORMAT子句来设置其他格式。
另外，还可以使用`default_format`URL参数或`X-ClickHouse-Format`头来指定TabSeparated之外的默认格式。
``` bash
$ echo 'SELECT 1 FORMAT Pretty' | curl 'http://localhost:8123/?' --data-binary @-
@ -72,42 +99,42 @@ $ echo 'SELECT 1 FORMAT Pretty' | curl 'http://localhost:8123/?' --data-binary @
└───┘
```
INSERT 必须通过 POST 方法来插入数据。这种情况下，你可以将查询的开头部分放在 URL 参数中，然后用 POST 主体传入插入的数据。插入的数据可以是，举个例子，从 MySQL 导出的以 tab 分割的数据。在这种方式中， 。
INSERT必须通过POST方法来插入数据。在这种情况下， ， ， ， 。
示例: 创建一个表:
``` bash
echo 'CREATE TABLE t (a UInt8) ENGINE = Memory' | POST 'http://localhost:8123/'
$ echo 'CREATE TABLE t (a UInt8) ENGINE = Memory' | curl 'http://localhost:8123/' --data-binary @-
```
使用类似 INSERT 的查询来插入数据：
使用类似INSERT的查询来插入数据：
``` bash
echo 'INSERT INTO t VALUES (1),(2),(3)' | POST 'http://localhost:8123/'
$ echo 'INSERT INTO t VALUES (1),(2),(3)' | curl 'http://localhost:8123/' --data-binary @-
```
数据可以从查询中单独发送：
``` bash
echo '(4),(5),(6)' | POST 'http://localhost:8123/?query=INSERT INTO t VALUES'
$ echo '(4),(5),(6)' | curl 'http://localhost:8123/?query=INSERT%20INTO%20t%20VALUES' --data-binary @-
```
可以指定任何数据格式。值的格式和写入表 `t` 的值的格式相同：
您可以指定任何数据格式。`Values`格式与将INSERT写入`t`值时使用的格式相同:
``` bash
echo '(7),(8),(9)' | POST 'http://localhost:8123/?query=INSERT INTO t FORMAT Values'
$ echo '(7),(8),(9)' | curl 'http://localhost:8123/?query=INSERT%20INTO%20t%20FORMAT%20Values' --data-binary @-
```
若要插入 tab 分割的数据，需要指定对应的格式：
若要插入tab分割的数据， ：
``` bash
echo -ne '10\n11\n12\n' | POST 'http://localhost:8123/?query=INSERT INTO t FORMAT TabSeparated'
$ echo -ne '10\n11\n12\n' | curl 'http://localhost:8123/?query=INSERT%20INTO%20t%20FORMAT%20TabSeparated' --data-binary @-
```
从表中读取内容。由于查询处理是并行的，数据以随机顺序输出。
``` bash
$ GET 'http://localhost:8123/?query=SELECT a FROM t'
$ curl 'http://localhost:8123/?query=SELECT%20a%20FROM%20 t'
7
8
9
@ -122,22 +149,37 @@ $ GET 'http://localhost:8123/?query=SELECT a FROM t'
6
```
删除表。
删除表：
``` bash
POST 'http://localhost:8123/?query=DROP TABLE t'
$ echo 'DROP TABLE t' | curl 'http://localhost:8123/' --data-binary @-
```
成功请求后并不会返回数据，返回一个空的响应体。
可以通过压缩来传输数据。压缩的数据没有一个标准的格式，但你需要指定一个压缩程序来使用它(sudo apt-get install compressor-metrika-yandex） 。
在传输数据时， ， 。
如果在 URL 中指定了 `compress=1` ，服务会返回压缩的数据。
如果在 URL 中指定了 `decompress=1` ，服务会解压通过 POST 方法发送的数据。
如果在URL中指定了`compress=1`，服务会返回压缩的数据。
如果在URL中指定了`decompress=1`，
可以通过为每份数据进行立即压缩来减少大规模数据传输中的网络压力。
您也可以选择使用[HTTP compression](https://en.wikipedia.org/wiki/HTTP_compression)。发送一个压缩的POST请求， ， ， compression methods ](https://en.wikipedia.org/wiki/HTTP_compression#Content-Encoding_tokens )。要启用HTTP压缩，
可以指定 ‘ ’
您可以使用它在传输大量数据时减少网络流量，或者创建立即压缩的转储。
通过压缩发送数据的例子:
``` bash
#Sending data to the server:
$ curl -vsS "http://localhost:8123/?enable_http_compression=1" -d 'SELECT number FROM system.numbers LIMIT 10' -H 'Accept-Encoding: gzip'
#Sending data to the client:
$ echo "SELECT 1" | gzip -c | curl -sS --data-binary @- -H 'Content-Encoding: gzip' 'http://localhost:8123/'
```
!!! note "警告"
一些HTTP客户端可能会在默认情况下从服务器解压数据(使用`gzip`和`deflate`)，即使您未正确地使用了压缩设置，您也可能会得到解压数据。
您可以使用`database`URL参数或`X-ClickHouse-Database`头来指定默认数据库。
``` bash
$ echo 'SELECT number FROM numbers LIMIT 10' | curl 'http://localhost:8123/?database=system' --data-binary @-
@ -153,30 +195,38 @@ $ echo 'SELECT number FROM numbers LIMIT 10' | curl 'http://localhost:8123/?data
9
```
默认情况下，默认数据库会在服务的配置中注册，默认是 `default` 。或者，也可以在表名之前使用一个 点来指定数据库。
默认情况下，在服务器设置中注册的数据库被用作默认数据库。默认情况下，它是名为`default`的数据库。或者，您可以始终在表名之前使用 点来指定数据库。
用户名密码可以通过以下两 种方式指定：
用户名和密码可以通过以下三 种方式指定：
1. 通过 HTTP Basic Authentication。示例：
1. 通过HTTP Basic Authentication。示例：
<!-- -->
``` bash
echo 'SELECT 1' | curl 'http://user:password@localhost:8123/' -d @-
$ echo 'SELECT 1' | curl 'http://user:password@localhost:8123/' -d @-
```
1. 通过 URL 参数 中的 ‘ ’ ‘ ’ 。示例：
1. 通过URL参数中的`user`和`password` 。示例：
<!-- -->
``` bash
echo 'SELECT 1' | curl 'http://localhost:8123/?user=user& password=password' -d @-
$ echo 'SELECT 1' | curl 'http://localhost:8123/?user=user& password=password' -d @-
```
如果用户名没有指定，默认的用户是 `default` 。如果密码没有指定，默认会使用空密码。
可以使用 URL 参数指定配置或者设置整个配置文件来处理单个查询。示例：`http://localhost:8123/?profile=web& max_rows_to_read=1000000000& query=SELECT+1`
1. 使用`X-ClickHouse-User`或`X-ClickHouse-Key`头指定，示例:
更多信息，参见 «[设置](../operations/settings/index.md#settings)» 部分。
<!-- -->
``` bash
$ echo 'SELECT 1' | curl -H 'X-ClickHouse-User: user' -H 'X-ClickHouse-Key: password' 'http://localhost:8123/' -d @-
```
如果未指定用户名，则使用`default`。如果未指定密码，则使用空密码。
您还可以使用URL参数来指定处理单个查询或整个设置配置文件的任何设置。例子:`http://localhost:8123/?profile=web& max_rows_to_read=1000000000& query=SELECT+1`
更多信息，详见[设置](../operations/settings/index.md#settings)部分。
``` bash
$ echo 'SELECT number FROM system.numbers LIMIT 10' | curl 'http://localhost:8123/?' --data-binary @-
@ -192,30 +242,386 @@ $ echo 'SELECT number FROM system.numbers LIMIT 10' | curl 'http://localhost:812
9
```
更多关于其他参数的信息，参见 «[设置](../operations/settings/index.md#settings)» 部分 。
有关其他参数的信息，请参考`SET`一节 。
相比起 TCP 原生接口， 。
类似地， ， ， ， ， 。
可选的 `query_id` 参数可能当做 query ID 传入（或者任何字符串）。更多信息，参见 «[设置 replace_running_query](../operations/settings/settings.md)» 部分。
您可以在`X-ClickHouse-Progress`响应头中收到查询进度的信息。为此，启用[Http Header携带进度](../operations/settings/settings.md#settings-send_progress_in_http_headers)。示例：
可选的 `quota_key` 参数可能当做 quota key 传入（或者任何字符串）。更多信息，参见 «[配额](../operations/quotas.md#quotas)» 部分。
``` text
X-ClickHouse-Progress: {"read_rows":"2752512","read_bytes":"240570816","total_rows_to_read":"8880128"}
X-ClickHouse-Progress: {"read_rows":"5439488","read_bytes":"482285394","total_rows_to_read":"8880128"}
X-ClickHouse-Progress: {"read_rows":"8783786","read_bytes":"819092887","total_rows_to_read":"8880128"}
```
HTTP 接口允许传入额外的数据（外部临时表）来查询。更多信息，参见 «[外部数据查询处理](../engines/table-engines/special/external-data.md)» 部分。
显示字段信息:
## 响应缓冲 {#xiang-ying-huan-chong}
- `read_rows` — 读取的行数。
- `read_bytes` — 读取的数据字节数。
- `total_rows_to_read` — 读取的数据总行数。
- `written_rows` — 写入数据行数。
- `written_bytes` — 写入数据字节数。
可以在服务器端启用响应缓冲。提供了 `buffer_size` 和 `wait_end_of_query` 两个URL 参数来达此目的。
如果HTTP连接丢失， ， 。
`buffer_size` 决定了查询结果要在服务内存中缓冲多少个字节数据. 如果响应体比这个阈值大，缓冲区会写入到 HTTP 管道，剩下的数据也直接发到 HTTP 管道中。
可选的`query_id`参数可能当做query ID传入（ ） ， 。
为了确保整个响应体被缓冲，可以设置 `wait_end_of_query=1` 。这种情况下，存入内存的数据会被缓冲到服务端的一个临时文件中。
可选的`quota_key`参数可能当做quota key传入（ ） ，
HTTP接口允许传入额外的数据（ ） ，
## 响应缓冲 {#response-buffering}
可以在服务器端启用响应缓冲。提供了`buffer_size`和`wait_end_of_query`两个URL参数来达此目的。
`buffer_size` 决定了查询结果要在服务内存中缓冲多少个字节数据. 如果响应体比这个阈值大， ，
为了确保整个响应体被缓冲，可以设置`wait_end_of_query=1`。这种情况下，存入内存的数据会被缓冲到服务端的一个临时文件中。
示例:
``` bash
curl -sS 'http://localhost:8123/?max_result_bytes=4000000& buffer_size=3000000& wait_end_of_query=1' -d 'SELECT toUInt8(number) FROM system.numbers LIMIT 9000000 FORMAT RowBinary'
$ curl -sS 'http://localhost:8123/?max_result_bytes=4000000& buffer_size=3000000& wait_end_of_query=1' -d 'SELECT toUInt8(number) FROM system.numbers LIMIT 9000000 FORMAT RowBinary'
```
查询请求响应状态码和 HTTP 头被发送到客户端后，若发生查询处理出错，使用缓冲区可以避免这种情况的发生。在这种情况下，响应主体的结尾会写入一条错误消息，而在客户端，只能在解析阶段检测到该错误。
查询请求响应状态码和HTTP头被发送到客户端后， ， ， ， ，
### 查询参数 {#cli-queries-with-parameters}
您可以使用参数创建查询， ，
### 示例 {#example}
``` bash
$ curl -sS "< address > ?param_id=2& param_phrase=test" -d "SELECT * FROM table WHERE int_column = {id:UInt8} and string_column = {phrase:String}"
```
## 特定的HTTP接口 {#predefined_http_interface}
ClickHouse通过HTTP接口支持特定的查询。例如，
``` bash
$ echo '(4),(5),(6)' | curl 'http://localhost:8123/?query=INSERT%20INTO%20t%20VALUES' --data-binary @-
```
ClickHouse还支持预定义的HTTP接口， ，
示例:
- 首先，将此部分添加到服务器配置文件中:
<!-- -->
``` xml
< http_handlers >
< rule >
< url > /predefined_query< / url >
< methods > POST,GET< / methods >
< handler >
< type > predefined_query_handler< / type >
< query > SELECT * FROM system.metrics LIMIT 5 FORMAT Template SETTINGS format_template_resultset = 'prometheus_template_output_format_resultset', format_template_row = 'prometheus_template_output_format_row', format_template_rows_between_delimiter = '\n'</ query >
< / handler >
< / rule >
< rule > ...< / rule >
< rule > ...< / rule >
< / http_handlers >
```
- 请求Prometheus格式的URL以获取数据:
<!-- -->
``` bash
$ curl -v 'http://localhost:8123/predefined_query'
* Trying ::1...
* Connected to localhost (::1) port 8123 (#0)
> GET /predefined_query HTTP/1.1
> Host: localhost:8123
> User-Agent: curl/7.47.0
> Accept: */*
>
< HTTP / 1 . 1 200 OK
< Date: Tue , 28 Apr 2020 08:52:56 GMT
< Connection: Keep-Alive
< Content-Type: text / plain ; charset = UTF-8
< X-ClickHouse-Server-Display-Name: i-mloy5trc
< Transfer-Encoding: chunked
< X-ClickHouse-Query-Id: 96fe0052-01e6-43ce-b12a-6b7370de6e8a
< X-ClickHouse-Format: Template
< X-ClickHouse-Timezone: Asia / Shanghai
< Keep-Alive: timeout = 3
< X-ClickHouse-Summary: { " read_rows " : " 0 " , " read_bytes " : " 0 " , " written_rows " : " 0 " , " written_bytes " : " 0 " , " total_rows_to_read " : " 0 " }
<
# HELP "Query" "Number of executing queries"
# TYPE "Query" counter
"Query" 1
# HELP "Merge" "Number of executing background merges"
# TYPE "Merge" counter
"Merge" 0
# HELP "PartMutation" "Number of mutations (ALTER DELETE/UPDATE)"
# TYPE "PartMutation" counter
"PartMutation" 0
# HELP "ReplicatedFetch" "Number of data parts being fetched from replica"
# TYPE "ReplicatedFetch" counter
"ReplicatedFetch" 0
# HELP "ReplicatedSend" "Number of data parts being sent to replicas"
# TYPE "ReplicatedSend" counter
"ReplicatedSend" 0
* Connection #0 to host localhost left intact
* Connection #0 to host localhost left intact
```
正如您从示例中看到的，如果在`config.xml`文件中配置了`http_handlers`，并且`http_handlers`可以包含许多`规则`。ClickHouse将把接收到的HTTP请求与`rule`中的预定义类型进行匹配， ，
现在`rule`可以配置`method`， `header` ， `url` ， `handler` :
- `method` 负责匹配HTTP请求的方法部分。 `method` 完全符合HTTP协议中[method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods)的定义。这是一个可选的配置。如果它没有在配置文件中定义，
- `url` 负责匹配HTTP请求的URL部分。它匹配[RE2](https://github.com/google/re2)正则表达式。这是一个可选的配置。如果配置文件中没有定义它，
- `headers` 负责匹配HTTP请求的头部分。它与RE2的正则表达式兼容。这是一个可选的配置。如果它没有在配置文件中定义，
- `handler` 包含主要的处理部分。现在`handler`可以配置`type`, `status` , `content_type` , `response_content` , `query` , `query_param_name` 。
`type` 目前支持三种类型:[特定查询](#predefined_query_handler), [动态查询 ](#dynamic_query_handler ), [static ](#static ).
- `query` — 使用`predefined_query_handler`类型，在调用处理程序时执行查询。
- `query_param_name` — 与`dynamic_query_handler`类型一起使用，
- `status` — 与`static`类型一起使用，响应状态代码。
- `content_type` — 与`static`类型一起使用，响应信息[content-type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type)。
- `response_content` — 与`static`类型一起使用，响应发送给客户端的内容，当使用前缀`file://`或`config://`时，从发送给客户端的文件或配置中查找内容。
接下来是不同`type`的配置方法。
### 特定查询 {#predefined_query_handler}
`predefined_query_handler` 支持设置`Settings`和`query_params`参数。您可以将`query`配置为`predefined_query_handler`类型。
`query` 是一个预定义的`predefined_query_handler`查询，
以下是定义的[max_threads](../operations/settings/settings.md#settings-max_threads)和`max_alter_threads`设置， 然后查询系统表以检查这些设置是否设置成功。
示例:
``` xml
< http_handlers >
< rule >
< url > <![CDATA[/query_param_with_url/ \w+/(?P<name_1>[^/]+)(/(?P<name_2>[^/]+))?]]> </ url >
< method > GET< / method >
< headers >
< XXX > TEST_HEADER_VALUE< / XXX >
< PARAMS_XXX > <![CDATA[(?P<name_1>[^/]+)(/(?P<name_2>[^/]+))?]]> < / PARAMS_XXX >
< / headers >
< handler >
< type > predefined_query_handler< / type >
< query > SELECT value FROM system.settings WHERE name = {name_1:String}< / query >
< query > SELECT name, value FROM system.settings WHERE name = {name_2:String}< / query >
< / handler >
< / rule >
< / http_handlers >
```
``` bash
$ curl -H 'XXX:TEST_HEADER_VALUE' -H 'PARAMS_XXX:max_threads' 'http://localhost:8123/query_param_with_url/1/max_threads/max_alter_threads?max_threads=1& max_alter_threads=2'
1
max_alter_threads 2
```
!!! note "警告"
在一个`predefined_query_handler`中，
### 动态查询 {#dynamic_query_handler}
`dynamic_query_handler` 时， ，
ClickHouse提取并执行与HTTP请求URL中的`query_param_name`值对应的值。`query_param_name`的默认值是`/query`。这是一个可选的配置。如果配置文件中没有定义，则不会传入参数。
为了试验这个功能，示例定义了[max_threads](../operations/settings/settings.md#settings-max_threads)和`max_alter_threads`，
示例:
``` xml
< http_handlers >
< rule >
< headers >
< XXX > TEST_HEADER_VALUE_DYNAMIC< / XXX > < / headers >
< handler >
< type > dynamic_query_handler< / type >
< query_param_name > query_param< / query_param_name >
< / handler >
< / rule >
< / http_handlers >
```
``` bash
$ curl -H 'XXX:TEST_HEADER_VALUE_DYNAMIC' 'http://localhost:8123/own?max_threads=1& max_alter_threads=2& param_name_1=max_threads& param_name_2=max_alter_threads& query_param=SELECT%20name,value%20FROM%20system.settings%20where%20name%20=%20%7Bname_1:String%7D%20OR%20name%20=%20%7Bname_2:String%7D'
max_threads 1
max_alter_threads 2
```
### static {#static}
`static` 可以返回[content_type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type), [status ](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status )和`response_content`。`response_content`可以返回指定的内容。
示例:
返回信息.
``` xml
< http_handlers >
< rule >
< methods > GET< / methods >
< headers > < XXX > xxx< / XXX > < / headers >
< url > /hi< / url >
< handler >
< type > static< / type >
< status > 402< / status >
< content_type > text/html; charset=UTF-8< / content_type >
< response_content > Say Hi!< / response_content >
< / handler >
< / rule >
< http_handlers >
```
``` bash
$ curl -vv -H 'XXX:xxx' 'http://localhost:8123/hi'
* Trying ::1...
* Connected to localhost (::1) port 8123 (#0)
> GET /hi HTTP/1.1
> Host: localhost:8123
> User-Agent: curl/7.47.0
> Accept: */*
> XXX:xxx
>
< HTTP / 1 . 1 402 Payment Required
< Date: Wed , 29 Apr 2020 03:51:26 GMT
< Connection: Keep-Alive
< Content-Type: text / html ; charset = UTF-8
< Transfer-Encoding: chunked
< Keep-Alive: timeout = 3
< X-ClickHouse-Summary: { " read_rows " : " 0 " , " read_bytes " : " 0 " , " written_rows " : " 0 " , " written_bytes " : " 0 " , " total_rows_to_read " : " 0 " }
<
* Connection #0 to host localhost left intact
Say Hi!%
```
从配置中查找发送到客户端的内容。
``` xml
< get_config_static_handler > <![CDATA[<html ng-app="SMI2"><head><base href="http://ui.tabix.io/"></head><body><div ui-view="" class="content-ui"></div><script src="http://loader.tabix.io/master.js"></script></body></html>]]> < / get_config_static_handler >
< http_handlers >
< rule >
< methods > GET< / methods >
< headers > < XXX > xxx< / XXX > < / headers >
< url > /get_config_static_handler< / url >
< handler >
< type > static< / type >
< response_content > config://get_config_static_handler< / response_content >
< / handler >
< / rule >
< / http_handlers >
```
``` bash
$ curl -v -H 'XXX:xxx' 'http://localhost:8123/get_config_static_handler'
* Trying ::1...
* Connected to localhost (::1) port 8123 (#0)
> GET /get_config_static_handler HTTP/1.1
> Host: localhost:8123
> User-Agent: curl/7.47.0
> Accept: */*
> XXX:xxx
>
< HTTP / 1 . 1 200 OK
< Date: Wed , 29 Apr 2020 04:01:24 GMT
< Connection: Keep-Alive
< Content-Type: text / plain ; charset = UTF-8
< Transfer-Encoding: chunked
< Keep-Alive: timeout = 3
< X-ClickHouse-Summary: { " read_rows " : " 0 " , " read_bytes " : " 0 " , " written_rows " : " 0 " , " written_bytes " : " 0 " , " total_rows_to_read " : " 0 " }
<
* Connection #0 to host localhost left intact
< html ng-app = "SMI2" > < head > < base href = "http://ui.tabix.io/" > < / head > < body > < div ui-view = "" class = "content-ui" > < / div > < script src = "http://loader.tabix.io/master.js" > < / script > < / body > < / html > %
```
从发送到客户端的文件中查找内容。
``` xml
< http_handlers >
< rule >
< methods > GET< / methods >
< headers > < XXX > xxx< / XXX > < / headers >
< url > /get_absolute_path_static_handler< / url >
< handler >
< type > static< / type >
< content_type > text/html; charset=UTF-8< / content_type >
< response_content > file:///absolute_path_file.html< / response_content >
< / handler >
< / rule >
< rule >
< methods > GET< / methods >
< headers > < XXX > xxx< / XXX > < / headers >
< url > /get_relative_path_static_handler< / url >
< handler >
< type > static< / type >
< content_type > text/html; charset=UTF-8< / content_type >
< response_content > file://./relative_path_file.html< / response_content >
< / handler >
< / rule >
< / http_handlers >
```
``` bash
$ user_files_path='/var/lib/clickhouse/user_files'
$ sudo echo "< html > < body > Relative Path File< / body > < / html > " > $user_files_path/relative_path_file.html
$ sudo echo "< html > < body > Absolute Path File< / body > < / html > " > $user_files_path/absolute_path_file.html
$ curl -vv -H 'XXX:xxx' 'http://localhost:8123/get_absolute_path_static_handler'
* Trying ::1...
* Connected to localhost (::1) port 8123 (#0)
> GET /get_absolute_path_static_handler HTTP/1.1
> Host: localhost:8123
> User-Agent: curl/7.47.0
> Accept: */*
> XXX:xxx
>
< HTTP / 1 . 1 200 OK
< Date: Wed , 29 Apr 2020 04:18:16 GMT
< Connection: Keep-Alive
< Content-Type: text / html ; charset = UTF-8
< Transfer-Encoding: chunked
< Keep-Alive: timeout = 3
< X-ClickHouse-Summary: { " read_rows " : " 0 " , " read_bytes " : " 0 " , " written_rows " : " 0 " , " written_bytes " : " 0 " , " total_rows_to_read " : " 0 " }
<
< html > < body > Absolute Path File< / body > < / html >
* Connection #0 to host localhost left intact
$ curl -vv -H 'XXX:xxx' 'http://localhost:8123/get_relative_path_static_handler'
* Trying ::1...
* Connected to localhost (::1) port 8123 (#0)
> GET /get_relative_path_static_handler HTTP/1.1
> Host: localhost:8123
> User-Agent: curl/7.47.0
> Accept: */*
> XXX:xxx
>
< HTTP / 1 . 1 200 OK
< Date: Wed , 29 Apr 2020 04:18:31 GMT
< Connection: Keep-Alive
< Content-Type: text / html ; charset = UTF-8
< Transfer-Encoding: chunked
< Keep-Alive: timeout = 3
< X-ClickHouse-Summary: { " read_rows " : " 0 " , " read_bytes " : " 0 " , " written_rows " : " 0 " , " written_bytes " : " 0 " , " total_rows_to_read " : " 0 " }
<
< html > < body > Relative Path File< / body > < / html >
* Connection #0 to host localhost left intact
```
[来源文章 ](https://clickhouse.tech/docs/zh/interfaces/http_interface/ ) <!--hide-->
dkxiaohei