OVHcloud APIからデータを収集する#

#目的

OVHcloud API は、RESTful APIであり、プログラムによるアクセスを提供することで、OVHcloudのすべての製品とサービスを自動化して管理することができます。このAPIを使用すると、OVHコントロールパネルを通じてサービスを管理するのと同じように簡単に管理できます。

#API概要

OVHcloud APIはRESTの原則に従っています：

• 標準的なHTTPメソッド（GET、POST、PUT、DELETE）を使用します
• リソースは一意のURLでアクセスされます
• ステートレスです - 各リクエストには必要なすべての情報が含まれています

#ソースの設定

OVHcloud APIソースを設定するには、次の情報を提供する必要があります：

#API接続詳細

OVHリージョン：OVHリージョン（ヨーロッパ、米国、カナダ）を選択します アプリケーションキー：OVH APIアプリケーションキー アプリケーションシークレット：アプリケーションに関連付けられたシークレット コンサマーキー：認証用のコンサマーキー

認証情報を取得するには：

1. OVHcloudトークン生成ページにアクセスします
2. OVHアカウントでサインインします
3. アプリケーション名と説明を入力します
4. 有効期間を設定します
5. 必要なアクセス権を定義します

#認証設定

OVH APIは3キー認証システムを使用します：

1. アプリケーションキー（AK）：

   • アプリケーションを識別します
   • パブリック識別子です
   • アプリケーションを登録するときに生成されます

2. アプリケーションシークレット：

   • リクエストに署名するために使用されるプライベートキーです
   • 安全に保管する必要があります
   • API呼び出しで送信しないでください

3. コンサマーキー（CK）：

   • OAuthトークンに似ています
   • アプリケーションの権限を定義します
   • アプリケーションキー/シークレットを変更せずに取り消すことができます

すべての詳細を入力したら、接続をクリックしてコネクタを正常に設定します。

#データを読み込むためのエンドポイントを指定する

認証を設定した後、接続したいエンドポイントを設定する必要があります。各エンドポイントは、別々のテーブルに読み込むことができるデータソースオブジェクトに対応します。

#シングルエンドポイント設定

エンドポイントを設定するには、次の情報を指定する必要があります：

1. 基本設定：
   • 技術名：エンドポイントの一意の名前を入力します
   • メソッド：HTTPメソッド（GET、POSTなど）を選択します
   • エンドポイント：コネクタ設定時に選択したリージョンに基づいて、ベースエンドポイントが自動的に設定されます（例：ヨーロッパの場合はovh-eu）
   • パス：特定のAPIパス（例：/me/bill）

2. パラメータタイプ：
   • パスパラメータ：パスに含めると、パスパラメータが自動的にリストに追加されます。例えば、パスに/me/bill/{billId}を入力すると、billIdが自動的にパラメータとして追加され、その値を割り当てることができます。

• クエリ文字列パラメータ：リクエストをフィルタリングまたはカスタマイズするためにクエリパラメータを追加します。例えば：Key:date.from - Value:2024で、2024年の請求書をフィルタリングします。

• JSONパス：JSONをフィルタリングまたはドリルダウンして、必要なフィールドのみをキャプチャすることができます。 例えば：

  1. 税込価格のみを取得する簡単なJSONパス

{
   "path": "$.priceWithTax[*]"
}

2. 正確に必要なフィールドを指定できるより複雑なもの。

{
   "path": "$.[*]",
   "fields":  [
      "category",
      "date",
      "priceWithTax.Value",
      "priceWithoutTax.Value"
   ]
}

3. 例：事前定義されたエンドポイント設定を表示して使用します。
   • 任意の例をクリックすると、関連するすべてのフィールドが自動的に入力されます。'リセット'ボタンをクリックして、入力された例をクリアします。
   • 利用可能な例には以下が含まれます：
     • GET - /me/bill/{billId}
     • GET - /me/bill/{billId}/details
     • POST - /me/document
     • GET - /allDom/{serviceName}/domain

#複数エンドポイント設定

複数エンドポイント機能は、エンドポイントURLにパスパラメータを含めると自動的にトリガーされます（例：パスに"{billId}"を追加する場合）。この機能により、同じパラメータを使用して複数のエンドポイントから関連データを取得できます。

