Creates a DataWorks workspace.
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:
- The required resource types are displayed in bold characters.
- 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:CreateProject | create | *Project acs:dataworks:{#regionId}:{#accountId}:workspace/* |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ClientToken | string | No | The client token that is used to ensure the idempotence of the request. This parameter can be left empty. | ABFUOEUOTRTRJKE |
| ProjectName | string | Yes | The display name of the workspace. | test_project |
| ProjectDescription | string | No | The description of the workspace. | test_describe |
| DisableDevelopment | boolean | No | Specifies whether to disable the Develop role. Valid values:
| false |
| IsAllowDownload | integer | No | Specifies whether to allow you to download the query result from DataStudio. Valid values:
| 1 |
| ProjectMode | integer | No | 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:
| 3 |
| ProjectIdentifier | string | Yes | The name of the workspace. The name can contain only letters, digits, and underscores (_) and must start with a letter or digit. | test_project |
| ResourceManagerResourceGroupId | string | No | The resource group ID. | rg-acfmzbn7pti3**** |
| Tags | array<object> | No | The tags added to the workspace. | |
| object | No | The tags. | ||
| Key | string | Yes | The tag key. | key |
| Value | string | Yes | The tag value. | value |
Response parameters
Examples
Sample success responses
JSONformat
{
"HttpStatusCode": 200,
"RequestId": "1AFAE64E-D1BE-432B-A9****",
"Success": true,
"Data": 466230
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | Invalid.Tenant.ConnectionNotExists | The connection does not exist. | The connection does not exist. |
| 400 | Invalid.Tenant.ProjectNotExists | The project does not exist. | The project does not exist. |
| 400 | Invalid.Tenant.UserNotInProject | The user is not in the project. | The user is not in the project. |
| 403 | Invalid.Tenant.UserIsNotProjectOwnerOrAdmin | The user is not a project administrator or owner. | The user is not a project administrator or owner. |
| 403 | Invalid.Tenant.UserNotInTenant | The 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 time | Summary of changes | Operation |
|---|---|---|
| 2024-03-29 | The Error code has changed | View Change Details |