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

DataWorks:DeployFile

最終更新日:Sep 03, 2026

ファイルを本番環境にデプロイします。

今すぐお試しください

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

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

ProjectId

integer

任意

DataWorks ワークスペースの ID。

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

10000

ProjectIdentifier

string

任意

DataWorks ワークスペースの名前。

DataWorks コンソールにログインし、ワークスペース構成ページに移動してワークスペース名を取得できます。この API 呼び出しの対象となる DataWorks ワークスペースを特定するには、このパラメーターまたは ProjectId のいずれかを指定する必要があります。

dw_project

FileId

integer

任意

ファイルの ID。 ListFiles を呼び出してファイル ID をクエリできます。このパラメーターと NodeId パラメータ設定のうち、いずれか一方のみを指定する必要があります。

10000001

Comment

string

任意

Deployment の説明。

初回リリースタスク

NodeId

integer

任意

公開対象のファイルに対応するスケジューリングシステム内のノードの ID。

このパラメーターと FileId パラメータ設定のうち、いずれか一方のみを指定する必要があります。

2000001

レスポンスフィールド

フィールド

型

説明

例

object

応答パラメーター。

HttpStatusCode

integer

HTTP 状態コード。

200

Data

integer

デプロイメントパッケージの ID。この Deployment の詳細を取得するには、 GetDeployment 操作を呼び出す際にこの ID をパラメーターとして渡す必要があります。

30000001

RequestId

string

リクエスト ID。

0000-ABCD-EFG****

ErrorMessage

string

エラーメッセージ。

接続が存在しません

Success

boolean

呼び出しが成功したかどうかを示します。有効な値:

  • true: 呼び出しが成功しました。

  • false: 呼び出しが失敗しました。

true

ErrorCode

string

エラーコード。

Invalid.Tenant.ConnectionNotExists

例

成功レスポンス

JSONJSON

{
  "HttpStatusCode": 200,
  "Data": 30000001,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The connection does not exist.",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

500 InternalError.System An internal system error occurred. Try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later.
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.
429 Throttling.Api The request for this resource has exceeded your available limit.
429 Throttling.System The DataWorks system is busy. Try again later.
429 Throttling.User Your request is too frequent. Try again later.

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

変更履歴

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