Updates the basic information about a file resource in DataStudio. This API operation performs an incremental update. The update information is described by using FlowSpec.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| dataworks:* | update | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ProjectId | string | Yes | The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID. | 10000 |
| Id | string | Yes | The unique identifier of the Data Studio file resource. Note
This field is of type Long in SDK versions prior to 8.0.0, and of type String in SDK version 8.0.0 and later. This change does not affect the normal use of the SDK; parameters are still returned according to the type defined in the SDK. Compilation failures due to the type change may occur only when upgrading the SDK across version 8.0.0, in which case users need to manually correct the data type.
| 543217824470354XXXX |
| Spec | string | Yes | The unique identifier of the Data Studio file resource. Note
Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.
| { "version": "1.1.0", "kind": "Resource", "spec": { "fileResources": [ { "name": "OpenAPI_Test_Resource.py", "script": { "content": "", "path": "XX/OpenAPI_Test/Resources_Test/OpenAPI_Test_Resource.py", "runtime": { "command": "ODPS_PYTHON" } }, "type": "python", "file": { "storage": {} }, "datasource": { "name": "odps_first", "type": "odps" } } ] } } |
| ResourceFile | string | No | The specific file stream or OSS download link contained in the resource. Note
This field allows users to provide a file stream or an OSS download link. When providing an OSS download link, ensure that the OSS link is publicly accessible. A presigned URL is recommended.
| http://bucketname1.oss-cn-shanghai.aliyuncs.com/example |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "4CDF7B72-020B-542A-8465-21CFFA81XXXX",
"Success": true
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2025-12-29 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2025-05-06 | The request parameters of the API has changed | View Change Details |
| 2025-01-13 | The internal configuration of the API is changed, but the call is not affected | View Change Details |