GetFile - Query file details | DataWorks API - DataWorks

Queries the details of a file.

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
ProjectId	integer	No	The DataWorks workspace ID. You can obtain it on the Workspace Management page of the DataWorks console. Either this parameter or ProjectIdentifier is required to specify the workspace.	10000
ProjectIdentifier	string	No	The DataWorks workspace name. You can obtain it on the Workspace Management page of the DataWorks console. Either this parameter or ProjectId is required to specify the workspace.	dw_project
FileId	integer	No	The file ID. You can call ListFiles to obtain it.	100000001
NodeId	integer	No	The scheduled node ID. You can call ListFiles to obtain it.	200000001

Response elements

Element	Type	Description	Example
	object	The response parameters.
HttpStatusCode	integer	The HTTP status code returned.	200
ErrorMessage	string	The error message returned.	The connection does not exist.
RequestId	string	The request ID, used for troubleshooting.	0000-ABCD-EFG****
ErrorCode	string	The error code returned.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Whether the request was successful. true: The request succeeded. false: The request failed.	true
Data	object	The details of the file.
File	object	The basic information about the file.
CommitStatus	integer	Whether the latest code in the file is committed. Valid values: 0 (not committed) and 1 (committed).	0
AutoParsing	boolean	Whether automatic parsing is enabled for the file. true: Enabled. false: Disabled. Corresponds to the Analyze Code parameter displayed after Same Cycle is selected in the Dependencies section of the Properties tab in the DataWorks console.	true
Owner	string	The ID of the Alibaba Cloud account used by the file owner.	7775674356****
CreateTime	integer	The time when the file was created. This value is a UNIX timestamp in milliseconds.	1593879116000
FileType	integer	The code type of the file. Valid code types are listed in DataWorks nodes.	10
CurrentVersion	integer	The latest version number of the file.	3
BizId	integer	Deprecated. Use BusinessId instead. The workflow ID of the file.	1000001
LastEditUser	string	The ID of the Alibaba Cloud account used to last modify the file.	62465892****
FileName	string	The name of the file.	ods_user_info_d
ConnectionName	string	The ID of the compute engine instance that is used to run the node that corresponds to the file.	odps_first
UseType	string	The module to which the file belongs. Valid values: NORMAL: DataStudio. MANUAL: Manually triggered node. MANUAL_BIZ: Manually triggered workflow. SKIP: Dry-run DataStudio node. ADHOCQUERY: Ad hoc query. COMPONENT: Snippet.	NORMAL
FileFolderId	string	The ID of the folder to which the file belongs.	2735c2****
ParentId	integer	The ID of the node group file to which the current file belongs. This parameter is returned only if the current file is an inner file of the node group file.	-1
CreateUser	string	The ID of the Alibaba Cloud account used to create the file.	424732****
IsMaxCompute	boolean	Whether the file needs to be uploaded to MaxCompute. Returned only for MaxCompute resource files.	true
BusinessId	integer	The ID of the workflow to which the file belongs.	1000001
FileDescription	string	The description of the file.	My first DataWorks file
DeletedStatus	string	The deletion status of the file. Valid values: NORMAL: Not deleted. RECYCLE_BIN: In the recycle bin. DELETED: Deleted.	RECYCLE
LastEditTime	integer	The time when the file was last modified. This value is a UNIX timestamp in milliseconds.	1593879116000
Content	string	The code in the file.	SHOW TABLES;
NodeId	integer	The ID of the auto triggered node that is generated in the scheduling system after the file is committed.	300001
AdvancedSettings	string	The advanced configurations of the node. Valid for EMR nodes only. Corresponds to the Advanced Settings tab on the node configuration page in the DataWorks console. Note EMR Shell nodes do not support advanced parameters. Advanced parameter details for each EMR node type: Develop EMR tasks.	{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}
FileId	integer	The ID of the file.	100000001
NodeConfiguration	object	The scheduling configurations of the file.
RerunMode	string	The rerun policy for the node. Valid values: ALL_ALLOWED: Rerun allowed on both success and failure. FAILURE_ALLOWED: Rerun allowed only on failure. ALL_DENIED: Rerun not allowed. Corresponds to the Rerun parameter in the Schedule section of the Properties tab in the DataWorks console.	ALL_ALLOWED
SchedulerType	string	The scheduling type of the node. Valid values: NORMAL: Auto triggered. MANUAL: Manually triggered. Cannot be auto triggered. Corresponds to nodes in the Manually Triggered Workflows pane. PAUSE: Paused. SKIP: Dry-run. Started as scheduled but automatically marked as successful.	NORMAL
Stop	boolean	Whether scheduling for the node is suspended. true: Suspended. false: Not suspended. Corresponds to the Recurrence parameter in the Schedule section of the Properties tab in the DataWorks console.	false
ParaValue	string	The scheduling parameters of the node. Corresponds to the Parameters section of the Properties tab in the DataWorks console. Configuration details: Configure scheduling parameters.	a=x b=y
StartEffectDate	integer	The start time of automatic scheduling. This value is a UNIX timestamp in milliseconds. This parameter corresponds to the Validity Period parameter in the Schedule section of the Properties tab in the DataWorks console.	936923400000
EndEffectDate	integer	The end time of automatic scheduling. This value is a UNIX timestamp in milliseconds. This parameter corresponds to the Validity Period parameter in the Schedule section of the Properties tab in the DataWorks console.	4155787800000
CycleType	string	The scheduling cycle type. Valid values: NOT_DAY (scheduled by minute or hour) and DAY (scheduled by day, week, or month). Corresponds to the Scheduling Cycle parameter in the Schedule section of the Properties tab in the DataWorks console.	DAY
DependentNodeIdList	string	The dependent node IDs when DependentType is USER_DEFINE. Multiple IDs are separated by commas (,). Equivalent to the node IDs specified under Previous Cycle > Depend On > Other Nodes in the Dependencies section of the Properties tab in the DataWorks console.	5,10,15,20
ResourceGroupId	integer	The resource group ID used to run the node. Call ListResourceGroups to query available resource groups.	375827434852437
DependentType	string	The cross-cycle scheduling dependency type. Valid values: SELF: Depends on the same node in the previous cycle. CHILD: Depends on the nearest-level descendant nodes in the previous cycle. USER_DEFINE: Depends on specified nodes in the previous cycle. NONE: No cross-cycle dependency.	USER_DEFINE
AutoRerunTimes	integer	The number of automatic reruns that are allowed after an error occurs.	3
AutoRerunIntervalMillis	integer	The interval between automatic reruns after an error. Unit: milliseconds. Corresponds to the Rerun Interval parameter under Auto Rerun upon Error in the Schedule section of the Properties tab in the DataWorks console. The console uses minutes. Convert accordingly when calling this operation.	120000
CronExpress	string	The CRON expression that represents the periodic scheduling policy of the node.	00 05 00 * * ?
InputList	array<object>	The output names of the parent files on which the current file depends.
	object
