エクイニクスAPI
Equinix™ provides a RESTful HTTP API which can be reached at https://api.equinix.com/. This document describes the API and how to use it.
APIを利用すると、プロジェクト、デバイス、接続、注文、コロケーション展開、サポートチケット、Identity & Access Managementなど、エクイニクスのリソースとプログラムでやり取りできます。
Equinix APIの使用方法
APIの使用は、認可フローとリクエストフローに分けることができます。
API経由でエクイニクスの製品を利用するには、以下の手順が必要です：
- エクイニクスカスタマーポータルアカウントまたはOIDCプロバイダ（ECP）。
- 製品固有の作成、変更、削除権限。
ユーザー認証フロー
-
カスタマーポータルでアプリケーションの登録と認証を行います。
-
Request access and refresh token information by calling the
/oauth2/v1/tokenwith the Consumer key, Consumer secret, and your user credentials.
-
リクエストは、短命の OAuth アクセストークンと関連するリフレッシュトークンを返します。
より詳細な情報と手順については、API 認証 を参照してください。
OIDCトークン認証フロー
-
Create an OIDC Provider in either the Customer Portal or the Equinix API.
-
Request access by calling the
/v1/tokenendpoint with your identity provider token and scope.
- リクエストは短命のアクセストークンを返します。
For more information, see OIDC API Authentication.
リクエストの流れ
-
有効な OAuth アクセストークンを使用してリクエストを認可し、必要な認可ヘッダーを使用して API エンドポイントを呼び出します。
-
APIゲートウェイはリクエストを検証し、関連するEquinix APIを呼び出します。
-
API ゲートウェイによってレスポンスが受信されます。
-
応答が送信されます。
Terraformによるインフラストラクチャ as Code
エクイニクスは、REST APIに加えて、インフラストラクチャをコード化してエクイニクスのリソースを管理できるTerraformプロバイダも提供しています。Terraformプロバイダは、エクイニクスのAPIをラップし、お客様のインフラストラクチャを定義・管理するための宣言的な方法を提供します。
Equinix Terraformプロバイダは以下の機能をサポートしています：
- Equinix Metal - ベアメタルサーバー、ネットワーク、インフラストラクチャ
- Equinix Fabric - 仮想接続、クラウドルーター、ストリーム、Precision Time
- Network Edge - 仮想ネットワークデバイス
完全なドキュメント、例、利用可能なリソースについては、Terraformプロバイダドキュメントを参照してください。
APIリファレンス
エクイニクスのAPIは、バージョン別の機能グループに分かれています。各機能グループには、そのグループに関連する操作を実行するためのAPIエンドポイントが含まれています。
APIリファレンスはOpenAPI形式で提供されており、リクエストとレスポンスのフォーマット、必要なパラメータ、リクエスト例など、各エンドポイントの詳細情報が含まれています。エクイニクスの製品ドキュメントには、各製品やサービスに対応する「APIリファレンス」へのリンクが含まれています。
エクイニクスの全APIリファレンスを機能グループ別にまとめたライブラリを参照するには、APIカタログをご覧ください。また、以下のナビゲーションツリーを使用して、すべてのAPIリファレンスへのリンクを見つけることもできます。このビューでは、すべてのAPIパスが対応するAPIリファレンスにリンクされています。