DescribeCpfsAccessPoints - Cloud Parallel File Storage - Alibaba Cloud Documentation Center

Queries access points of CPFS for Lingjun.

Operation description

Queries access points of CPFS for Lingjun.

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

list

*All Resource

*

None

Request syntax

GET / HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
FileSystemId	string	Yes	The file system ID. CPFS: The ID must start with `cpfs-`, such as cpfs-099394bd928c**. CPFS for Lingjun: The ID must start with `bmcpfs-`, such as bmcpfs-290w65p03ok64ya**.	bmcpfs-290rg9crq96m362ups2
AccessPointId	string	No	The access point ID.	ap-ie15yd****
PageSize	integer	No	The number of results per query. Valid values: 1 to 100. Default value: 10.	10
PageNumber	integer	No	The page number of the list.	1
		No	The list of CPFS access point tags.

Response elements

Element	Type	Description	Example
	object	The request was successful.
RequestId	string	The request ID.	A323836B-5BC6-45A6-8048-60675C23****
AccessPoints	array<object>	The access point information.
	array<object>	The access point information.
RegionId	string	The region ID.	cn-hangzhou
ARN	string	The Alibaba Cloud Resource Name (ARN) of the access point.	acs:nas:cn-hangzhou:178321033379**:accesspoint/ap-ie15yd**
AccessPointId	string	The access point ID.	ap-ie15y*****
Description	string	The description of the access point.	Description
FileSystemId	string	The file system ID.	bmcpfs-290r9c75fnb0il8d8v1
CreateTime	string	The time when the access point was created. The time follows the ISO 8601 standard in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.	2026-03-28T06:32:14Z
ModifyTime	string	The time when the access point was last modified. The time follows the ISO 8601 standard in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.	2025-03-28T06:32:14Z
Status	string	The current status of the access point. Valid values: Active: available. Inactive: unavailable. Pending: being created. Deleting: being deleted. Note You can mount the file system only when the status is Active.	Active
RootDirectory	object	The root directory information.
RootPath	string	The root directory.	/path
RootPathStatus	string	The current status of the root directory. Valid values: Unknown: the root path status is unknown. NotExist: the root path does not exist. It may have been deleted by the user. Ready: the root path status is normal.	Ready
Tags	array<object>	The list of CPFS access point tags.
	object	The CPFS access point tag.
Key	string	The key of the CPFS access point tag.	TestKey
Value	string	The value of the CPFS access point tag.	TestValue
TotalCount	integer	The total number of access points.	6
PageSize	integer	The number of results per page. Valid values: 1 to 100. Default value: 10.	10
PageNumber	integer	The page number of the list.	1

Examples

Success response

JSON format

{
  "RequestId": "A323836B-5BC6-45A6-8048-60675C23****",
  "AccessPoints": [
    {
      "RegionId": "cn-hangzhou",
      "ARN": "acs:nas:cn-hangzhou:178321033379****:accesspoint/ap-ie15yd****",
      "AccessPointId": "ap-ie15y*****\n",
      "Description": "Description",
      "FileSystemId": "bmcpfs-290r9c75fnb0il8d8v1",
      "CreateTime": "2026-03-28T06:32:14Z",
      "ModifyTime": "2025-03-28T06:32:14Z",
      "Status": "Active",
      "RootDirectory": {
        "RootPath": "/path",
        "RootPathStatus": "Ready"
      },
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ]
    }
  ],
  "TotalCount": 6,
  "PageSize": 10,
  "PageNumber": 1
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidRequest	The request is invalid.	Invalid request
400	InvalidParameter.FileSystem	Invalid FileSystem in ResourceIds.	The file system in the ResourceIds is invalid.
400	InvalidFilesystemType.NotSupport	This Api does not support this fileSystem type.	The current interface does not support this type of file system.
400	FeatureOrAPI.NotSupported	The Feature/API is not supported in this region now.	This feature or API is not currently supported in this region.
403	Forbbiden.Ram	User not authorized to operate on the specified resource, or this API doesn't support RAM.	The user is not authorized to operate the specified resource, or the API does not support RAM.
404	InvalidAccessPoint.NotFound	The specified AccessPoint does not exist.	The specified access point does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.