Input	string	The output name of the parent file on which the current file depends. This parameter corresponds to the Output Name of Ancestor Node parameter under Parent Nodes after Same Cycle is selected in the Dependencies section of the Properties tab in the DataWorks console.	project.001_out
ParseType	string	The mode of the configuration file dependency. Valid values: MANUAL: Scheduling dependencies are manually configured. AUTO: Scheduling dependencies are automatically parsed.	MANUAL
OutputList	array<object>	The output names of the current file. This parameter corresponds to the Output Name parameter under Output after Same Cycle is selected in the Dependencies section of the Properties tab in the DataWorks console.
	object
RefTableName	string	The output table name of the current file. This parameter corresponds to the Output Table Name parameter under Output after Same Cycle is selected in the Dependencies section of the Properties tab in the DataWorks console.	ods_user_info_d
Output	string	The output name of the current file. This parameter corresponds to the Output Name parameter under Output after Same Cycle is selected in the Dependencies section of the Properties tab in the DataWorks console.	dw_project.002_out
StartImmediately	boolean	Whether the node runs immediately after deployment to production. Valid only for EMR Spark Streaming and EMR Streaming SQL nodes. Corresponds to the Start Method parameter in the Schedule section of the Configure tab in the DataWorks console.	true
InputParameters	array<object>	Input parameters of the node. This parameter corresponds to the Input Parameters table in the Input and Output Parameters section of the Properties tab in the DataWorks console.
	object
