Tanyakan informasi tentang node eksekusi pipeline dengan GetPipelineRunNode - Platform For AI - Alibaba Cloud - Platform For AI

Mengkueri informasi tentang sebuah node. Sebuah pekerjaan pipeline berisi berbagai node.

Deskripsi operasi

PAIFlow supports composite pipelines, which are reflected as composite nodes during running. To obtain information about such nodes, you can configure the Depth parameter (default value: 2). You can configure the Depth parameter to recursively obtain information about the queried node and its child nodes.

A virtual root node exists each time a pipeline runs. You can call GetRun to obtain the root node. You can call GetNode to query the root node. The returned result also includes information about all nodes that run and their hierarchies.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

paiflow:GetPipelineRunNode

get

*All Resource

*

None

Sintaks permintaan

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

Path Parameters

Parameter	Type	Required	Description	Example
PipelineRunId	string	Yes	ID pekerjaan pipeline. Anda dapat memanggil ListPipelineRuns untuk mendapatkan ID pekerjaan pipeline.	flow-ebppc********5lwea
NodeId	string	Yes	ID sebuah node dalam pekerjaan pipeline. Anda dapat memanggil ListPipelineRuns untuk mendapatkan ID node.	node-wcs9z********27ps3

Parameter permintaan

Parameter	Type	Required	Description	Example
Depth	integer	No	Kedalaman tempat informasi tentang node dikueri. Jika Anda mengatur Depth menjadi 2, informasi tentang node dan semua node turunannya di lapisan berikutnya akan dikembalikan.	2
Type	string	No	Tipe node. Nilai valid: Logical (default): node logis. Node yang dikirimkan oleh pengguna adalah node logis. Physical: node fisik tempat Kontainer diterapkan untuk menjalankan logika tertentu. Node logis dikonversi menjadi node fisik saat node logis berjalan di latar belakang.	Logical
TokenId	string	No	ID pekerjaan pipeline yang dibagikan.	https://pai.console.alibabacloud.com/?regionId=cn-hangzhou&workspaceId=102****&mode=noSidebar#/paiflow/pipeline-runs/flow-6y7**?Token=eyJ0e****

Elemen respons

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	0a981ea816**********42244e7ba2
ApiVersion	string	The version defined in the pipeline.	core/v1
Metadata	object	The node metadata.
NodeId	string	The node ID.	node-wcs9z********27ps3
Provider	string	The provider of the pipeline for the node. In most cases, this parameter indicates the uploader of the pipeline. If the pipeline is officially provided, the parameter value is PAI.	15577********904
Name	string	The node name.	flow-ebppc********5lwea
Version	string	The version of the pipeline for the node.	v1
Identifier	string	The identifier of the pipeline for the node.	composite-pipeline
NodeType	string	The node type. Valid values: Pod: the specific node that runs. Dag: the composite node, which is essentially a directed acyclic graph (DAG) consisting of child nodes.	Dag
RelatedNodeIds	array	The ID of the physical node corresponding to the Alink logical node or the ID of the logical node corresponding to the Alink physical node.
	string	The node ID.	node-wcs9z********27ps3
DisplayName	string	The display name of the node, which can be modified.	flow-ebppc********5lwea
Spec	object	The node specifications.
HasPipelines	boolean	Indicates whether the node contains child nodes. Valid values: true: The node is a composite node. To query information about its child nodes, you must specify the Depth parameter. false: The node is the one that actually runs.	true
Dependencies	array	The dependencies between the node and other nodes.
	string	The name of the pipeline for other nodes that the node depends on.	"single-node-sub1"
Pipelines	array<object>	The child nodes.
	object	The child node.	详细结构参见Pipeline相关接口描述。
Inputs	object	The input information about of the node.
Artifacts	array<object>	The node inputs.
	object	The node input.	{"Name":"input","Value":"******"}
Parameters	array<object>	The input parameters of the node.
	object	The input parameter of the node.	{"Name":"inputTable","Value":"******"}
Outputs	object	The output information about of the node.
Artifacts	array<object>	The node outputs.
	object	The node output.	{"Name":"output","Value":"******"}
Parameters	array<object>	The output parameters of the node.
	object	The output parameter of the node.	{"Name":"outputTable","Value":"******"}
When	string	The condition on which the node runs. If true is returned, the node is executed. If false is returned, the node is skipped and the node status becomes Skipped.	”{{inputs.parameters.skip}} == false“
WithItems	array	Expands one pipeline node into multiple pipeline nodes.
	string	Expands an item in the dataset into a pipeline node.	abc
WithParam	string	Expands each item in an array that is the value type of a parameter into a pipeline node.	"{{pipelines.generate.outputs.result}}"
WithSequence	object	Expands each item of a numerical sequence into a pipeline node.
Start	integer	The start number of the numerical sequence.	1
End	integer	The end number of the numerical sequence.	10
Format	string	Formats the value of the numerical sequence.	"2020-05-%d"
Parallelism	integer	The maximum parallelism of the nodes.	2
StatusInfo	object	The execution status of the node.
FinishedAt	string	The time when the node finished execution.	2021-10-15T10:40:54.000Z
StartedAt	string	The time when the node started to execute.	2021-10-15T10:39:58.000Z
Status	string	The running status of the node. Valid values: Succeeded Running Failed Skipped: The node status becomes Skipped when its upstream node fails to be executed. ReadyToSchedule: The node status becomes ReadyToSchedule if its upstream node is being executed. Unknown	Succeeded
Conditions	array<object>	The running conditions of the node.
	object	The running condition of the node.	{"ArtifactArchived": "true"}
Progress	string	The running progress of the node.	9/9

Contoh

Respons sukses

JSONformat

{
  "RequestId": "0a981ea816**********42244e7ba2",
  "ApiVersion": "core/v1",
  "Metadata": {
    "NodeId": "node-wcs9z********27ps3",
    "Provider": "15577********904",
    "Name": "flow-ebppc********5lwea",
    "Version": "v1",
    "Identifier": "composite-pipeline",
    "NodeType": "Dag",
    "RelatedNodeIds": [
      "node-wcs9z********27ps3"
    ],
    "DisplayName": "flow-ebppc********5lwea"
  },
  "Spec": {
    "HasPipelines": true,
    "Dependencies": [
      "\"single-node-sub1\""
    ],
    "Pipelines": [
      {
        "test": "test",
        "test2": 1
      }
    ],
    "Inputs": {
      "Artifacts": [
        {
          "Name": "input",
          "Value": "******"
        }
      ],
      "Parameters": [
        {
          "Name": "inputTable",
          "Value": "******"
        }
      ]
    },
    "Outputs": {
      "Artifacts": [
        {
          "Name": "output",
          "Value": "******"
        }
      ],
      "Parameters": [
        {
          "Name": "outputTable",
          "Value": "******"
        }
      ]
    },
    "When": "”{{inputs.parameters.skip}} == false“",
    "WithItems": [
      "abc"
    ],
    "WithParam": "\"{{pipelines.generate.outputs.result}}\"",
    "WithSequence": {
      "Start": 1,
      "End": 10,
      "Format": "\"2020-05-%d\""
    },
    "Parallelism": 2
  },
  "StatusInfo": {
    "FinishedAt": "2021-10-15T10:40:54.000Z",
    "StartedAt": "2021-10-15T10:39:58.000Z",
    "Status": "Succeeded",
    "Conditions": [
      {
        "ArtifactArchived": "true"
      }
    ],
    "Progress": "9/9"
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.