CreateWorkspace - Platform For AI - Alibaba Cloud Documentation Center

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

paiworkspace:CreateWorkspace

create

*All Resource

*

None

Request syntax

POST /api/v1/workspaces HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request struct.
WorkspaceName	string	Yes	The workspace name. The name must meet the following requirements: Be 3 to 23 characters in length and can contain letters, underscores (_), and digits. Start with a letter. Be unique within the current region.	workspace_example
Description	string	Yes	The workspace description. It can be up to 80 characters long.	这是一个工作空间描述示例。
DisplayName	string	No	Name the workspace as needed to identify its purpose. If you do not set this parameter, the value of WorkspaceName is used by default.	demo工作空间
EnvTypes	array	Yes	The environments that the workspace contains: Basic mode includes only the production environment (prod). Standard mode includes the developer environment (dev) and the production environment (prod).
	string	Yes	The environment type. Valid values: dev: the developer environment. prod: the production environment.	dev
ResourceGroupId	string	No

Response elements

Element	Type	Description	Example
	object	The response struct.
RequestId	string	The request ID.	1e195c5116124202371861018d5bde
WorkspaceId	string	The workspace ID.	1234

Examples

Success response

JSON format

{
  "RequestId": "1e195c5116124202371861018d5bde",
  "WorkspaceId": "1234"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.