Creates a workspace.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
emr-serverless-spark:CreateWorkspace |
create |
*All Resource
|
None | None |
Request syntax
POST /api/v1/workspaces HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| body |
object |
No |
The request body. |
|
| workspaceName |
string |
No |
The workspace name. |
default |
| resourceSpec |
object |
No |
The resource specifications. |
|
| cu |
string |
No |
The resource quota for the workspace. |
1000 |
| gpu |
integer |
No |
The GPU resource quota for the workspace. |
100 |
| ossBucket |
string |
No |
The OSS bucket for the workspace. The path must be in the |
oss://test-bucket/ |
| dlfCatalogId |
string |
No |
The DLF Catalog ID. |
123xxxxx |
| paymentType |
string |
No |
The billing method. Valid values:
|
PayAsYouGo |
| paymentDurationUnit |
string |
No |
The unit of the subscription duration. This parameter is required if you set |
1000 |
| duration |
string |
No |
The subscription duration. This parameter is required if you set |
12452 |
| autoRenew |
string |
No |
Specifies whether to enable auto-renewal. This parameter is required if you set |
false |
| autoRenewPeriod |
string |
No |
The auto-renewal duration. This parameter is required if |
100 |
| autoRenewPeriodUnit |
string |
No |
The unit of the auto-renewal duration. This parameter is required if |
month |
| clientToken |
string |
No |
A token that ensures the idempotency of the request. |
8e6aae2810c8f67229ca70bb31cd**** |
| ramRoleName |
string |
No |
The name of the RAM role used to run Spark jobs. |
AliyunEMRSparkJobRunDefaultRole |
| autoStartSessionCluster |
boolean |
No |
Specifies whether to automatically start a session cluster when the workspace is created. |
false |
| releaseType |
string |
No |
The release type. |
pro |
| dlfType |
string |
No |
The DLF type. |
dlf1.0 |
| tag |
array<object> |
No |
The tags to add to the workspace. |
|
|
object |
No |
A tag. |
||
| key |
string |
No |
The tag key. |
key |
| value |
string |
No |
The tag value. |
value |
| resourceGroupId |
string |
No |
The resource group ID. |
rg-acfmwpi66knkxny |
| gpuSpec |
array |
No |
The specifications for the GPU resources. |
|
|
string |
No |
The instance type of the GPU resources. |
ecs.gn7i-c8g1.2xlarge |
|
| regionId |
string |
No |
The region ID. |
cn-hangzhou |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The returned data. |
||
| workspaceId |
string |
The workspace ID. |
w-****** |
| operationId |
string |
The operation ID. |
op-****** |
| requestId |
string |
The request ID. |
DD6B1B2A-5837-5237-ABE4-FF0C8944**** |
Examples
Success response
JSON format
{
"workspaceId": "w-******",
"operationId": "op-******",
"requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.