1. Embedded Python ExecutionのREST API
  2. タスク
  3. スクリプトの実行

Python関数の実行

post

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

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

リクエスト

パス・パラメータ
先頭に戻る

レスポンス

200レスポンス

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

201レスポンス

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

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/py-scripts/v1/do-eval/RandomRedDots"

レスポンス・ヘッダー

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

HTTP/1.1 200 OK
Date: Wed, 26 Aug 2020 20:48:58 GMT
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
Cache-Control: no-cache, no-store, private
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1;mode=block
Strict-Transport-Security: max-age=31536000; includeSubDomains
X-Content-Type-Options: nosniff
Set-Cookie: JSESSIONID=node01p78shsm2h9binj7jxzaipn0s652.node0; Path=/oml; Secure; HttpOnly
Expires: Thu, 01 Jan 1970 00:00:00 GMT

レスポンス本文

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

{"result":[{"IMAGE":"iVBORw0KG...AAAAASUVORK5CYII=","DATA":"[{\"id\":1,\"val\":0.01},...,{\"id\":9,\"val\":0.09}]","ID":1}]}

例2

次の例では、test_seaborn_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": "seaborn", "graphicsFlag": true}' 
"<oml-cloud-service-locationurl>/oml/api/py-scripts/v1/do-eval/test_seaborn_noinp"

レスポンス本文

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

{
  "result": [
    {
      "IMAGE": "iVBORw0KGgoAAAAN......CAAAAAElFTkSuQmCC",
      "DATA": "\"hello world\"",
      "TITLE": "Dist plot",
      "ID": 1
    }
  ]
}
先頭に戻る