跳到主要内容

Equinix API

Equinix™提供REST风格的HTTP API,可在以下网址访问https://api.equinix.com/。本文介绍API及其使用方法。

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

使用 Equinix API​

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

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

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

用户授权流程​

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

  2. 使用消费者密钥,消费者机密钥和您的用户凭据调用,请求访问权限并刷新令牌信息/oauth2/v1/token。

    用户授权流程示意图,显示客户端应用程序从Equinix API获取OAuth访问令牌并刷新令牌

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

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

OIDC令牌授权流程​

  1. 在客户门户网站或Equinix API中创建OIDC提供商。

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

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

有关更多信息,请参阅OIDC API验证。

请求流程​

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

    API请求流示意图,显示调用API网关的客户端,该网关将请求转发到Equinix API并返回响应

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

  3. API网关已收到响应。

  4. 回复已发送给您。

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

除了REST API,Equinix还提供Terraform提供程序,允许您使用基础设施作为代码来管理Equinix资源。Terraform提供商打包Equinix API,并提供定义和管理基础设施的声明方式。

Equinix Terraform Provider 支持:

  • Equinix Fabric -虚拟连接,云路由器,STREAMS和Precision Time
  • Network Edge -虚拟网络设备

如需完整的文档,示例和可用资源, 请参阅Terraform提供商文档。

API 参考资料​

Equinix API分为分版本功能组。每个功能组都包含一组API端点,允许您执行与该组相关的操作。

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

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

这个页面对您有帮助吗?