DescribeAccessPoint - File Storage NAS - Alibaba Cloud Documentation Center

Queries the details of an access point.

Operation description

Only General-purpose Network File System (NFS) file systems support this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
nas:DescribeAccessPoint	get	All Resources *	none	none

Request parameters

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

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
AccessPoint	object	The information about the access point.
ARN	string	The Alibaba Cloud Resource Name (ARN) of the access point.	acs:nas:cn-hangzhou:178321033379**:accesspoint/ap-ie15yd**
AccessGroup	string	The name of the permission group.	test
AccessPointId	string	The ID of the access point.	ap-ie15yd****
AccessPointName	string	The name of the access point.	test
CreateTime	string	The time when the access point was created.	1709619668276167
DomainName	string	The domain name of the access point.	ap-ie15ydanoz.001014**-w**.cn-hangzhou.nas.aliyuncs.com
EnabledRam	boolean	Indicates whether the RAM policy is enabled.	false
FileSystemId	string	The ID of the file system.	31a8e4****
ModifyTime	string	The time when the access point was modified.	1709619668276167
RootPathPermission	object	The permissions to create the root directory.
OwnerGroupId	integer	The ID of the owner group.	123
OwnerUserId	integer	The owner ID.	1
Permission	string	The POSIX permission.	0755
PosixUser	object	The POSIX user.
PosixGroupId	integer	The ID of the POSIX user group.	12
PosixUserId	integer	The ID of the POSIX user.	123
PosixSecondaryGroupIds	array	The IDs of the secondary user groups.
posixSecondaryGid	integer	The ID of the secondary user group.	[123,123]
RootPath	string	The root directory.	/
RootPathStatus	string	The status of the root directory. Valid values: 0: The rootpath status is unknown. 1: The rootpath does not exist and may be deleted. 2: The rootpath is normal.	2
Status	string	The status of the access point. Valid values: Active: The access point is available. Inactive: The access point is unavailable. Pending: The access point is being created. Deleting: The access point is being deleted.	Active
VSwitchId	string	The vSwitch ID.	vsw-2zevmwkwyztjuoffg****
VpcId	string	The ID of the virtual private cloud (VPC). You must select the VPC of the Elastic Compute Service (ECS) instance on which you want to mount the file system.	vpc-2zesj9afh3y518k9o****
RegionId	string	The region ID.	cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "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****",
    "RegionId": "cn-hangzhou"
  }
}

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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history