ListFileVersions-DataWorks(DataWorks)-阿里云帮助中心

Queries a list of file versions.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:*

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
FileId	integer	Yes	The ID of the file. You can call the ListFiles operation to query the ID.	100000001
ProjectId	integer	No	The DataWorks workspace ID. You can click the Workspace Manage icon in the upper-right corner of the Data Studio page to go to the workspace management page and view the workspace ID.	100001
ProjectIdentifier	string	No	The unique English identifier of the DataWorks workspace, displayed in the workspace switcher at the top of the Data Studio page. You must specify either this parameter or ProjectId to determine the DataWorks workspace to which the operation is applied.	dw_project
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code returned.	200
ErrorMessage	string	The error message returned.	The connection does not exist.
RequestId	string	The ID of the request.	0000-ABCD-EFG****
ErrorCode	string	The error code returned.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indicates whether the request is successful.	true
Data	object	The file versions.
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of entries that match the query conditions.	13
FileVersions	array<object>	The details of file versions.
	object
FileContent	string	The code in the file of the current version.	SHOW TABLES;
Status	string	The status of the file of the current version. Valid values: COMMITTING, COMMITTED, CHECK_OK, PACKAGED, DEPLOYING, DEPLOYED, and CANCELLED.	COMMITTED
IsCurrentProd	boolean	Indicates whether the file version is the same as the latest file version in the production environment.	false
CommitUser	string	The ID of the Alibaba Cloud account used to create the file of the current version.	73842342****
NodeContent	string	The scheduling configurations for the node that corresponds to the file of the current version.	{"cycleType":0,"cronExpress":"00 05 00 * * ?"}
Comment	string	The description of the file version.	Second version submission
FilePropertyContent	string	The basic information about the file of the current version.	{"fileName":"ods_user_info_d","fileType":10}
FileName	string	The name of the file of the current version.	ods_user_info_d
UseType	string	The functional module to which the file belongs. Valid values: 0: NORMAL (Data Studio). 1: MANUAL (manually triggered tasks). 2: MANUAL_BIZ (manually triggered workflows). 3: SKIP (dry-run scheduling in Data Studio). 10: ADHOCQUERY (ad hoc queries). 30: COMPONENT (component management).	NORMAL
ChangeType	string	The type of the change to the file of the current version. Valid values: CREATE, UPDATE, and DELETE.	UPDATE
FileVersion	integer	The version of the file.	2
CommitTime	integer	The time when the file version was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1593881265000
NodeId	integer	The ID of the auto triggered node that corresponds to the file of the current version.	1234

Examples

Success response

JSON format

{
  "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
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
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.	No permission, please authorize
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.