All Products
Search
Document Center

File Storage NAS:DescribeAccessPoints

Last Updated:Dec 11, 2024

Queries the information about 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
nas:DescribeAccessPointslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
FileSystemIdstringNo

The ID of the file system.

174494****
AccessGroupstringNo

The name of the permission group.

This parameter is required for a General-purpose 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
MaxResultsintegerNo

The number of results for each query.

Valid values: 10 to 100. Default value: 10.

10
NextTokenstringNo

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

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

6299428C-3861-435D-AE54-9B330A00****
AccessPointsarray<object>

The information about the access point.

AccessPointobject
ARNstring

The Alibaba Cloud Resource Name (ARN) of the access point.

acs:nas:cn-hangzhou:178321033379****:accesspoint/ap-ie15yd****
AccessGroupstring

The name of the permission group.

test
AccessPointIdstring

The ID of the access point.

ap-ie15yd****
AccessPointNamestring

The name of the access point.

test
CreateTimestring

The time when the access point was created.

1709619668276167
DomainNamestring

The domain name of the access point.

ap-ie15ydanoz.001014****-w****.cn-hangzhou.nas.aliyuncs.com
EnabledRamboolean

Indicates whether the Resource Access Management (RAM) policy is enabled.

false
FileSystemIdstring

The ID of the file system.

31a8e4****
ModifyTimestring

The time when the access point was modified.

1709619668276167
PosixUserobject

The Portable Operating System Interface for UNIX (POSIX) user.

PosixGroupIdinteger

The ID of the POSIX user group.

12
PosixUserIdinteger

The ID of the POSIX user.

123
PosixSecondaryGroupIdsarray

The IDs of the secondary user groups.

posixSecondaryGidinteger

The ID of the secondary user group.

[123,123]
RootPathstring

The root directory.

/
RootPathPermissionobject

The permissions on the root directory.

OwnerGroupIdlong

The ID of the owner group.

12
OwnerUserIdlong

The owner ID.

1
Permissionstring

The POSIX permission.

0755
RootPathStatusstring

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
Statusstring

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
VSwitchIdstring

The vSwitch ID.

vsw-2zevmwkwyztjuoffg****
VpcIdstring

The VPC ID.

vpc-2zesj9afh3y518k9o****
NextTokenstring

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****
TotalCountinteger

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 codeError codeError messageDescription
400InvalidFilesystemType.NotSupportThe API operation does not support the file system type.The API operation does not support the file system type.
403InvalidProtocolType.NotSupportedThe specified protocol type does not supported.-
404InvalidFileSystem.NotFoundThe specified file system does not exist.The specified file system does not exist.
404InvalidAccessGroup.NotFoundThe 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 timeSummary of changesOperation
No change history