API作成画面

作成済の予測モデルについて「API作成タブ」をクリックすると、この画面に遷移します。 APIの仕様は「予測APIの仕様」をご覧ください。

予測APIを作成する

ステップ1. 予測APIを作成したいモデルを選択した状態で「API作成タブ」をクリックしてこの画面に遷移します。

ステップ2. 「起動ボタン」をクリックします。

ステップ3. 「API作成を開始」のウィンドウでAPIタイプを選択し、「開始ボタン」をクリックします。

  • API作成:正式版のAPIを作成します。APIオプションを購入すると利用できます。購入したAPIオプションの数だけAPIを作成することができます。体験版では本タイプは選択できません。
  • トライアルAPI作成:トライアル用のAPIを作成します。作成したAPIは100リクエストまで利用できます。

ステップ4. API構築中の画面になります。構築には5~20分程度かかります。構築完了後に予測APIが利用可能になります。

APIが作成されると以下の画面が表示されます。

予測APIの情報を確認する

「API情報」を確認します。

  • APIタイプ:正式版かトライアル版かが表示されます
  • モデルID:モデルのIDです
  • API ID:APIのIDです
  • API URL:APIのエンドポイントのURLです
  • API Key:API Keyです
  • IPホワイトリスト:IPアドレスのホワイトリストです。ホワイトリストに登録されたIPアドレスのみからこのAPIを利用できます。すべてのIPアドレスを許可する場合は、0.0.0.0/0を指定してください。
  • 作成日時:APIを作成した日時です

予測APIのリクエスト数を確認する

「APIリクエスト数」を確認します。リクエスト数が日ごとにカウントされ、グラフとして表示されます。

  • ステータス200:エラーではなかったリクエスト数です。
  • ステータス4xx, 5xx:エラーとなったリクエスト数です。 4XX はクライアントエラー、5XX はサーバーエラーですが、合計数が表示されます。

予測APIのステータスを確認する

「APIステータス」を確認します。

  • 構築中:APIを構築中です
  • 更新中:APIを更新中です
  • 動作中:APIが動作中です。APIへのリクエストを処理できる状態です。
  • 停止済:APIを停止中です。APIへのリクエストを処理できない状態です。
  • 削除中:APIを削除中です。

予測APIのIPホワイトリストを設定する

ステップ1. 「IPホワイトリスト設定ボタン」をクリックします。

ステップ2. 表示されるウィンドウのテキストボックスで、ホワイトリストとして許可したいIPアドレスを入力します。CIDR形式で入力してください。

ステップ3. 「追加」ボタンをクリックします。

IPホワイトリストからIPを削除したい場合は、該当のIPアドレスの右の「削除」ボタンをクリックします。

予測APIを停止する

「停止ボタン」をクリックします。

予測APIを削除する

予測APIが停止されている状態で「削除ボタン」をクリックします。APIを削除するとAPIオプションの利用数がひとつ減り、他のモデルでAPI作成ができるようになります。

予測APIをロックする

「APIロックボタン」をクリックします。APIがロックされ停止ができなくなります。誤操作による停止を防止する機能です。

予測APIのロックを解除する

APIがロックされている状態で「APIロックボタン」をクリックします。管理者ロールのアカウントしか実行できません。 管理者ロールの設定はユーザポータルで行います。