> For the complete documentation index, see [llms.txt](https://documentation.alluxio.io/os-cn/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.alluxio.io/os-cn/api/clients-rest.md).

# REST API

为了其他语言的可移植性，除使用[原生文件系统Java客户端](/os-cn/api/fs-api.md)外，也可以通过REST API形式的HTTP代理访问Alluxio文件系统。

REST API documentation作为Alluxio构建的一部分被生成， 可以通过`${ALLUXIO_HOME}/core/server/proxy/target/miredot/index.html`来访问。 REST API和Alluxio Java API之间的主要区别在于如何表示流。Alluxio Java API 可以使用内存中的流，REST API将流的创建和访问分离（有关详细信息请参阅`create`和`open`REST API方法以及`streams`资源端点）。

HTTP代理是一个单机服务器，可以使用`${ALLUXIO_HOME} /bin/alluxio-start.sh proxy`开启服务，使用`${ALLUXIO_HOME} /bin/alluxio-stop.sh proxy`停止服务。默认情况下，REST API可在39999端口访问。

使用HTTP代理有性能问题。特别地，使用代理需要额外的跳跃。为了获得最佳性能，建议在每个计算节点上运行代理服务器和Alluxio工作程序。


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://documentation.alluxio.io/os-cn/api/clients-rest.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.