ファイルのバージョン一覧をクエリします。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| FileId |
integer |
必須 |
ファイル ID です。ListFiles を呼び出して、ファイル ID をクエリできます。 |
100000001 |
| ProjectId |
integer |
任意 |
DataWorks ワークスペース ID です。この ID を確認するには、右上隅のレンチアイコンをクリックし、ワークスペース管理ページに移動します。 |
100001 |
| ProjectIdentifier |
string |
任意 |
DataWorks ワークスペースの一意な識別子です。Data Studio ページの上部にある、ワークスペース切り替え時に表示される識別子です。 この API 呼び出しで対象の DataWorks ワークスペースを特定するには、このパラメーターまたは ProjectId のいずれかを指定する必要があります。 |
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 |
現在のページに含まれるエントリ数です。 |
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（Data Studio）、MANUAL（手動タスク）、MANUAL_BIZ（手動ワークフロー）、SKIP（Data Studio のドライランスケジューリング）、ADHOCQUERY（アドホッククエリ）、COMPONENT（コンポーネント管理）。 |
NORMAL |
| ChangeType |
string |
このファイルバージョンの変更タイプです。有効な値：CREATE、UPDATE、DELETE。 |
UPDATE |
| FileVersion |
integer |
ファイルバージョンです。 |
2 |
| CommitTime |
integer |
ファイルバージョンが作成されたタイムスタンプ（ミリ秒単位）です。 |
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****\n",
"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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。