トリガーされた場合：

1. インターフェースはMULTIPLE ENDPOINTタブを表示するように切り替わります
2. 以前に設定したエンドポイントを選択できます
3. エンドポイント間のパスパラメータをマッピングできます

#ベストプラクティス

1. 例の使用：

   • EXAMPLESタブをブラウズして一般的なエンドポイントパターンを確認します
   • 例をクリックしてすべてのフィールドを自動的に入力します
   • 必要に応じて事前入力された値を変更します

2. パスパラメータ：

   • パラメータに波カッコ{}を追加すると（例：{billId}）、複数エンドポイント機能が自動的に有効になります
   • 関連するエンドポイント間でパラメータ名が一致することを確認します
   • パラメータを確定する前にサンプル値でテストします

3. 技術名：

   • ソースオブジェクトには明確で説明的な名前を選択します
   • 関連する識別子を含めます（例：年、サービスタイプ）
   • 技術名に特殊文字を使用しないでください

#API使用ガイドライン

1. セキュリティ：

   • アプリケーションシークレットを共有しないでください
   • 定期的に認証情報をローテーションします
   • 使用ケースに必要な最小限の権限を使用します
   • 認証情報を安全に保管します
   • すべてのAPI呼び出しでHTTPSを使用します

2. レート制限：

   • グローバル制限：1秒あたり20回の呼び出し
   • 特定のエンドポイントにはAPIごとの制限が適用される場合があります
   • 再試行には指数バックオフを実装します
   • OVHのコンソールを通じてAPI使用量を監視します

3. エラーハンドリング：

   • 400：リクエストが無効です - リクエストパラメータを確認します
   • 403：認証されていません - 認証情報と権限を確認します
   • 404：見つかりません - リソースが存在することを確認します
   • 429：リクエストが多すぎます - レート制限を実装します
   • 500：内部サーバーエラー - OVHサポートに連絡します

#OVH API Console

OVHcloud API Console は、コードを記述せずに OVHcloud API エンドポイントを探索してテストできるインタラクティブな Web ベースのインターフェースです。API コールを実行し、応答を検査し、リクエストをデバッグするためのユーザーフレンドリーな方法を提供します。

#主な機能:

• API エンドポイントを閲覧: 利用可能な OVHcloud API サービスとそのパラメータを表示します。
• API コールを実行: コンソールから直接 GET、POST、PUT、DELETE リクエストをテストします。
• アカウントで認証: アプリケーション キー、アプリケーション シークレット、コンシューマ キー を使用して認証されたリクエストを実行します。
• API 応答を検査: JSON 応答、HTTP ステータスコード、リクエスト詳細を表示します。
• API リクエストを生成: アプリケーションへの統合用に事前構築された API リクエスト形式をコピーします。

#API Console の使用方法:

1. コンソールにアクセス: OVHcloud API Console にアクセスします。
2. API エンドポイントを選択: API カテゴリを閲覧するか、特定の関数を検索します。
3. 認証:
   • 右上隅の Authenticate をクリックします。
   • アプリケーション キー を入力し、必要に応じて コンシューマ キー を生成します。
4. リクエスト パラメータを設定: パスやクエリ パラメータなどの必要なフィールドを入力します。
5. リクエストを実行: Run をクリックしてリクエストを送信し、応答を表示します。
6. 応答を確認: 返されたデータ、エラーメッセージ、応答ヘッダーを検査します。

#さらに詳しく

当社のソリューションを実装するためのトレーニングや技術サポートが必要な場合は、営業担当者にお問い合わせください、または このリンク をクリックして見積もりを依頼し、当社の Professional Services 専門家にプロジェクトのカスタム分析を依頼してください。

Data Platform を構築するチームと直接やり取りし、質問をしたり、フィードバックを送信したり、Discord チャンネルに参加したりするには、専用の Discord チャンネル にアクセスしてください。

OVHcloud サービスについてサポートが必要な場合は、Help Centre でリクエストを作成してください。

ユーザーコミュニティ に参加してください。