密钥 API

了解密钥 API

关于密钥 API

通过密钥 API，您可以管理密钥，并执行一些后端功能，例如密封和拆封密钥存储库。它提供比 DC/OS UI 更多的功能。

请求和响应格式

API 仅支持 JSON。您必须在 HTTP 标头中包含 作为 Content-Type，如下所示。

主机名和基础路径

要使用的主机名根据应用程序运行的位置而异。

  • 如果您的应用程序在 DC/OS 群集之外运行，则应该使用群集 URL。若要获取群集 URL，请启动 DC/OS UI，并从浏览器复制域名。在生产环境中，这应该是位于主服务器前面的负载均衡器的路径。

将 /secrets/v1/<api_endpoint> 附加到主机名，如下所示。

身份验证和授权

关于身份认证和授权

所有密钥 API 端点都需要认证令牌。

获取认证令牌

若要获取认证令牌，请将请求正文中 superuser 的用户名和密码传递给身份和访问管理服务 API 的 /auth/login 端点。它将返回认证令牌，如下所示。

使用 dcos auth login 登录 时，它会在本地存储认证令牌值。您可以在 命令中将此值引用为变量（在下一部分中讨论）。或者，您可以使用以下命令获取认证令牌值：

  1. dcos config show core.dcos_acs_token

复制令牌值并将其传递到 HTTP 标头的 Authorization 字段中，如下所示。

例如，使用 curl，您将按以下方式传递此值。

    然后，您可以在 curl 命令中引用此值，如下所示。

    刷新认证令牌

    默认情况下，认证令牌在五天后过期。如果您的程序需要运行超过五天，则需要一个服务帐户。有关更多信息，请参阅。

    API 参考

    日志记录

    虽然 API 会返回信息性错误消息，但您也可能会发现检查服务日志很有用。有关说明，请参阅服务和任务日志记录。