GetPipeline を使用してパイプライン情報をクエリ - 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:GetPipeline

get

*All Resource

*

なし

リクエスト構文

GET /api/v1/pipelines/{PipelineId} HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
PipelineId	string	必須	パイプライン ID。ListPipelineRuns を呼び出して、パイプラインジョブの ID を取得できます。	pipeline-hynm2bv8wqhp5e****

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

リクエストパラメーターは必要ありません。

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	63EDFF2F-4D51-46F0-9D65-2F8F393B****
PipelineId	string	パイプライン ID。	pipeline-hynm2bv8wqhp5e****
Provider	string	カスタムパイプラインの場合、値はユーザー ID です。 Platform for AI (PAI) によって提供されるパイプラインの場合、値は PAI です。	132668941337****
Identifier	string	パイプライン識別子。	SqlWrite
Version	string	パイプラインのバージョン。	v1
Manifest	string	パイプライン定義。	apiVersion: ****
GmtCreateTime	string	パイプラインが作成された時刻 (UTC)。ISO 8601 標準に準拠しています。	2021-01-21T17:12:35.232Z
GmtModifiedTime	string	パイプラインが変更された時刻 (UTC)。ISO 8601 標準に準拠しています。	2021-01-21T17:12:35.232Z
Uuid	string	パイプラインの UUID。ユーザーがパイプラインを変更するたびに UUID が生成されます。	q8dp9hklueznhg****
WorkspaceId	string	ワークスペース ID。	726**

Manifest パラメーターの追加説明

apiVersion: "core/v1"
metadata:
  version: "v1"
  # パイプラインのプロバイダー。
  provider: "132668**********"
  identifier: "my***"
spec:
  inputs:
    parameters:
    - name: "inputTableName"
      value: "myDefault"
      # データの型。 値は string、double、bool、integer、map、list のいずれかです。
      type: "String"
      desc: "Table Name"
      # パラメーターが必須かどうかを指定します。 デフォルト値： false。
      required: false
  outputs:
    artifacts:
    - name: "outputTable"
      metadata:
        # メタデータの型。 値は DataSet、Model、ModelEvaluation、Any、DataStream、Raw のいずれかです。 この例では、DataSet が使用されます。
        type:
          DataSet:
            locationType: "MaxComputeTable"
      desc: "Source MaxCompute Table Output Port"
  container:
    image: "registry.***.com/***/***:v*"
    command:
    - "bash"
    - "***.sh"
    volumeMounts:
    - name: "download-volume"
      path: "/***"
  initContainers:
  - image: "registry.***.com/***/***:v*"
    command:
    - "***.sh"
    args:
    - "--***"
    name: "initdownload"
    volumeMounts:
    - name: "download-volume"
      path: "/downloadPath"
  volumes:
  - name: "download-volume"
    emptyDir: {}

例

成功レスポンス

JSONJSON

{
  "RequestId": "63EDFF2F-4D51-46F0-9D65-2F8F393B****",
  "PipelineId": "pipeline-hynm2bv8wqhp5e****",
  "Provider": "132668941337****",
  "Identifier": "SqlWrite",
  "Version": "v1",
  "Manifest": "apiVersion: ****",
  "GmtCreateTime": "2021-01-21T17:12:35.232Z",
  "GmtModifiedTime": "2021-01-21T17:12:35.232Z",
  "Uuid": "q8dp9hklueznhg****",
  "WorkspaceId": "726**"
}

エラーコード

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

変更履歴

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