DescribeAccessPoints - Apsara File Storage NAS - Alibaba Cloud Documentation Center

Queries the information about an access point.

Operation description

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	No	The ID of the file system.	174494****
AccessGroup	string	No	The name of the permission group. This parameter is required for a General-purpose Apsara File Storage NAS (NAS) file system. The default permission group for virtual private clouds (VPCs) is named DEFAULT_VPC_GROUP_NAME.	DEFAULT_VPC_GROUP_NAME
MaxResults	integer	No	The number of results for each query. Valid values: 10 to 100. Default value: 10.	10
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.	MTY4NzcxOTcwMjAzMDk2Nzc0MyM4MDM4****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	6299428C-3861-435D-AE54-9B330A00****
AccessPoints	array<object>	The information about the access point.
	object
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 Resource Access Management (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
PosixUser	object	The Portable Operating System Interface for UNIX (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.
	integer	The ID of the secondary user group.	[123,123]
RootPath	string	The root directory.	/
RootPathPermission	object	The permissions on the root directory.
OwnerGroupId	long	The ID of the owner group.	12
OwnerUserId	long	The owner ID.	1
Permission	string	The POSIX permission.	0755
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. Note You can mount a file system only if the access point is in the Active state.	Active
VSwitchId	string	The vSwitch ID.	vsw-2zevmwkwyztjuoffg****
VpcId	string	The VPC ID.	vpc-2zesj9afh3y518k9o****
NextToken	string	The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.	MTY4NzcxOTcwMjAzMDk2Nzc0MyM4MDM4****
TotalCount	integer	The total number of access points.	20

Examples

Sample success responses

JSONformat

{
  "RequestId": "6299428C-3861-435D-AE54-9B330A00****",
  "AccessPoints": [
    {
      "ARN": "acs:nas:cn-hangzhou:178321033379****:accesspoint/ap-ie15yd****",
      "AccessGroup": "test",
      "AccessPointId": "ap-ie15yd****\n",
      "AccessPointName": "test",
      "CreateTime": "1709619668276167",
      "DomainName": "ap-ie15ydanoz.001014****-w****.cn-hangzhou.nas.aliyuncs.com",
      "EnabledRam": false,
      "FileSystemId": "31a8e4****\n",
      "ModifyTime": "1709619668276167",
      "PosixUser": {
        "PosixGroupId": 12,
        "PosixUserId": 123,
        "PosixSecondaryGroupIds": [
          0
        ]
      },
      "RootPath": "/",
      "RootPathPermission": {
        "OwnerGroupId": 12,
        "OwnerUserId": 1,
        "Permission": "0755"
      },
      "RootPathStatus": "2",
      "Status": "Active",
      "VSwitchId": "vsw-2zevmwkwyztjuoffg****\n",
      "VpcId": "vpc-2zesj9afh3y518k9o****\n"
    }
  ],
  "NextToken": "MTY4NzcxOTcwMjAzMDk2Nzc0MyM4MDM4****\n",
  "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.	-
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.

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

Change history

Change time	Summary of changes	Operation

No change history