API 参考

ENTERPRISE

DC/OS API 是由 DC/OS 组件支持的一组路由，通过名为 Admin Router的 API 网关提供。

图 1. DC/OS API 路由示意图

API 网关

Admin Router 是基于 NGINX 的 API 网关，具有以下功能：

Admin Router 在每个 DC/OS 节点上运行，其有如下两种配置：

此配置在每个管理节点上运行，用作与 DC/OS 组件交互的主 API 网关。

此配置在每个代理节点上运行，并提供用于监控、调试和管理的路由。

某些代理路由，如日志和度量标准，通过管理节点 Admin Router 代理以允许外部访问。其他路由，如组件管理，仅供内部使用。

Admin Router 公开若干路由类型：

要确定集群的 URL，请参阅集群访问。

DC/OS API 的部分按组件、路由或资源进行版本控制。

有关版本控制机制的详细信息，请参阅版本控制。

某些路由未经过身份认证，但大多数路由都需要认证令牌。

有关如何获取和使用认证令牌的详细信息，请参阅验证 HTTP API 端点。

大多数认证路由也需要通过权限授权。DC/OS Enterprise 中的权限包含分层资源标识符和操作（创建、读取、更新、删除、全部）。

权限执行可以在两个级别执行。

权限管理可通过具有超级用户权限的用户使用身份和访问管理 API执行。具有超级用户权限的用户也有隐式权限访问所有路由。

通过 代理路由确定一个 API 资源的完整 URL，连接集群 URL、路由和后端组件资源路径。
```
<cluster-url>/<route>/<resource-path>
```

例如，从以下获取 Mesos 版本：https://dcos.example.com/mesos/version

文件路由 没有后端组件，但可能提供有多个文件的目录或单个文件。因此，对于文件路由，指定文件路径，而不是后端组件资源路径。
```
<cluster-url>/<route>/<file-path>
```

例如，从以下获取集群的 DC/OS 版本：https://dcos.example.com/dcos-metadata/dcos-version.json

Lua 路由 立即在 Admin Router 中执行代码，而不是以代理的方式路由到外部后端组件。因此，对于 Lua 路由，路由后无需路径。
```
<cluster-url>/<route>
```

例如，从以下获取管理节点的公用 IP 和集群 ID：https://dcos.example.com/metadata

重写和重定向路由可能会在返回资源之前穿过一个或多个其他 URL 或路由。因此，对于这些路由，请遵循 URL 和路由链以查找端点。资源路径将取决于最终端点。

大多数重写和重定向在另一个 DC/OS API 路由上终止，但是明显的例外是/login，它使用 OpenID Connect 和外部身份提供程序进行授权，然后重定向回 DC/OS API。

获取集群 URL 的访问权限…

在 DC/OS 管理节点上运行 Admin Router…

使用在 DC/OS 代理节点上运行的 Admin Router Agent…

理解组件、资源和路由版本控制…