# Equinix API Equinix™提供REST风格的HTTP API,可在以下网址访问`https://api.equinix.com/`。本文介绍API及其使用方法。 API 允许您以编程方式与您的 Equinix 资源进行交互,包括项目、设备、连接、订单、托管部署、支持工单以及身份和访问管理。 ## 使用 Equinix API[​](#使用-equinix-api "直接链接至使用 Equinix API") 使用 API 可以分为授权流程和请求流程。 通过 API 与 Equinix 产品交互需要: * Equinix客户门户帐户或OIDC提供商。 * 产品专属的创建、修改和删除权限。 ### 用户授权流程[​](#用户授权流程 "直接链接至用户授权流程") 1. 在Customer Portal注册并授权应用程序。 2. 使用消费者密钥,消费者机密钥和您的用户凭据调用,请求访问权限并刷新令牌信息[`/oauth2/v1/token`](https://docs.equinix.com/zh-Hans/api-catalog/accesstokenv1/oauth2-token/getoauth2accesstoken.md)。 ![用户授权流程示意图,显示客户端应用程序从Equinix API获取OAuth访问令牌并刷新令牌](https://docs.equinix.com/zh-Hans/assets/images/authorization-flow-968fdaa494b91626a4d3176b604cd49e.jpg) 3. 您的请求会将有效期较短的 OAuth 访问令牌及其关联的刷新令牌返回给您。 有关更多信息和更详细的说明,请参阅[API身份验证](https://docs.equinix.com/zh-Hans/equinix-api/api-authentication.md)。 ### OIDC令牌授权流程[​](#oidc令牌授权流程 "直接链接至OIDC令牌授权流程") 1. 在客户门户网站或Equinix API中[创建OIDC提供商](https://docs.equinix.com/zh-Hans/iam/oidc/create-oidc-provider.md)。 2. 通过使用身份提供商令牌和范围调用端点来申请访问权限`/v1/token`。 1. 您的请求返回的是有效期很短的访问令牌。 有关更多信息,请参阅[OIDC API验证](https://docs.equinix.com/zh-Hans/equinix-api/oidc-api-authentication.md)。 ### 请求流程[​](#请求流程 "直接链接至请求流程") 1. 使用有效的 OAuth 访问令牌授权请求,并向 API 端点发出带有所需授权标头的调用。 ![API请求流示意图,显示调用API网关的客户端,该网关将请求转发到Equinix API并返回响应](https://docs.equinix.com/zh-Hans/assets/images/request-flow-1b070775deacbc1b9dc448520b67aef4.png) 2. API 网关验证请求并调用相关的 Equinix API。 3. API网关已收到响应。 4. 回复已发送给您。 ## 使用 Terraform 进行基础设施即代码[​](#使用-terraform-进行基础设施即代码 "直接链接至使用 Terraform 进行基础设施即代码") 除了REST API,Equinix还提供[Terraform提供程序](https://docs.equinix.com/zh-Hans/terraform.md),允许您使用基础设施作为代码来管理Equinix资源。Terraform提供商打包Equinix API,并提供定义和管理基础设施的声明方式。 Equinix Terraform Provider 支持: * **Equinix Fabric** -虚拟连接,云路由器,STREAMS和Precision Time * **Network Edge** -虚拟网络设备 如需完整的文档,示例和可用资源, 请参阅[Terraform提供商文档](https://docs.equinix.com/zh-Hans/terraform.md)。 ## API 参考资料[​](#api-参考资料 "直接链接至API 参考资料") Equinix API分为分版本功能组。每个功能组都包含一组API端点,允许您执行与该组相关的操作。 API参考以OpenAPI格式提供,其中包括每个端点的详细信息,包括请求和响应格式,所需参数以及请求示例。在Equinix产品文档中,您可以找到与所讨论的产品或服务对应的“API参考”链接。 按功能组查看所有Equinix API参考库,请参阅[API目录](https://docs.equinix.com/zh-Hans/api-catalog)。您还可以使用以下导航树查找指向所有Equinix API参考的链接。每个前导API路径都链接到此视图中对应的API参考。 🔍 Filter APIs by name or path... api.equinix.com ├─ ► [billing](https://docs.equinix.com/zh-Hans/api-catalog/basv2.md "Platform Billing Account APIs") [ (](https://docs.equinix.com/zh-Hans/api-catalog/basv2.md "Platform Billing Account APIs") [Platform Billing Account APIs](https://docs.equinix.com/zh-Hans/api-catalog/basv2.md "Platform Billing Account APIs") [)](https://docs.equinix.com/zh-Hans/api-catalog/basv2.md "Platform Billing Account APIs") ├─ ▼ colocations │ └─ ▼ v2 │ ├─ [connectionServices](https://docs.equinix.com/zh-Hans/api-catalog/lookupv2.md#tag/Lookup/operation/Retrieve%20list%20of%20connection%20services "Lookup") [ (](https://docs.equinix.com/zh-Hans/api-catalog/lookupv2.md#tag/Lookup/operation/Retrieve%20list%20of%20connection%20services "Lookup") [Lookup](https://docs.equinix.com/zh-Hans/api-catalog/lookupv2.md#tag/Lookup/operation/Retrieve%20list%20of%20connection%20services "Lookup") [)](https://docs.equinix.com/zh-Hans/api-catalog/lookupv2.md#tag/Lookup/operation/Retrieve%20list%20of%20connection%20services "Lookup") │ ├─ [locations](https://docs.equinix.com/zh-Hans/api-catalog/lookupv2.md#tag/Lookup/operation/Get%20Locations%20by%20permission%20code "Lookup") [ (](https://docs.equinix.com/zh-Hans/api-catalog/lookupv2.md#tag/Lookup/operation/Get%20Locations%20by%20permission%20code "Lookup") [Lookup](https://docs.equinix.com/zh-Hans/api-catalog/lookupv2.md#tag/Lookup/operation/Get%20Locations%20by%20permission%20code "Lookup") [)](https://docs.equinix.com/zh-Hans/api-catalog/lookupv2.md#tag/Lookup/operation/Get%20Locations%20by%20permission%20code "Lookup") │ ├─ ▼ orders │ │ ├─ ► [{orderId}](https://docs.equinix.com/zh-Hans/api-catalog/ordersv2.md "Orders") [ (](https://docs.equinix.com/zh-Hans/api-catalog/ordersv2.md "Orders") [Orders](https://docs.equinix.com/zh-Hans/api-catalog/ordersv2.md "Orders") [)](https://docs.equinix.com/zh-Hans/api-catalog/ordersv2.md "Orders") │ │ ├─ ► [crossConnects](https://docs.equinix.com/zh-Hans/api-catalog/crossconnectsv2.md "Cross Connect") [ (](https://docs.equinix.com/zh-Hans/api-catalog/crossconnectsv2.md "Cross Connect") [Cross Connect](https://docs.equinix.com/zh-Hans/api-catalog/crossconnectsv2.md "Cross Connect") [)](https://docs.equinix.com/zh-Hans/api-catalog/crossconnectsv2.md "Cross Connect") │ │ ├─ ► [shipments](https://docs.equinix.com/zh-Hans/api-catalog/shipmentsv2.md "Shipments") [ (](https://docs.equinix.com/zh-Hans/api-catalog/shipmentsv2.md "Shipments") [Shipments](https://docs.equinix.com/zh-Hans/api-catalog/shipmentsv2.md "Shipments") [)](https://docs.equinix.com/zh-Hans/api-catalog/shipmentsv2.md "Shipments") │ │ └─ ► [workVisits](https://docs.equinix.com/zh-Hans/api-catalog/workvisitsv2.md "Scheduling Work Visits") [ (](https://docs.equinix.com/zh-Hans/api-catalog/workvisitsv2.md "Scheduling Work Visits") [Scheduling Work Visits](https://docs.equinix.com/zh-Hans/api-catalog/workvisitsv2.md "Scheduling Work Visits") [)](https://docs.equinix.com/zh-Hans/api-catalog/workvisitsv2.md "Scheduling Work Visits") │ ├─ ► [patchPanels](https://docs.equinix.com/zh-Hans/api-catalog/lookupv2.md "Lookup") [ (](https://docs.equinix.com/zh-Hans/api-catalog/lookupv2.md "Lookup") [Lookup](https://docs.equinix.com/zh-Hans/api-catalog/lookupv2.md "Lookup") [)](https://docs.equinix.com/zh-Hans/api-catalog/lookupv2.md "Lookup") │ ├─ [providers](https://docs.equinix.com/zh-Hans/api-catalog/lookupv2.md#tag/Lookup/operation/Retrieve%20list%20of%20providers "Lookup") [ (](https://docs.equinix.com/zh-Hans/api-catalog/lookupv2.md#tag/Lookup/operation/Retrieve%20list%20of%20providers "Lookup") [Lookup](https://docs.equinix.com/zh-Hans/api-catalog/lookupv2.md#tag/Lookup/operation/Retrieve%20list%20of%20providers "Lookup") [)](https://docs.equinix.com/zh-Hans/api-catalog/lookupv2.md#tag/Lookup/operation/Retrieve%20list%20of%20providers "Lookup") │ └─ [supportPlans](https://docs.equinix.com/zh-Hans/api-catalog/supportplansv2.md#tag/Smart-Hands-Support-Plans/operation/Retrieve%20Smart%20Hands%20support%20plans "Smarthands Support Plans") [ (](https://docs.equinix.com/zh-Hans/api-catalog/supportplansv2.md#tag/Smart-Hands-Support-Plans/operation/Retrieve%20Smart%20Hands%20support%20plans "Smarthands Support Plans") [Smarthands Support Plans](https://docs.equinix.com/zh-Hans/api-catalog/supportplansv2.md#tag/Smart-Hands-Support-Plans/operation/Retrieve%20Smart%20Hands%20support%20plans "Smarthands Support Plans") [)](https://docs.equinix.com/zh-Hans/api-catalog/supportplansv2.md#tag/Smart-Hands-Support-Plans/operation/Retrieve%20Smart%20Hands%20support%20plans "Smarthands Support Plans") ├─ ► [dcim](https://docs.equinix.com/zh-Hans/api-catalog/smartviewv2.md "Equinix SmartView APIs") [ (](https://docs.equinix.com/zh-Hans/api-catalog/smartviewv2.md "Equinix SmartView APIs") [Equinix SmartView APIs](https://docs.equinix.com/zh-Hans/api-catalog/smartviewv2.md "Equinix SmartView APIs") [)](https://docs.equinix.com/zh-Hans/api-catalog/smartviewv2.md "Equinix SmartView APIs") ├─ ► [diloa](https://docs.equinix.com/zh-Hans/api-catalog/diloav1.md "Digital LOA API") [ (](https://docs.equinix.com/zh-Hans/api-catalog/diloav1.md "Digital LOA API") [Digital LOA API](https://docs.equinix.com/zh-Hans/api-catalog/diloav1.md "Digital LOA API") [)](https://docs.equinix.com/zh-Hans/api-catalog/diloav1.md "Digital LOA API") ├─ ► [environment](https://docs.equinix.com/zh-Hans/api-catalog/smartviewv2.md "Equinix SmartView APIs") [ (](https://docs.equinix.com/zh-Hans/api-catalog/smartviewv2.md "Equinix SmartView APIs") [Equinix SmartView APIs](https://docs.equinix.com/zh-Hans/api-catalog/smartviewv2.md "Equinix SmartView APIs") [)](https://docs.equinix.com/zh-Hans/api-catalog/smartviewv2.md "Equinix SmartView APIs") ├─ ► [fabric](https://docs.equinix.com/zh-Hans/api-catalog/fabricv4.md "Equinix Fabric API v4") [ (](https://docs.equinix.com/zh-Hans/api-catalog/fabricv4.md "Equinix Fabric API v4") [Equinix Fabric API v4](https://docs.equinix.com/zh-Hans/api-catalog/fabricv4.md "Equinix Fabric API v4") [)](https://docs.equinix.com/zh-Hans/api-catalog/fabricv4.md "Equinix Fabric API v4") ├─ ▼ internetAccess │ ├─ ► [v1](https://docs.equinix.com/zh-Hans/api-catalog/internetaccessv1.md "Equinix Internet Access API") [ (](https://docs.equinix.com/zh-Hans/api-catalog/internetaccessv1.md "Equinix Internet Access API") [Equinix Internet Access API](https://docs.equinix.com/zh-Hans/api-catalog/internetaccessv1.md "Equinix Internet Access API") [)](https://docs.equinix.com/zh-Hans/api-catalog/internetaccessv1.md "Equinix Internet Access API") │ └─ ► [v2](https://docs.equinix.com/zh-Hans/api-catalog/internetaccessv2.md "Equinix Internet Access API") [ (](https://docs.equinix.com/zh-Hans/api-catalog/internetaccessv2.md "Equinix Internet Access API") [Equinix Internet Access API](https://docs.equinix.com/zh-Hans/api-catalog/internetaccessv2.md "Equinix Internet Access API") [)](https://docs.equinix.com/zh-Hans/api-catalog/internetaccessv2.md "Equinix Internet Access API") ├─ ► [ne](https://docs.equinix.com/zh-Hans/api-catalog/networkedgev1.md "Network Edge APIs") [ (](https://docs.equinix.com/zh-Hans/api-catalog/networkedgev1.md "Network Edge APIs") [Network Edge APIs](https://docs.equinix.com/zh-Hans/api-catalog/networkedgev1.md "Network Edge APIs") [)](https://docs.equinix.com/zh-Hans/api-catalog/networkedgev1.md "Network Edge APIs") ├─ ► [notifications](https://docs.equinix.com/zh-Hans/api-catalog/unifiednotificationv2.md "Notifications API") [ (](https://docs.equinix.com/zh-Hans/api-catalog/unifiednotificationv2.md "Notifications API") [Notifications API](https://docs.equinix.com/zh-Hans/api-catalog/unifiednotificationv2.md "Notifications API") [)](https://docs.equinix.com/zh-Hans/api-catalog/unifiednotificationv2.md "Notifications API") ├─ ► [oauth2](https://docs.equinix.com/zh-Hans/api-catalog/accesstokenv1.md "Equinix API Authentication") [ (](https://docs.equinix.com/zh-Hans/api-catalog/accesstokenv1.md "Equinix API Authentication") [Equinix API Authentication](https://docs.equinix.com/zh-Hans/api-catalog/accesstokenv1.md "Equinix API Authentication") [)](https://docs.equinix.com/zh-Hans/api-catalog/accesstokenv1.md "Equinix API Authentication") ├─ ► [power](https://docs.equinix.com/zh-Hans/api-catalog/smartviewv2.md "Equinix SmartView APIs") [ (](https://docs.equinix.com/zh-Hans/api-catalog/smartviewv2.md "Equinix SmartView APIs") [Equinix SmartView APIs](https://docs.equinix.com/zh-Hans/api-catalog/smartviewv2.md "Equinix SmartView APIs") [)](https://docs.equinix.com/zh-Hans/api-catalog/smartviewv2.md "Equinix SmartView APIs") ├─ ► [resourceManager](https://docs.equinix.com/zh-Hans/api-catalog/getprojectsv2.md "Project APIs") [ (](https://docs.equinix.com/zh-Hans/api-catalog/getprojectsv2.md "Project APIs") [Project APIs](https://docs.equinix.com/zh-Hans/api-catalog/getprojectsv2.md "Project APIs") [)](https://docs.equinix.com/zh-Hans/api-catalog/getprojectsv2.md "Project APIs") ├─ ► [securecabinet](https://docs.equinix.com/zh-Hans/api-catalog/securecabinetv1.md "Secure Cabinet API") [ (](https://docs.equinix.com/zh-Hans/api-catalog/securecabinetv1.md "Secure Cabinet API") [Secure Cabinet API](https://docs.equinix.com/zh-Hans/api-catalog/securecabinetv1.md "Secure Cabinet API") [)](https://docs.equinix.com/zh-Hans/api-catalog/securecabinetv1.md "Secure Cabinet API") ├─ ► [smartview](https://docs.equinix.com/zh-Hans/api-catalog/smartviewv2.md "Equinix SmartView APIs") [ (](https://docs.equinix.com/zh-Hans/api-catalog/smartviewv2.md "Equinix SmartView APIs") [Equinix SmartView APIs](https://docs.equinix.com/zh-Hans/api-catalog/smartviewv2.md "Equinix SmartView APIs") [)](https://docs.equinix.com/zh-Hans/api-catalog/smartviewv2.md "Equinix SmartView APIs") ├─ ► [support](https://docs.equinix.com/zh-Hans/api-catalog/supportv2.md "Case Management API") [ (](https://docs.equinix.com/zh-Hans/api-catalog/supportv2.md "Case Management API") [Case Management API](https://docs.equinix.com/zh-Hans/api-catalog/supportv2.md "Case Management API") [)](https://docs.equinix.com/zh-Hans/api-catalog/supportv2.md "Case Management API") └─ ▼ v2 ├─ ► [invoices](https://docs.equinix.com/zh-Hans/api-catalog/billingv2.md "Billing APIs") [ (](https://docs.equinix.com/zh-Hans/api-catalog/billingv2.md "Billing APIs") [Billing APIs](https://docs.equinix.com/zh-Hans/api-catalog/billingv2.md "Billing APIs") [)](https://docs.equinix.com/zh-Hans/api-catalog/billingv2.md "Billing APIs") ├─ ► [quotes](https://docs.equinix.com/zh-Hans/api-catalog/quotesv2.md "Quote APIs") [ (](https://docs.equinix.com/zh-Hans/api-catalog/quotesv2.md "Quote APIs") [Quote APIs](https://docs.equinix.com/zh-Hans/api-catalog/quotesv2.md "Quote APIs") [)](https://docs.equinix.com/zh-Hans/api-catalog/quotesv2.md "Quote APIs") └─ ► [tickets](https://docs.equinix.com/zh-Hans/api-catalog/ticketsv2.md "Tickets") [ (](https://docs.equinix.com/zh-Hans/api-catalog/ticketsv2.md "Tickets") [Tickets](https://docs.equinix.com/zh-Hans/api-catalog/ticketsv2.md "Tickets") [)](https://docs.equinix.com/zh-Hans/api-catalog/ticketsv2.md "Tickets")