跳至内容

Equinix API

Equinix™ 提供了一个 RESTful HTTP API，可通过 https://api.equinix.com/ 访问。本文档介绍了该 API 及其使用方法。

API 允许您以编程方式与您的 Equinix 资源进行交互，包括项目、设备、连接、订单、托管部署、支持工单以及身份和访问管理。

使用 Equinix API​

使用 API 可以分为授权流程和请求流程。

通过 API 与 Equinix 产品交互需要：

  • Equinix客户门户帐户或OIDC提供商。
  • 产品专属的创建、修改和删除权限。

用户授权流程​

  1. 在Customer Portal注册并授权应用程序。

  2. 通过调用 /oauth2/v1/token 并传入 Consumer 密钥、Consumer 密钥和您的用户凭据来请求访问和刷新令牌信息。

    Diagram of the user authorization flow showing a client application obtaining an OAuth access token and refresh token from the Equinix API

  3. 您的请求会将有效期较短的 OAuth 访问令牌及其关联的刷新令牌返回给您。

有关更多信息和更详细的说明，请参阅API 身份验证。

OIDC令牌授权流程​

  1. Create an OIDC Provider in either the Customer Portal or the Equinix API.

  2. 使用您的身份提供商令牌和范围调用 /v1/token 端点来请求访问权限。

  1. 您的请求返回的是有效期很短的访问令牌。

有关更多信息，请参阅OIDC API 身份验证。

请求流程​

  1. 使用有效的 OAuth 访问令牌授权请求，并向 API 端点发出带有所需授权标头的调用。

    Diagram of the API request flow showing a client calling the API gateway, which forwards the request to Equinix APIs and returns the response

  2. API 网关验证请求并调用相关的 Equinix API。

  3. API网关已收到响应。

  4. 回复已发送给您。

使用 Terraform 进行基础设施即代码​

除了 REST API 之外，Equinix 还提供了一个 Terraform 提供程序，允许您使用基础设施即代码 (IaC) 来管理 Equinix 资源。Terraform 提供程序封装了 Equinix API，并提供了一种声明式的方法来定义和管理您的基础设施。

Equinix Terraform Provider 支持：

  • Equinix Metal - 裸机服务器、网络和基础设施
  • Equinix Fabric - 虚拟连接、云路由器、流媒体和精确时间
  • 网络边缘 - 虚拟网络设备

有关完整的文档、示例和可用资源，请参阅Terraform Provider 文档。

API 参考资料​

Equinix API 按版本化的功能组进行组织。每个功能组包含一组 API 端点，允许您执行与该组相关的操作。

API 参考文档以 OpenAPI 格式提供，其中包含每个端点的详细信息，包括请求和响应格式、必需参数以及示例请求。在 Equinix 产品文档中，您可以找到指向与所讨论产品或服务对应的“API 参考文档”的链接。

要按功能组查看所有 Equinix API 参考库，请参阅API 目录。您还可以使用以下导航树找到所有 Equinix API 参考的链接。在此视图中，每个主要 API 路径都链接到其对应的 API 参考。

No APIs found or available based on the current filters.

此页面有帮助吗？