Use GetDefaultWorkspace to retrieve default workspace details - Platform For AI

Retrieves the details of the default workspace.

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:GetDefaultWorkspace

get

*All Resource

*

None

Request syntax

GET /api/v1/defaultWorkspaces HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Verbose	boolean	No	Specifies whether to return detailed information about the default workspace. The detailed information includes the Conditions list. Valid values: false (default): Detailed information is not returned. true: Detailed information is returned.	false

Response elements

Element	Type	Description	Example
	object	The response structure.
RequestId	string	The request ID.	5A14FA81-DD4E-******-6343FE44B941
WorkspaceId	string	The workspace ID.	1234
WorkspaceName	string	The name of the workspace. The name must be unique within the same region.	workspace-example
GmtCreateTime	string	The time when the workspace was created. The time is in Coordinated Universal Time (UTC) and is formatted in ISO 8601.	2021-01-21T17:12:35.232Z
GmtModifiedTime	string	The time when the workspace was last modified. The time is in UTC and is formatted in ISO 8601.	2021-01-21T17:12:35.232Z
DisplayName	string	The display name of the workspace.	workspace-example
Description	string	The description of the workspace.	workspace description example
EnvTypes	array	The environments in the workspace. A workspace in basic mode contains only the production (prod) environment. A workspace in standard mode contains the development (dev) and production (prod) environments.
	string	The environment. Valid values: dev: The development environment. prod: The production environment.	prod
Creator	string	The Alibaba Cloud account that created the workspace.	17915******4216
Owner	object	The Alibaba Cloud account that created the workspace.
UserId	string	The UID of the user.	17915******4216
UserName	string	The username.	username
UserKp	string	The UID of the user.	17915******4216
Status	string	The status of the workspace. Valid values: ENABLED: Normal. INITIALIZING: Initializing. FAILURE: Failed. DISABLED: Disabled. FROZEN: Frozen due to an overdue payment. UPDATING: The workspace is being updated.	ENABLED
Conditions	array<object>	The details about the creation stages of the default workspace.
	object	The details about a creation stage of the default workspace.
Type	string	The task type. Valid values: CREATING: Creating. WORKSPACE_CREATED: The workspace is created. MEMBERS_ADDED: Members are added. ENABLED: The process is complete.	CREATING
Code	integer	The status code. A value of 200 indicates that the request was successful. Other values indicate that the request failed.	200
Message	string	The error message. This parameter is empty if the status code is 200.	Create Failed

Examples

Success response

JSON format

{
  "RequestId": "5A14FA81-DD4E-******-6343FE44B941",
  "WorkspaceId": "1234",
  "WorkspaceName": "workspace-example",
  "GmtCreateTime": "2021-01-21T17:12:35.232Z",
  "GmtModifiedTime": "2021-01-21T17:12:35.232Z",
  "DisplayName": "workspace-example",
  "Description": "workspace description example",
  "EnvTypes": [
    "prod"
  ],
  "Creator": "17915******4216\n",
  "Owner": {
    "UserId": "17915******4216",
    "UserName": "username",
    "UserKp": "17915******4216"
  },
  "Status": "ENABLED",
  "Conditions": [
    {
      "Type": "CREATING ",
      "Code": 200,
      "Message": "Create Failed"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.