Call the DescribeAccessPoints API to query access points - File Storage NAS - Alibaba Cloud - File Storage NAS

Queries access point information.

Note

This API has been deprecated. We recommend migrating to NAS(2017-06-26) - ListAccessPoints for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	No	The file system ID.	174494****
AccessGroup	string	No	The permission group name. This parameter is required if the file system is a General-purpose NAS file system. Default permission group: DEFAULT_VPC_GROUP_NAME (the default VPC permission group).	DEFAULT_VPC_GROUP_NAME
MaxResults	integer	No	The number of results for each query. Valid values: 10 to 100. Default value: 10.	10
Tag	array<object>	No	The list of access point tags.
	object	No	The list of access point tags.
Key	string	No	The tag key. Limits: Valid values of N: 1 to 20. The tag key can be up to 128 characters in length. The tag key cannot start with aliyun or acs:. The tag key cannot contain http:// or https://.	TestKey
Value	string	No	The tag value. Limits: Valid values of N: 1 to 20. The tag value can be up to 128 characters in length. The tag value cannot start with aliyun or acs:. The tag value cannot contain http:// or https://.	TestValue
NextToken	string	No	The query token. Set the value to the NextToken value returned in the previous API call.	MTY4NzcxOTcwMjAzMDk2Nzc0MyM4MDM4****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	6299428C-3861-435D-AE54-9B330A00****
AccessPoints	array<object>	The access point information.
	array<object>
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-ie15y*****
AccessPointName	string	The access point name.	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 file system ID.	31a8e4****
ModifyTime	string	The time when the access point was last modified.	1709619668276167
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.
	integer	The ID of the secondary user group.	[123,123]
RootPath	string	The root directory.	/
RootPathPermission	object	The root directory permissions.
OwnerGroupId	integer	The ID of the owner group.	12
OwnerUserId	integer	The owner ID.	1
Permission	string	The POSIX permission.	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 list of access point tags.
	object	The list of access point tags.
Key	string	The key of the tag that is added to the resource.	TestKey
Value	string	Tag value	TestValue
NextToken	string	The query token. Set the value to the NextToken value returned in the previous API call.	MTY4NzcxOTcwMjAzMDk2Nzc0MyM4MDM4****
TotalCount	integer	The total number of access points.	20

Examples

Success response

JSON format

{
  "RequestId": "6299428C-3861-435D-AE54-9B330A00****",
  "AccessPoints": [
    {
      "ARN": "acs:nas:cn-hangzhou:178321033379****:accesspoint/ap-ie15yd****",
      "AccessGroup": "test",
      "AccessPointId": "ap-ie15y*****\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",
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ]
    }
  ],
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.