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

DataWorks:ListFileVersions

最終更新日:Mar 21, 2026

ファイルのバージョン一覧をクエリします。

今すぐお試しください

この 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:*

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

FileId

integer

必須

ファイルの ID です。この ID を取得するには、ListFiles 操作を呼び出します。

100000001

ProjectId

integer

任意

DataWorks ワークスペースの ID です。DataStudio ページの右上隅にある [ワークスペース管理] アイコンをクリックし、ワークスペースページに移動して、ワークスペース ID を確認できます。

100001

ProjectIdentifier

string

任意

DataWorks ワークスペースの一意な識別子です。DataStudio ページの左上隅に表示される識別子をクリックすると、別のワークスペースに切り替えることができます。

このパラメーターまたは ProjectId のいずれかを指定して、操作を適用する DataWorks ワークスペースを特定する必要があります。

dw_project

PageNumber

integer

任意

ページ番号です。

1

PageSize

integer

任意

1 ページあたりの表示件数です。デフォルト値は 10、最大値は 100 です。

10

レスポンスフィールド

フィールド

説明

object

HttpStatusCode

integer

返された HTTP ステータスコードです。

200

ErrorMessage

string

返されたエラーメッセージです。

The connection does not exist.

RequestId

string

リクエストの ID です。

0000-ABCD-EFG****

ErrorCode

string

返されたエラーコードです。

Invalid.Tenant.ConnectionNotExists

Success

boolean

リクエストが成功したかどうかを示します。

true

Data

object

ファイルのバージョン情報です。

PageNumber

integer

返されたページのページ番号です。

1

PageSize

integer

1 ページあたりの返却件数です。

10

TotalCount

integer

返却された合計件数です。

13

FileVersions

array<object>

ファイルのバージョンの詳細情報です。

object

FileContent

string

現在のバージョンのファイルに含まれるコードです。

SHOW TABLES;

Status

string

現在のバージョンのファイルのステータスです。有効な値:COMMITTING、COMMITTED、CHECK_OK、PACKAGED、DEPLOYING、DEPLOYED、CANCELLED。

COMMITTED

IsCurrentProd

boolean

このファイルバージョンが本番環境における最新のファイルバージョンと同一であるかどうかを示します。

false

CommitUser

string

現在のバージョンのファイルを作成するために使用された Alibaba Cloud アカウントの ID です。

73842342****

NodeContent

string

現在のバージョンのファイルに対応するノードのスケジューリング構成です。

{"cycleType":0,"cronExpress":"00 05 00 * * ?"}

Comment

string

ファイルバージョンの説明です。

Second version submission

FilePropertyContent

string

現在のバージョンのファイルに関する基本情報です。

{"fileName":"ods_user_info_d","fileType":10}

FileName

string

現在のバージョンのファイルの名前です。

ods_user_info_d

UseType

string

ファイルが属する機能モジュールです。有効な値:NORMAL、MANUAL、MANUAL_BIZ、SKIP、ADHOCQUERY、COMPONENT。SKIP は、ファイルに対応するノードがドライランモードで実行されることを意味します。

NORMAL

ChangeType

string

現在のバージョンのファイルに対する変更の種類です。有効な値:CREATE、UPDATE、DELETE。

UPDATE

FileVersion

integer

ファイルのバージョンです。

2

CommitTime

integer

ファイルバージョンが作成された時刻です。この値は UNIX タイムスタンプ(協定世界時 (UTC) 1970 年 1 月 1 日 00:00:00 からの経過ミリ秒数)です。

1593881265000

NodeId

integer

現在のバージョンのファイルに対応する自動トリガー型ノードの ID です。

1234

成功レスポンス

JSONJSON

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-EFG****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 13,
    "FileVersions": [
      {
        "FileContent": "SHOW TABLES;",
        "Status": "COMMITTED",
        "IsCurrentProd": false,
        "CommitUser": "73842342****",
        "NodeContent": "{\"cycleType\":0,\"cronExpress\":\"00 05 00 * * ?\"}",
        "Comment": "Second version submission",
        "FilePropertyContent": "{\"fileName\":\"ods_user_info_d\",\"fileType\":10}",
        "FileName": "ods_user_info_d",
        "UseType": "NORMAL",
        "ChangeType": "UPDATE",
        "FileVersion": 2,
        "CommitTime": 1593881265000,
        "NodeId": 1234
      }
    ]
  }
}

エラーコード

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.

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

変更履歴

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