ListAccessPoints - File Storage NAS - Alibaba Cloud Documentation Center

Queries access point information.

Operation description

Only General-purpose NAS NFS file systems are supported.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	The file system ID.	0913nx15amuix9a****
Filters	array<object>	No	The filter information.
	object	No	The filter information.
Name	string	No	The name of the filter key. Valid values: AccessGroup (not supported for agentic) AccessPointId AgenticSpaceId Valid values: AccessGroup : permission group name. AccessPointId : access point ID. AgenticSpaceId : agentic space ID.	AccessPointId
Value	string	No	The value of the filter key.	TestValue
NextToken	string	No	The query token. Set this parameter to the value of NextToken that was returned in the previous API call.	MTY4NzcxOTcwMjAzMDk2Nzc0MyM4MDM4****
MaxResults	integer	No	The maximum number of results to return per query. Maximum value: 100. Minimum value: 10. Default value: 20.	10

Response elements

Element	Type	Description	Example
	object
RequestId	string	Id of the request	98696EF0-1607-4E9D-B01D-F20930B6****
AccessPoints	array<object>	The access point information.
	array<object>	The access point information.
ARN	string	The access point ARN.	acs:nas:cn-hangzhou:178321033379**:accesspoint/ap-ie15yd**
AccessGroup	string	The permission group name.	DEFAULT_VPC_GROUP_NAME
AccessPointId	string	The access point ID.	ap-ie15y*****
AccessPointName	string	The access point name.	test
CreateTime	string	The time when the access point was created. The time follows the ISO 8601 standard in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.	2026-03-28T06:32:14Z
DomainName	string	The access point domain name.	ap-ie15ydanoz.001014**-w**.cn-hangzhou.nas.aliyuncs.com
EnabledRam	boolean	Indicates whether the RAM policy is enabled.	false
FileSystemId	string	The file system ID.	091yj49baxscll2****
ModifyTime	string	The time when the access point was last modified. The time follows the ISO 8601 standard in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.	2026-06-24T02:10:23Z
PosixUser	object	The POSIX user.
PosixGroupId	integer		10
PosixUserId	integer		156
PosixSecondaryGroupIds	array
	integer		[100,123]
RootPath	string	The root directory.	/
RootPathPermission	object	The root directory permission.
OwnerGroupId	integer		12
OwnerUserId	integer		1
Permission	string		0755
RootPathStatus	string	The current root directory status. Valid values: 0: The root path status is unknown. 1: The root path does not exist. It may have been deleted by the user. 2: The root path status is normal.	2
Status	string	The current access point status. Valid values: Active: Available. Inactive: Unavailable. Pending: Being created. Deleting: Being deleted. Note You can mount a file system only when the status is Active.	Active
VSwitchId	string	The vSwitch ID.	vsw-2zevmwkwyztjuoffg****
VpcId	string	The VPC ID.	vpc-2zesj9afh3y518k9o****
Tags	array<object>	The access point tag list.
	object	The access point tag list.
Key	string		TestKey
Value	string		TestValue
AgenticSpaceId	string	AgenticSpace Id。	agentic-229oypxjgpau2****
CreateTimeUtc	string	The time when the agentic space was created. The time follows the ISO 8601 standard. Format: yyyy-MM-ddTHH:mm:ssZ.	2026-06-10T10:08:08Z
ModifyTimeUtc	string	The time when the agentic space was last modified. The time follows the ISO 8601 standard. Format: yyyy-MM-ddTHH:mm:ssZ.	2026-06-10T10:08:08Z
NextToken	string	The query token. Set this parameter to the value of NextToken that was returned in the previous API call.	52frCAAAAABoZS90cm****==
TotalCount	integer	The total number of access points.	20

Examples

Success response

JSON format

{
  "RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****",
  "AccessPoints": [
    {
      "ARN": "acs:nas:cn-hangzhou:178321033379****:accesspoint/ap-ie15yd****",
      "AccessGroup": "DEFAULT_VPC_GROUP_NAME",
      "AccessPointId": "ap-ie15y*****\n",
      "AccessPointName": "test",
      "CreateTime": "2026-03-28T06:32:14Z",
      "DomainName": "ap-ie15ydanoz.001014****-w****.cn-hangzhou.nas.aliyuncs.com",
      "EnabledRam": false,
      "FileSystemId": "091yj49baxscll2****",
      "ModifyTime": "2026-06-24T02:10:23Z",
      "PosixUser": {
        "PosixGroupId": 10,
        "PosixUserId": 156,
        "PosixSecondaryGroupIds": [
          0
        ]
      },
      "RootPath": "/",
      "RootPathPermission": {
        "OwnerGroupId": 12,
        "OwnerUserId": 1,
        "Permission": "0755"
      },
      "RootPathStatus": "2",
      "Status": "Active",
      "VSwitchId": "vsw-2zevmwkwyztjuoffg****\n",
      "VpcId": "vpc-2zesj9afh3y518k9o****\n",
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "AgenticSpaceId": "agentic-229oypxjgpau2****",
      "CreateTimeUtc": "2026-06-10T10:08:08Z",
      "ModifyTimeUtc": "2026-06-10T10:08:08Z"
    }
  ],
  "NextToken": "52frCAAAAABoZS90cm****==",
  "TotalCount": 20
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidFilesystemType.NotSupport	The API operation does not support the file system type.	The API operation does not support the file system type.
403	InvalidProtocolType.NotSupported	The specified protocol type does not supported.	The specified protocol type is not supported.
404	InvalidFileSystem.NotFound	The specified file system does not exist.	The specified file system does not exist.
404	InvalidAccessGroup.NotFound	The specified AccessGroup does not exist.	The permission group that you specified does not exist or has been deleted.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.