エクイニクスAPI
Equinix™ はRESTful HTTP APIを提供しています。このドキュメントでは、APIとその使用方法について説明します。
APIを利用すると、プロジェクト、デバイス、接続、注文、コロケーション展開、サポートチケット、Identity & Access Managementなど、エクイニクスのリソースとプログラムでやり取りできます。
エクイニクスAPIの利用
APIの使用は、認可フローとリクエストフローに分けることができます。
APIを介したエクイニクス製品とのやり取りには、以下の手順が必要です：
- エクイニクスカスタマーポータルアカウントまたはOIDCプロバイダ（ECP）。
- 製品固有の作成、変更、削除権限。
ユーザー認証フロー
-
カスタマーポータルでアプリケーションを登録し、認証する。
-
コンシューマー キー、コンシューマー シークレット、およびユーザー認証情報を使用して
/oauth2/v1/tokenを呼び出すことで、アクセスおよびトークン情報の更新を要求します。
-
リクエストは、短命の OAuth アクセストークンと関連するリフレッシュトークンを返します。
より詳細な情報と手順については、API 認証 を参照してください。
OIDCトークン認証フロー
-
Create an OIDC Provider in either the Customer Portal or the Equinix API.
-
ID プロバイダのトークンとスコープを使用して
/v1/tokenエンドポイントを呼び出してアクセスを要求します。
- リクエストは短命のアクセストークンを返します。
詳細については、OIDC API 認証 を参照してください。
リクエストの流れ
-
有効なOAuthアクセストークンを使用してリクエストを認可し、必要な認可ヘッダーを持つAPIエンドポイントを呼び出します。
-
APIゲートウェイはリクエストを検証し、関連するエクイニクス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リファレンスにリンクされています。