Query access point details using DescribeAccessPoint - File Storage NAS - Alibaba Cloud - File Storage NAS

Queries the details of an access point.

Operation description

Only General-purpose NAS NFS file systems support this feature.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	The file system ID.	31a8e4****
AccessPointId	string	Yes	The access point ID.	ap-ie15yd****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
AccessPoint	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.	test
AccessPointId	string	The access point ID.	ap-ie15yd****
AccessPointName	string	The access point name.	test
CreateTime	string	The time when the access point was created.	1709619668276167
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.	31a8e4****
ModifyTime	string	The time when the access point was last modified.	1709619668276167
RootPathPermission	object	The permissions for creating the root directory.
OwnerGroupId	integer	The file group ID.	123
OwnerUserId	integer	The file owner ID.	1
Permission	string	The POSIX permission.	0755
PosixUser	object	The POSIX user.
PosixGroupId	integer	The POSIX user group ID.	12
PosixUserId	integer	The POSIX user ID.	123
PosixSecondaryGroupIds	array	The secondary user group ID.
	integer	The secondary user group ID.	[123,123]
RootPath	string	The root directory.	/
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: active Inactive: inactive Pending: being created Deleting: being deleted	Active
VSwitchId	string	The vSwitch ID.	vsw-2zevmwkwyztjuoffg****
VpcId	string	The VPC ID. The VPC must be the same as the VPC of the Elastic Computing Service (ECS) server to which you want to mount the file system.	vpc-2zesj9afh3y518k9o****
Tags	array<object>	The list of access point tags.
	object	The list of access point tags.
Key	string	The tag key.	TestKey
Value	string	The tag value.	TestValue
RegionId	string	The region ID.	cn-hangzhou
AgenticSpaceId	string	AgenticSpace Id。	agentic-229oypxjgpau2****
CreateTimeUtc	string	The time when the AgenticSpace was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.	2026-06-10T10:08:08Z
ModifyTimeUtc	string	The time when the AgenticSpace was last modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.	2026-06-10T10:08:08Z

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "AccessPoint": {
    "ARN": "acs:nas:cn-hangzhou:178321033379****:accesspoint/ap-ie15yd****",
    "AccessGroup": "test\n",
    "AccessPointId": "ap-ie15yd****\n",
    "AccessPointName": "test",
    "CreateTime": "1709619668276167",
    "DomainName": "ap-ie15ydanoz.001014****-w****.cn-hangzhou.nas.aliyuncs.com",
    "EnabledRam": false,
    "FileSystemId": "31a8e4****",
    "ModifyTime": "1709619668276167",
    "RootPathPermission": {
      "OwnerGroupId": 123,
      "OwnerUserId": 1,
      "Permission": "0755"
    },
    "PosixUser": {
      "PosixGroupId": 12,
      "PosixUserId": 123,
      "PosixSecondaryGroupIds": [
        0
      ]
    },
    "RootPath": "/",
    "RootPathStatus": "2",
    "Status": "Active",
    "VSwitchId": "vsw-2zevmwkwyztjuoffg****",
    "VpcId": "vpc-2zesj9afh3y518k9o****",
    "Tags": [
      {
        "Key": "TestKey",
        "Value": "TestValue"
      }
    ],
    "RegionId": "cn-hangzhou",
    "AgenticSpaceId": "agentic-229oypxjgpau2****",
    "CreateTimeUtc": "2026-06-10T10:08:08Z",
    "ModifyTimeUtc": "2026-06-10T10:08:08Z"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidAccessPointId.NotFound	The access point id does not exist.	The specified APid does not exist.
404	InvalidFileSystem.NotFound	The specified file system does not exist.	The specified file system does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.