All Products
Search
Document Center

DataWorks:CreateProject

Last Updated:Oct 17, 2024

Creates a DataWorks workspace.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. This parameter can be left empty.

ABFUOEUOTRTRJKE
ProjectNamestringYes

The display name of the workspace.

test_project
ProjectDescriptionstringYes

The description of the workspace.

test_describe
DisableDevelopmentbooleanNo

Specifies whether to disable the Develop role. Valid values:

  • false (default)
  • true
false
IsAllowDownloadintegerNo

Specifies whether to allow you to download the query result from DataStudio. Valid values:

  • 1 (default): allows you to download the query result from DataStudio.
  • 0: does not allow you to download the query result from DataStudio.
1
ProjectModeintegerNo

The mode of the workspace. For more information about the differences between the modes of workspaces, see Differences between workspaces in basic mode and workspaces in standard mode.

Valid values:

  • 2 (default): basic mode
  • 3: standard mode
3
ProjectIdentifierstringYes

The name of the workspace. The name can contain only letters, digits, and underscores (_) and must start with a letter or digit.

test_project
ResourceManagerResourceGroupIdstringNo

The resource group ID.

rg-acfmzbn7pti3****
Tagsarray<object>No

The tags added to the workspace.

objectNo

The tags.

KeystringYes

The tag key.

key
ValuestringYes

The tag value.

value

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

HttpStatusCodeinteger

The HTTP status code.

200
RequestIdstring

The request ID.

1AFAE64E-D1BE-432B-A9****
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Datalong

The workspace ID.

466230

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400Invalid.Tenant.ConnectionNotExistsThe connection does not exist.The connection does not exist.
400Invalid.Tenant.ProjectNotExistsThe project does not exist.The project does not exist.
400Invalid.Tenant.UserNotInProjectThe user is not in the project.The user is not in the project.
403Invalid.Tenant.UserIsNotProjectOwnerOrAdminThe user is not a project administrator or owner.The user is not a project administrator or owner.
403Invalid.Tenant.UserNotInTenantThe user is not in tenant.The user is not in tenant.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-03-29The Error code has changedView Change Details