移動

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

スクリプト所有者が指定されたグループ化データに対するPython関数の実行

post

/api/py-scripts/v1/group-apply/{scriptName}/{ownerName}

スクリプト所有者が指定された列値でグループ化されたデータに対してPython関数を実行します。

リクエスト

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

• application/json

パス・パラメータ

• ownerName: string
  Pythonスクリプトの所有者
• scriptName: string
  Pythonスクリプトの名前

本文()

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

ルート・スキーマ: EmbedScriptComputeGrp

型: object

ソースの表示

• asyncFlag(optional): boolean
  ジョブを非同期で実行するかどうか。
• envName(optional): string
  conda環境の名前。
• graphicsFlag(optional): boolean
  スクリプトでレンダリングされたイメージを結果に取得するかどうか。
• groupBy: string
  グループ化する列。列のリストを設定するには、カンマ区切りリストを指定します。
• input: string
  入力データを指定する問合せ文。
• orderBy(optional): string
  順序付けする列。列のリストを設定するには、カンマ区切りリストを指定します。
• parallel(optional): integer(int32)
  並列度。
• parallelFlag(optional): boolean
  ジョブをパラレルに実行するかどうか。
• parameters(optional): string
  スクリプトに渡されるキーワード引数を指定する(名前 - 値)ペアのJSON文字列。
• service(optional): string
  指定可能な値: [ "LOW", "MEDIUM", "HIGH" ]

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

  最大値: 43200

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

{
    "type":"object",
    "required":[
        "groupBy",
        "input"
    ],
    "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."
        },
        "input":{
            "type":"string",
            "description":"Query statement specifying input data."
        },
        "groupBy":{
            "type":"string",
            "description":"Columns to group by. To set a list of columns, provide a comma-separated list."
        },
        "orderBy":{
            "type":"string",
            "description":"Columns to order by. To set a list of columns, provide a comma-separated list."
        },
        "parallelFlag":{
            "type":"boolean",
            "description":"Whether to execute job in parallelism."
        },
        "parallel":{
            "type":"integer",
            "format":"int32",
            "description":"Degree of parallel."
        }
    }
}

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

{"input":"select * from GRADE", "groupBy":"GENDER", "orderBy":"GENDER, STATUS", "parameters":"{\"oml_input_type\":\"default\"}", "parallelFlag":true, "asyncFlag":true, "timeout":3600}

先頭に戻る

レスポンス

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

• 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"
        }
    }
}

先頭に戻る

例

次の例では、group_countというスクリプトを実行し、スクリプト所有者を指定します。

curl -i -X POST --header "Authorization: Bearer ${token}" \
--header 'Content-Type: application/json' --header 'Accept: application/json' \
-d '{"input":"select * from IRIS", "parameters":"{\"oml_input_type\":\"pandas.DataFrame\"}", "groupBy":"Species", "orderBy":"Sepal_Length"}' \
"<oml-cloud-service-location-url>/oml/api/py-scripts/v1/group-apply/group_count/<owner_name>"

レスポンス・ヘッダー

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

HTTP/1.1 200 OK
Date: Mon, 17 Aug 2020 21:06:54 GMT
Content-Type: application/json
Content-Length: 5045
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=node0bucgs4gt7hci1gxvgtqc1hjdv647.node0; Path=/oml; Secure; HttpOnly
Expires: Thu, 01 Jan 1970 00:00:00 GMT

レスポンス本文

JSON形式のレスポンス本文の一部を次に示します。

{"result":{"versicolor_8":{"SEPAL_LENGTH":{"0":5.7},"SPECIES":{"0":"versicolor"},"COUNT":{"0":5}},
"versicolor_7":{"SEPAL_LENGTH":{"0":5.6},"SPECIES":{"0":"versicolor"},"COUNT":{"0":2}},...}

先頭に戻る