移動

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

Python関数の実行

post

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

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

リクエスト

サポートされているメディア・タイプ

• application/json

パス・パラメータ

• scriptName: string
  Pythonスクリプトの名前

本文()

リクエストの引数とスクリプトの追加引数を指定する(名前 - 値)ペアのJSON文字列

ルート・スキーマ: EmbedScriptCompute

型: object

ソースの表示

• asyncFlag(optional): boolean
  ジョブを非同期で実行するかどうか。
• envName(optional): string
  conda環境の名前。
• graphicsFlag(optional): boolean
  スクリプトでレンダリングされたイメージを結果に取得するかどうか。
• parameters(optional): string
  スクリプトに渡されるキーワード引数を指定する(名前 - 値)ペアのJSON文字列。
• service(optional): string
  指定可能な値: [ "LOW", "MEDIUM", "HIGH" ]

  サービスのLEVEL。デフォルトはLOWです。
• timeout (オプション): integer(int32)
  最小値: 1800

  最大値: 43200

  非同期ジョブのタイムアウト制限(秒単位、デフォルトは1800秒)。`asyncFlag`=trueとともに使用する必要があります。

{
    "type":"object",
    "properties":{
        "parameters":{
            "type":"string",
            "description":"A JSON str of (name - value) pairs specifying keyword arguments to be passed into the script."
        },
        "graphicsFlag":{
            "type":"boolean",
            "description":"Whether to capture images rendered in the script to the result."
        },
        "asyncFlag":{
            "type":"boolean",
            "description":"Whether to execute the job asynchronously."
        },
        "timeout":{
            "type":"integer",
            "format":"int32",
            "description":"The timeout limit (in seconds, default 1800s) of asynchronous job. Must be used together with `asyncFlag`=true.",
            "minimum":1800,
            "maximum":43200
        },
        "service":{
            "type":"string",
            "description":"LEVEL of the service. Default is LOW.",
            "enum":[
                "LOW",
                "MEDIUM",
                "HIGH"
            ]
        },
        "envName":{
            "type":"string",
            "description":"Name of the conda environment."
        }
    }
}

リクエストの例(application/json)

{"parameters":"{\"ds_name\":\"ds_pydata\"}", "asyncFlag":true, "graphicsFlag":true}

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

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

本文()

ルート・スキーマ: JSONObject

型: object

ソースの表示

• empty(optional): boolean

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    }
}

201レスポンス

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

ヘッダー

• Location: string(uri)

400レスポンス

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

本文()

ルート・スキーマ: InvalidParameterValueException

型: object

ソースの表示

• errorCode: integer(int64)
• errorMessage(optional): string
• parameterName(optional): string
• parameterValue(optional): string

{
    "type":"object",
    "required":[
        "debug",
        "errorCode"
    ],
    "properties":{
        "errorMessage":{
            "type":"string"
        },
        "errorCode":{
            "type":"integer",
            "format":"int64"
        },
        "parameterName":{
            "type":"string"
        },
        "parameterValue":{
            "type":"string"
        }
    }
}

500レスポンス

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

本文()

ルート・スキーマ: ComputeContainerException

型: object

ソースの表示

• errorCode: integer(int64)
• errorMessage(optional): string

{
    "type":"object",
    "required":[
        "debug",
        "errorCode"
    ],
    "properties":{
        "errorMessage":{
            "type":"string"
        },
        "errorCode":{
            "type":"integer",
            "format":"int64"
        }
    }
}

先頭に戻る

例

例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
    }
  ]
}

先頭に戻る