ListPipelineRunNodeStatus でパイプラインノード実行ステータスをクエリ - 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:ListPipelineRunNodeStatus

list

*All Resource

*

なし

リクエスト構文

GET /api/v1/pipelineruns/{PipelineRunId}/nodes/{NodeId}/status HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
PipelineRunId	string	必須	パイプラインジョブの ID です。 ListPipelineRuns を呼び出して、パイプラインジョブの ID を取得できます。	flow-rbvg5wzljzjhc9****
NodeId	string	必須	パイプラインノードの ID です。 ListPipelineRuns を呼び出して、ノード ID を取得できます。	node-kdkfkfds****

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Depth	integer	任意	ノード情報を照会する深さです。 Depth を N に設定すると、対象ノードとその子ノード（N-1 レイヤー）の情報が返されます。	2
Type	string	任意	ノードタイプです。有効な値は以下のとおりです。 Logical (デフォルト)：論理ノード。ユーザーが送信したノードは論理ノードです。 Physical：特定のロジックを実行するためにコンテナがデプロイされる物理ノード。論理ノードがバックグラウンドで実行されると、物理ノードに変換されます。	Logical
TokenId	string	任意	共有パイプラインジョブの ID です。	https://pai.console.alibabacloud.com/?regionId=cn-hangzhou&workspaceId=102****&mode=noSidebar#/paiflow/pipeline-runs/flow-6y7**?Token=eyJ0e****

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーターです。
RequestId	string	リクエスト ID です。	473469C7-**--**-A3DC0DE3C83E
Status	array<object>	パイプラインノードのステータスです。
	object
NodeId	string	パイプラインノードの ID です。	node-1jlzg7ncv0j6i3****
NodeName	string	パイプラインノードの名前です。	sql
Status	string	ノードの実行状態です。	Succeeded
StartedAt	string	ノードの実行開始時刻 (UTC) です。時刻は ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式に従います。	2021-01-21T17:12:35.232Z
FinishedAt	string	ノードの実行終了時刻 (UTC) です。時刻は ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式に従います。	2021-01-21T17:12:40.232Z
RuntimeInfo	string	ノードのランタイム情報です。エスケープされた MAP 形式で提供されます。複数の KV ペアをカスタム出力できます。同じキーが使用された場合、最後に出力された値が採用されます。返された情報が空の場合、{} が返されます。	{\"DLC_INSTANCE_IDS\": \"i-12224afdfsaf,i-22224afdfsaf,i-13224afdfsaf\"}

例

成功レスポンス

JSONJSON

{
  "RequestId": "473469C7-****-****-****-A3DC0DE3C83E\n",
  "Status": [
    {
      "NodeId": "node-1jlzg7ncv0j6i3****",
      "NodeName": "sql",
      "Status": "Succeeded",
      "StartedAt": "2021-01-21T17:12:35.232Z",
      "FinishedAt": "2021-01-21T17:12:40.232Z",
      "RuntimeInfo": "{\\\"DLC_INSTANCE_IDS\\\": \\\"i-12224afdfsaf,i-22224afdfsaf,i-13224afdfsaf\\\"}\n"
    }
  ]
}

エラーコード

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

変更履歴

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