Creates an access point.
Operation description
- After you call the CreateAccessPoint operation, an access point is not immediately created. Therefore, after you call the CreateAccessPoint operation successfully, call the DescribeAccessPoints or DescribeAccessPoint operation to query the status of the access point. If the status is Active, mount the file system. Otherwise, the file system may fail to be mounted.
- Only General-purpose Network File System (NFS) file systems support access points.
- If you want to call the EnabledRam operation to enable a Resource Access Management (RAM) policy, you must configure the corresponding RAM permissions. For more information, see Manage endpoints.
Debugging
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 Resourcesis 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:CreateAccessPoint | create | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| FileSystemId | string | Yes | The ID of the file system. | 31a8e4**** |
| AccessGroup | string | Yes | 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 |
| VswId | string | Yes | The vSwitch ID. | vsw-2zevmwkwyztjuoffg**** |
| VpcId | string | Yes | The VPC ID. | vpc-2zesj9afh3y518k9o**** |
| AccessPointName | string | No | The name of the access point. | test |
| RootDirectory | string | No | The root directory of the access point. The default value is /. If the directory does not exist, you must also specify the OwnerUserId and OwnerGroupId parameters. | / |
| EnabledRam | boolean | No | Specifies whether to enable the RAM policy. Valid values:
Note
After the RAM policy is enabled for access points, no RAM user is allowed to use access points to mount and access data by default. To use access points to mount and access data as a RAM user, you must grant the related access permissions to the RAM user. If the RAM policy is disabled, access points can be anonymously mounted. For more information about how to configure permissions on access points, see Configure a policy for the access point.
| false |
| OwnerUserId | integer | No | The owner ID. This parameter is required if the RootDirectory directory does not exist. | 1 |
| OwnerGroupId | integer | No | The ID of the owner group. This parameter is required if the RootDirectory directory does not exist. | 1 |
| Permission | string | No | The Portable Operating System Interface for UNIX (POSIX) permission. Default value: 0777. This field takes effect only if you specify the OwnerUserId and OwnerGroupId parameters. | 0777 |
| PosixUserId | integer | No | The ID of the POSIX user. | 123 |
| PosixGroupId | integer | No | The ID of the POSIX user group. | 123 |
| PosixSecondaryGroupIds | string | No | The secondary user group. Separate multiple user group IDs with commas (,). | 123,345 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****\n",
"AccessPoint": {
"AccessPointDomain": "ap-ie15ydanoz.001014****-w****.cn-hangzhou.nas.aliyuncs.com",
"AccessPointId": "ap-ie15yd****"
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidRequest | The request is invalid. | Invalid request |
| 403 | InvalidProtocolType.NotSupported | The specified protocol type does not supported. | - |
| 403 | InvalidRamRole.NotExist | The specified RAM role does not exist. | The specified RAM role does not exist. |
| 403 | InvalidRamRole.NoPermission | The specified RAM role does not have sufficient permission. | The specified RAM role does not have sufficient permission. |
| 403 | OperationDenied.AccessPointCountsExceeded | The maxium number of access point has reached its limits. | The access point of the current file system has reached the upper limit. |
| 404 | InvalidAccessGroup.NotFound | The specified AccessGroup does not exist. | The permission group that you specified does not exist or has been deleted. |
| 404 | InvalidFileSystem.NotFound | The specified file system does not exist. | The specified file system does not exist. |
| 404 | InvalidVpc.NotFound | The specified Vpc is not found. | The specified VPC does not exist. Create a VPC first. |
| 404 | InvalidVswitch.NotFound | The specified VSwitch does not exist. | The specified switch does not exist. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|