ListSpace-阿里云帮助中心

Queries the list of service workspaces.

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

mpserverless:ListSpace

list

*Space

acs:mpserverless::{#accountId}:space/*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNum	integer	No	The page number, starting from 0.	0
PageSize	integer	No	The number of entries per page. Default value: 10.	10
SpaceIds	array	No	The list of service workspace IDs.
	string	No	The service workspace ID.	b9105f6d-f403-4ad5-8a05-82e4524659c8,aff8cd35-4273-40ce-943e-9ab8cd8d89fc
EmasWorkspaceId	string	No	The ID of the EMAS project workspace.	3821658

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	B314EDAD-FFCA-536D-BA9C-08B42F7C2DDE
GmtCreate	string	[Deprecated] This field is deprecated and retained only for API compatibility. The server no longer returns this field. Do not rely on its value. To obtain the creation time of a service workspace, use the GmtCreate field of the corresponding element in the Spaces array. The example value is fictitious and used only for documentation purposes. It does not represent the actual response.	2020-02-18T08:06:47Z
Count	integer	The total number of entries for pagination.	23
Spaces	array<object>	The service workspaces.
	object
Status	string	The service status. Valid values: IN_SERVICE: in service PAUSED: paused	IN_SERVICE
GmtCreate	integer	The creation time.	1582018007000
SpaceId	string	The service workspace ID.	368ef42a-763f-0000-acc2-8aa9564c****
Name	string	The name of the service workspace.	myspace
Desc	string	The description.	My workspace
GmtLastAccess	integer	The last access time.	1582018007000

Examples

Success response

JSON format

{
  "RequestId": "B314EDAD-FFCA-536D-BA9C-08B42F7C2DDE",
  "GmtCreate": "2020-02-18T08:06:47Z",
  "Count": 23,
  "Spaces": [
    {
      "Status": "IN_SERVICE",
      "GmtCreate": 1582018007000,
      "SpaceId": "368ef42a-763f-0000-acc2-8aa9564c****",
      "Name": "myspace",
      "Desc": "我的空间",
      "GmtLastAccess": 1582018007000
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.