UpdateProject - DataWorks - Alibaba Cloud Documentation Center

Updates a DataWorks workspace.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	UpdateProject	The operation that you want to perform. Set the value to UpdateProject.
ProjectId	Long	Yes	25	The DataWorks workspace ID. You can call the ListProjects operation to obtain the ID.
ProjectName	String	No	Test	The display name of the workspace.
ProjectDescription	String	No	Test	The description of the workspace.
IsAllowDownload	Integer	No	1	Specifies whether query result download from DataStudio is allowed. Valid values: 1: allowed 0: not allowed
Status	Integer	No	0	The status of the workspace. Valid values: 0: AVAILABLE, which indicates that the workspace is running as expected. 4: FORBIDDEN, which indicates that the workspace is manually disabled.

Response parameters

Parameter	Type	Example	Description
HttpStatusCode	Integer	200	The HTTP status code returned.
RequestId	String	1AFAE64E-D1BE-432B-A9****	The request ID. You can use the ID to locate logs and troubleshoot issues.
Success	Boolean	true	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.
Data	Boolean	true	Indicates whether the workspace was updated.

Examples

Sample requests

http(s)://[Endpoint]/?Action=UpdateProject
&ProjectId=25
&ProjectName=Test
&ProjectDescription=Test
&IsAllowDownload=1
&Status=0
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateProjectResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>1AFAE64E-D1BE-432B-A9****</RequestId>
    <Success>true</Success>
    <Data>true</Data>
</UpdateProjectResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "HttpStatusCode" : 200,
  "RequestId" : "1AFAE64E-D1BE-432B-A9****",
  "Success" : true,
  "Data" : true
}

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid.Tenant.ConnectionNotExists	The connection does not exist.	The specified data source does not exist.
400	Invalid.Tenant.ProjectNotExists	The project does not exist.	The specified workspace does not exist.
400	Invalid.Tenant.UserNotInProject	The user is not in the project.	The user is not added to the workspace.
403	Invalid.Tenant.UserIsNotProjectOwnerOrAdmin	The user is not a project administrator or owner.	The user is not the workspace owner or administrator.
403	Invalid.Tenant.UserNotInTenant	The user is not in tenant.	The user does not belong to the tenant.

For a list of error codes, see Service error codes.