ParameterName	string	The name of the input parameter of the node. In the code, you can use the ${...} method to reference the input parameter of the node. This parameter corresponds to the Parameter Name parameter in the Input Parameters table in the Input and Output Parameters section of the Properties tab in the DataWorks console.	input
ValueSource	string	The value source of the input parameter of the node. This parameter corresponds to the Value Source parameter in the Input Parameters table in the Input and Output Parameters section of the Properties tab in the DataWorks console.	project_001.parent_node:outputs
OutputParameters	array<object>	Output parameters of the node. This parameter corresponds to the Output Parameters table in the Input and Output Parameters section of the Properties tab in the DataWorks console.
	object
ParameterName	string	The name of the output parameter of the node. This parameter corresponds to the Parameter Name parameter in the Output Parameters table in the Input and Output Parameters section of the Properties tab in the DataWorks console.	output
Value	string	The value of the output parameter of the node. This parameter corresponds to the Value parameter in the Output Parameters table in the Input and Output Parameters section of the Properties tab in the DataWorks console.	${bizdate}
Type	string	The output parameter type. Valid values: 1: Constant. 2: Variable. 3: Pass-through variable. Corresponds to the Type parameter in the Output Parameters table in the Input and Output Parameters section of the Properties tab in the DataWorks console.	1
Description	string	The description of the output parameter of the node.	It's a context output parameter.
ApplyScheduleImmediately	string	Whether scheduling configurations immediately take effect after the deployment.	true
IgnoreParentSkipRunningProperty	string	Whether to skip the dry-run property of ancestor nodes. Corresponds to the Skip the dry-run property of the ancestor node parameter under Depend On in the Dependencies section of the Properties tab in the DataWorks console.	true
Timeout	integer	The timeout period.	1
ImageId	string	The ID of the custom image.	m-bp1h4b5a8ogkbll2f3tr
ResourceDownloadLink	object	The download URL of the resource.
downloadLink	string	The download URL of the resource.	http://xx

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-EFG****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "File": {
      "CommitStatus": 0,
      "AutoParsing": true,
      "Owner": "7775674356****",
      "CreateTime": 1593879116000,
      "FileType": 10,
      "CurrentVersion": 3,
      "BizId": 1000001,
      "LastEditUser": "62465892****",
      "FileName": "ods_user_info_d",
      "ConnectionName": "odps_source",
      "UseType": "NORMAL",
      "FileFolderId": "2735c2****",
      "ParentId": -1,
      "CreateUser": "424732****",
      "IsMaxCompute": true,
      "BusinessId": 1000001,
      "FileDescription": "My first DataWorks file",
      "DeletedStatus": "RECYCLE",
      "LastEditTime": 1593879116000,
      "Content": "SHOW TABLES;",
      "NodeId": 300001,
      "AdvancedSettings": "{\\\"priority\\\":\\\"1\\\",\\\"ENABLE_SPARKSQL_JDBC\\\":false,\\\"FLOW_SKIP_SQL_ANALYZE\\\":false,\\\"queue\\\":\\\"default\\\"}",
      "FileId": 100000001
    },
    "NodeConfiguration": {
      "RerunMode": "ALL_ALLOWED",
      "SchedulerType": "NORMAL",
      "Stop": false,
      "ParaValue": "a=x b=y",
      "StartEffectDate": 936923400000,
      "EndEffectDate": 4155787800000,
      "CycleType": "DAY",
      "DependentNodeIdList": "5,10,15,20",
      "ResourceGroupId": 375827434852437,
      "DependentType": "USER_DEFINE",
      "AutoRerunTimes": 3,
      "AutoRerunIntervalMillis": 120000,
      "CronExpress": "00 05 00 * * ?",
      "InputList": [
        {
          "Input": "project.001_out",
          "ParseType": "MANUAL"
        }
      ],
      "OutputList": [
        {
          "RefTableName": "ods_user_info_d",
          "Output": "dw_project.002_out"
        }
      ],
      "StartImmediately": true,
      "InputParameters": [
        {
          "ParameterName": "input",
          "ValueSource": "project_001.parent_node:outputs"
        }
      ],
      "OutputParameters": [
        {
          "ParameterName": "output",
          "Value": "${bizdate}",
          "Type": "1",
          "Description": "It's a context output parameter."
        }
      ],
      "ApplyScheduleImmediately": "true",
      "IgnoreParentSkipRunningProperty": "true",
      "Timeout": 1,
      "ImageId": "m-bp1h4b5a8ogkbll2f3tr"
    },
    "ResourceDownloadLink": {
      "downloadLink": "http://xx"
    }
  }
}

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.