DescribeAgenticSpaces - File Storage NAS - Alibaba Cloud Documentation Center

Queries Agentic spaces.

Operation description

Applies to Agentic file systems.

Before you begin

Before you call this operation, you must create resources in the following order:

Create an Agentic file system: When you call CreateFileSystem to create a file system, you must configure the following parameters:
- StorageType: Set the value to Agentic.
- ProtocolType: Set the value to NFS.
- Supported regions: The Agentic storage type is available only in specific regions and zones. For more information, see the console.
Query the AgenticSpace list: After the file system is created and its status changes to Running, call the DescribeAgenticSpaces operation to query the Agentic spaces in the file system.
- If Agentic spaces are created in the file system, the complete list is returned.
- If no Agentic space is created in the file system, an empty list is returned.

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

nas:DescribeAgenticSpaces

list

*FileSystem

acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId}

None

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	The ID of the file system.	1ca404****
Filters	array<object>	No	The collection of filter information.
	object	No	The filter information.
Key	string	No	The name of the filter key. Valid values: AgenticSpaceIds Valid values: AgenticSpaceIds : The filter name for a collection of Agentic space IDs.	AgenticSpaceIds
Value	string	No	The value of the filter key. Wildcards are not supported for this parameter. AgenticSpaceIds: You can specify only one ID.	06229oypxjgox0u****
NextToken	string	No	The query token. The value is the NextToken value returned from the previous API call.	MTc3OTkzNTA0Mjg0NTc1MDI4OCM0MDQ0MzA****=
MaxResults	integer	No	The number of entries to return per query. Valid values: 10 to 100. Default value: 20.	20

Response elements

Element	Type	Description	Example
	object
AgenticSpaces	object
AgenticSpace	array<object>	The Agentic space information.
	array<object>	The Agentic space information.
AgenticSpaceId	string	The AgenticSpace ID.	agentic-229oypxjgpau2****
Azone	string	The zone ID.	cn-hangzhou-i
CreateTimeUtc	string	The time when the Agentic space was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.	2026-06-10T10:08:08Z
Description	string	The description of the Agentic space.	Description
FileCountUsage	integer	The number of used files.	100
FileSystemId	string	The ID of the file system.	0322djegiekcia5****
FileSystemPath	string	The absolute path of the file.	/test/
Quota	object	The quota information.
FileCountLimit	integer	The file count limit for the quota. Valid values: Minimum value: 10,000. Maximum value: 100,000,000.	10000000
SizeLimit	integer	The total capacity limit for the quota. Unit: bytes. Valid values: Minimum value: 10,737,418,240 (10 GiB). Maximum value: 1,099,511,627,776,000 (1,024,000 GiB). Step: 1,073,741,824 (1 GiB).	10737418240
SpaceUsage	integer	The used capacity. Unit: bytes.	1024
Status	string	The status of the Agentic space. Valid values: Running: The Agentic space is running. Deleted: The Agentic space is deleted. Creating: The Agentic space is being created. Deleting: The Agentic space is being deleted. CreateFailed: The Agentic space failed to be created.	Running
UpdateTimeUtc	string	The time when the Agentic space was updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.	2026-06-10T10:08:08Z
NextToken	string	The query token. The value is the NextToken value returned from the previous API call.	MTc2NTg1MTUyMzA1OTczNTc1OCM0NjQxMzQ****=
RequestId	string	The request ID.	BC7C825C-5F65-4B56-BEF6-98C56C7C****

Examples

Success response

JSON format

{
  "AgenticSpaces": {
    "AgenticSpace": [
      {
        "AgenticSpaceId": "agentic-229oypxjgpau2****",
        "Azone": "cn-hangzhou-i",
        "CreateTimeUtc": "2026-06-10T10:08:08Z",
        "Description": "Description",
        "FileCountUsage": 100,
        "FileSystemId": "0322djegiekcia5****",
        "FileSystemPath": "/test/",
        "Quota": {
          "FileCountLimit": 10000000,
          "SizeLimit": 10737418240
        },
        "SpaceUsage": 1024,
        "Status": "Running",
        "UpdateTimeUtc": "2026-06-10T10:08:08Z"
      }
    ]
  },
  "NextToken": "MTc2NTg1MTUyMzA1OTczNTc1OCM0NjQxMzQ****=",
  "RequestId": "BC7C825C-5F65-4B56-BEF6-98C56C7C****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalCharacters	The parameter contains illegal characters.	The parameter contains illegal characters.
400	MissingFileSystemId	FileSystemId is mandatory for this action.	The FileSystemId parameter is not specified.
400	InvalidParameter.SortOrder	Invalid sort order.	Parameter SortOrder error.
400	InvalidParameter.SortOrderField	Invalid sort order field.	Parameter SortOrderField error.
400	InvalidFilesystemType.NotSupport	The API operation does not support the file system type.	The API operation does not support the file system type.
403	OperationDenied.FilesetNotSupported	The operation is not supported.	The file system does not support Fileset.
404	InvalidFileSystem.NotFound	The specified file system does not exist.	The specified file system does not exist.
404	InvalidFilterParam	The specified Filter.N.Key is invalid.	The specified Filter.N.Key parameter is invalid.
404	InvalidFilterValue	The specified Filter.N.Value is invalid.	The value of Filter.1.Value is invalid.
404	InvalidParameter.InvalidNextToken	The specified NextToken is invaild.
404	InvalidParameter.InvalidMaxResults	The specified MaxResults is invalid.	The specified MaxResults parameter is invalid.
404	InvalidAgenticSpace.NotFound	The specified AgenticSpace is not found.	The specified AgenticSpace was not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.