CreatePipelineRun を使用してパイプラインジョブを作成 - Platform for AI (PAI)

パイプラインジョブを作成します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

paiflow:CreatePipelineRun

create

*All Resource

*

なし

リクエスト構文

POST /api/v1/pipelineruns HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
body	object	任意	パイプラインジョブ。
PipelineId	string	任意	パイプライン ID。PipelineId または PipelineManifest を設定する必要があります。	flow-rer7y***
Name	string	任意	パイプラインジョブの名前。このパラメーターを空のままにすると、システムが自動的に名前を生成します。	testName
PipelineManifest	string	任意	パイプライン定義。詳細については、パイプライン定義のサンプルをご参照ください。PipelineId または PipelineManifest を設定する必要があります。	apiVersion: "core/v1"\nmetadata:\n provider: "1557702098******"\n version: "v1"\n identifier: "my_pipeline"\n name: "source-transform"\nspec:\n inputs:\n parameters:\n - name: "execution_maxcompute"\n type: "Map"\n pipelines:\n - apiVersion: "core/v1"\n metadata:\n provider: "pai"\n version: "v1"\n identifier: "data_source"\n name: "data_source"\n displayName: "读数据表-1"\n spec:\n arguments:\n parameters:\n - name: "inputTableName"\n value: "pai_online_project.wumai_data"\n - name: "partition"\n value: "20220101"\n - name: "execution"\n from: "{{inputs.parameters.execution_maxcompute}}"\n - apiVersion: "core/v1"\n metadata:\n provider: "pai"\n version: "v1"\n identifier: "type_transform"\n name: "type_transform"\n displayName: "类型转换-1"\n spec:\n arguments:\n artifacts:\n - name: "inputTable"\n from: "{{pipelines.data_source.outputs.artifacts.outputTable}}"\n parameters:\n - name: "cols_to_double"\n value: "time,hour,pm2,pm10,so2,co,no2"\n - name: "execution"\n from: "{{inputs.parameters.execution_maxcompute}}"\n dependencies:\n - "data_source"
Arguments	string	任意	パラメーター。	arguments: parameters: - name: "execution_maxcompute" value: endpoint: "http://service*" odpsProject: "pai*"
NoConfirmRequired	boolean	任意	パイプラインジョブを開始するかどうかを指定します。有効な値： true (デフォルト)：パイプラインジョブを開始します。 false：パイプラインジョブを作成しますが、開始はしません。	true
WorkspaceId	string	必須	ワークスペース ID。	84***
SourceType	string	任意	パイプラインジョブソースのタイプ。有効な値： UNKNOWN (デフォルト) SDK DESIGNER M6	UNKNOWN
SourceId	string	任意	ソース ID。	experiment-ybpy***
Options	string	任意	パイプラインジョブの作成に使用されるオプション。JSON フォーマットです。	{"mlflow":{"experimentId":"exp-1jdk***"}}
Accessibility	string	任意	パイプラインのアクセシビリティ。 PUBLIC (デフォルト) PRIVATE	PUBLIC

パイプライン定義のサンプル：このパイプラインは、読み取りテーブルノード data_source とデータ型変換ノード type_transform で構成されています。

apiVersion: "core/v1"
metadata:
  provider: "1557702098******"
  version: "v1"
  identifier: "my_pipeline"
  name: "source-transform"
spec:
  inputs:
    parameters:
    - name: "execution_maxcompute"
      type: "Map"
  pipelines:
  - apiVersion: "core/v1"
    metadata:
      provider: "pai"
      version: "v1"
      identifier: "data_source"
      name: "data_source"
      displayName: "テーブル読み取り-1"
    spec:
      arguments:
        parameters:
        - name: "inputTableName"
          value: "pai_online_project.wumai_data"
        - name: "partition"
          value: "20220101"
        - name: "execution"
          from: "{{inputs.parameters.execution_maxcompute}}"
  - apiVersion: "core/v1"
    metadata:
      provider: "pai"
      version: "v1"
      identifier: "type_transform"
      name: "type_transform"
      displayName: "データ型変換-1"
    spec:
      arguments:
        artifacts:
        - name: "inputTable"
          from: "{{pipelines.data_source.outputs.artifacts.outputTable}}"
        parameters:
        - name: "cols_to_double"
          value: "time,hour,pm2,pm10,so2,co,no2"
        - name: "execution"
          from: "{{inputs.parameters.execution_maxcompute}}"
      dependencies:
      - "data_source"

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	DA869D1B-035A-43B2-ACC1-C56681BD9FAA
PipelineRunId	string	パイプラインジョブの ID。	flow-rbvg***

例

成功レスポンス

JSONJSON

{
  "RequestId": "DA869D1B-035A-43B2-ACC1-C56681BD9FAA",
  "PipelineRunId": "flow-rbvg***"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。