移動先

• リクエスト
• レスポンス
• 例

R関数の実行

POST

/r-scripts/v1/do-eval/{scriptName}

ユーザー所有のR関数を実行します。

リクエスト

パス・パラメータ

• scriptName(必須):
  Rスクリプトの名前。

先頭に戻る

レスポンス

200レスポンス

デフォルトでは、ジョブの結果を返します。

201レスポンス

asyncFlag=trueの場合、ジョブのステータスをフェッチできるロケーション・ヘッダーを返します。

ヘッダー

• Location:

400レスポンス

無効なパラメータが指定され、出力がサイズ制限を超えているか、他のスクリプト実行エラーが発生しました。

500レスポンス

ブローカへの接続中、ジョブの実行中に問題が発生したか、または他の予期しないエラーが発生しました。

先頭に戻る

例

例1

次の例では、RandomRedDotsというスクリプトを実行します。PNGイメージ、および関数からのデータをJSON形式で戻すには、graphicsFlagパラメータをtrueに設定します。

curl -i -X POST --header "Authorization: Bearer ${token}" \
--header 'Content-Type: application/json' --header 'Accept: application/json' \
-d '{"graphicsFlag":true, "service":"LOW"}' \
"<oml-cloud-service-location-url>/oml/api/r-scripts/v1/do-eval/RandomRedDots"

レスポンス・ヘッダー

レスポンス・ヘッダーは次のとおりです。

HTTP/1.1 200 OK
Date: Thu, 28 Jul 2022 21:04:18 GMT
Content-Type: application/json
Content-Length: 1820
Connection: keep-alive
Cache-Control: no-cache, no-store, must-revalidate                                                                          
Pragma: no-cache
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1;mode=block                                                                                                                                                                 
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-Content-Type-Options: nosniff
Content-Security-Policy: frame-ancestors 'none'

レスポンス本文

RESTエンドポイントの結果は、イメージおよびデータを含むRスクリプトから返される値のJSON表現です。イメージ・バイトはPNG形式で返されます。戻り値の一部は次のとおりです。

{"result":[{"IMAGE":"iVBORw0KGgoAAAANSUhEUg......Fug8AAAAASUVORK5CYII=","DATA":[{
"val":0.01,"id":1},{"val":0.02,"id":2},{"val":0.03,"id":3},{"val":0.04,"id":4
},{"val":0.05,"id":5},{"val":0.06,"id":6},{"val":0.07,"id":7},{"val":0.08,"id
":8},{"val":0.09,"id":9},{"val":0.1,"id":10}],"ID":1}]}

例2

次の例では、test_ggplot2_noinpというスクリプトを実行します。PNGイメージ、および関数からのデータをJSON形式で戻すには、graphicsFlagパラメータをtrueに設定します。

curl -i -k -X POST --header "Authorization: Bearer ${token}" --header
'Content-Type: application/json' --header 'Accept: application/json' -d
'{"envName": "myrenv", "graphicsFlag": true}' 
"<oml-cloud-service-locationurl>/oml/api/r-scripts/v1/do-eval/test_ggplot2_noinp"

レスポンス本文

RESTエンドポイントの結果は、イメージおよびデータを含むRスクリプトから返される値のJSON表現です。イメージ・バイトはPNG形式で返されます。

{
  "result": [
    {
      "IMAGE": "iVBORw0KGgoAAAANSUhE......AAAABJRU5ErkJggg==",
      "DATA": "\"hello world\"",
      "ID": 1
    }
  ]
}

先頭に戻る