すべてのプロダクト
Search
ドキュメントセンター

DataWorks:CreatePipelineRun

最終更新日:Jul 06, 2026

新バージョンの DataStudio でエンティティの公開プロセスを作成します。

操作説明

重要 この操作はバッチ操作をサポートしていません。パラメーターに複数の公開エンティティを指定した場合、最初のエンティティを除くすべてのエンティティは無視されます。
重要 この操作は、古いバージョンの SDK では利用できない場合があります。その場合は、CreateDeployment 操作を使用してください。パラメーターは本 Topic で説明されているものと同じです。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dataworks:*

create

*すべてのリソース。

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

ProjectId

integer

必須

DataWorks ワークスペースの ID。DataWorks コンソール にログインし、ワークスペース構成ページに移動してワークスペース ID を取得できます。 このパラメーターは、この API 呼び出しの対象となる DataWorks ワークスペースを指定します。

10000

Type

string

必須

公開プロセスがエンティティをオンラインにするかオフラインにするかを指定します。

  • Online: オンライン

  • Offline: オフライン

Online

ObjectIds

array

必須

この公開プロセスで公開するエンティティ ID のリスト。一度に公開できるのは単一のエンティティとその子エンティティのみです。

重要 一度に公開できるのは、単一のエンティティとその子エンティティのみです。この配列内の最初のエンティティとその子エンティティのみが公開されます。この配列の長さが 1 であることを確認してください。最初のエンティティ以降のエンティティは無視されます。

string

任意

公開するエンティティの ID (ノードや WorkflowDefinition エンティティの ID など)。

重要 WorkflowDefinition は全体としてのみ公開できます。ワークフロー内のシングルノードの公開はサポートされていません。

476506242076571XXXX

Description

string

任意

公開プロセスの説明。

This is a OdpsSQL-node publishing process. The function is XXXX.

RunMode

string

任意

公開プロセスの実行モード。デフォルト値: Normal。このパラメーターを Auto に設定すると、公開プロセスは指定されたステージまで自動的に進行します。このパラメーターは AutoRunUntilStage パラメーターと併用します。

有効な値:

  • Normal: 法線

  • Auto: 自動

Normal

AutoRunUntilStage

string

任意

公開プロセスにおけるステージのコード。このパラメーターは、RunMode が Auto に設定されている場合にのみ有効です。公開プロセスの作成後、指定されたステージまで自動的に実行されます。

重要 指定されたステージは自動的に完了します。たとえば、このパラメーターを DEV に設定した場合、DEV ステージが望ましい状態に達した時点で自動実行が停止します。

DEV

レスポンスフィールド

フィールド

説明

object

応答のスキーマ。

RequestId

string

リクエスト ID。この ID を使用してログを検索し、問題のトラブルシューティングを行うことができます。

7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX

Id

string

公開プロセスの一意識別子。

a7ef0634-20ec-4a7c-a214-54020f91XXXX

成功レスポンス

JSONJSON

{
  "RequestId": "7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX",
  "Id": "a7ef0634-20ec-4a7c-a214-54020f91XXXX\n"
}

エラーコード

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

変更履歴

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