REST API

新バージョンのRapidMiner AI Hubでは、プログラムで管理するためにREST APIを提供しています。APIを利用するには、JSON Web Token(JWT)による認証と承認が必要です。

JWTの作成

以下のRapidMiner AI Hub RESTエンドポイントを使用してJWTを作成します。


[GET] $RMServerHost/api/rest/tokenservice

$RMServerHostは、RapidMiner AI Hub インスタンスのIPアドレスまたはホスト名です。リクエストはBasic Authで認証する必要があり、そのためにRapidMiner AI Hubの認証情報を使用します。リクエストが正常に実行された場合、以下のレスポンスボディを取得します。


{ 
    "idToken": "",
    "expirationDate": ""
}

idTokenの値を使用してリクエストを認証します。expirationDateはJWTの有効期間を示し、デフォルトは5分です。トークンの有効期限が切れたら、上記の手順を繰り返して新しいトークンを作成する必要があります。そうしなければ、401 (unauthorized)が返ってくるでしょう。

cURL Sample Request


curl -u username:password $RMServerHost/api/rest/tokenservice

$RMServerHostはRapidMiner AI Hubインスタンスのアドレスです
usernameは使用するユーザーの名前です
passwordはユーザーのパスワードです

RapidMiner AI Hub API

RapidMiner AI HubのREST APIドキュメントはOpenApi 3.0の仕様で利用可能で、SwaggerHubで公開されています。

APIへの更なるリクエストには、以下が必要です。

リクエストのHTTPメソッド (GET、POST、PUT、PATCH、DELETE)
content-type ヘッダー属性
トークンサービスのidTokenを含み、Bearerを先頭にした認証ヘッダー属性 (例：Authorization: Bearer <tokenContent>)
RapidMiner AI HubのURL
リクエストしたいルート

すべてのキューを取得するためのcURLサンプルリクエスト


curl -H "Content-Type: application/json" -H "Authorization: Bearer $idToken" $RMServerHost/executions/queues