All Products
Search

This Product

    Cloud Parallel File Storage:CreateProtocolMountTarget

    Document Center

    Cloud Parallel File Storage:CreateProtocolMountTarget

    Last Updated:Sep 08, 2026

    Creates an export directory for a protocol service.

    Operation description

    • This operation applies only to Cloud Parallel File Storage (CPFS) file systems.

    • Before you begin

      The target CPFS file system must be in the Running state, and a protocol service must have been created.

    • Other information

      • The VPC CIDR block of the protocol service export must not overlap with the VPC CIDR block of the file system.

      • The VPC CIDR blocks of multiple exports on the same protocol service must not overlap with each other.

      • You can create up to 10 export directories for a single protocol service.

      • Creating a protocol service export directory consumes IP addresses from the specified vSwitch (up to 32 IP addresses). Make sure that the target vSwitch has sufficient IP address resources.

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

    create

    *FileSystem

    acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ProtocolServiceId

    string

    Yes

    The ID of the protocol service.

    ptc-197ed6a00f2b****
    FileSystemId

    string

    Yes

    The ID of the file system.

    Note

    The target CPFS file system must be in the Running state before you call this operation. After creation, it takes approximately 20 to 40 minutes for the file system to reach the Running state. You can call DescribeFileSystems to poll the Status field (Running indicates ready).

    cpfs-099394bd928c****
    VpcId

    string

    No

    The ID of the VPC for the protocol service export.

    Note

    The CIDR block of the selected VPC must not overlap with the VPC CIDR block of the target CPFS file system. You can call the DescribeVpcs operation of VPC to query the CidrBlock field of each VPC for comparison, and select a VPC that does not conflict and is in the same zone as the file system.

    vpc-2vct297b8157bth9z****
    VSwitchId

    string

    No

    The ID of the vSwitch for the protocol service export.

    If the storage redundancy type of the file system is not zone-redundant storage (ZRS), this parameter is required when VpcId is specified.

    Note

    The vSwitch must be in the same zone as the target CPFS file system (the ZoneId values must match). You can call DescribeFileSystems to query the ZoneId field of the file system, and then select a vSwitch in the same zone.

    vsw-2vc3c2lybvdllxyq4****
    FsetId

    string

    No

    The ID of the fileset to export.

    Limits:

    • The fileset must already exist.

    • Only one export directory can be created for each fileset.

    • You must specify one and only one of FsetId and Path.

    fset-1902718ea0ae****
    Path

    string

    No

    The path of the CPFS directory to export.

    Limits:

    • The directory must already exist on the CPFS file system.

    • Only one export can be created for the same directory.

    • You must specify one and only one of FsetId and Path.

    Format:

    • The path must be 1 to 1,024 characters in length.

    • The path must be encoded in UTF-8.

    • The path must start and end with a forward slash (/). The root directory is /.

    /
    AccessGroupName

    string

    No

    The name of the permission group.

    Default value: DEFAULT_VPC_GROUP_NAME.

    DEFAULT_VPC_GROUP_NAME
    Description

    string

    No

    The description of the protocol service export directory. This is displayed as Export Directory Name in the console.

    Limits:

    • The description must be 2 to 128 characters in length and can contain letters and Chinese characters.

    • The description must start with a letter or a Chinese character. It cannot start with http:// or https://.

    • The description can contain digits, colons (:), underscores (_), and hyphens (-).

    Description of this export directory
    ClientToken

    string

    No

    Ensures the idempotence of the request. Generate a parameter value from your client to ensure that the value is unique across different requests.

    ClientToken supports only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

    Note

    If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may vary for each API request.

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
    DryRun

    boolean

    No

    Specifies whether to perform a dry run for this request. A dry run checks parameter validity and dependencies without actually creating the instance or incurring charges.

    Valid values:

    • true: Sends a dry run request without creating the export directory. The check items include whether required parameters are specified, request format, and business limit dependencies. If the check fails, the corresponding error is returned. If the check passes, HTTP status code 200 is returned, but ExportId is empty.

    • false (default): Sends a normal request. After the check passes, the instance is directly created.

    true
    VSwitchIds

    array

    No

    The list of vSwitch IDs for the protocol service export.

    string

    No

    The list of vSwitch IDs for the protocol service export.

    If the storage redundancy type of the file system is zone-redundant storage (ZRS), you must specify vSwitch IDs in three different zones within the VPC when VpcId is specified.

    vsw-123xxx

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The request ID.

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    ExportId

    string

    The ID of the protocol service export directory.

    exp-19abf5beab8d****

    Examples

    Success response

    JSON format

    {
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "ExportId": "exp-19abf5beab8d****"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 MissingFileSystemId FileSystemId is mandatory for this action. The FileSystemId parameter is not specified.
    400 MissingProtocolServiceId ProtocolServiceId is mandatory for this action. The ProtocolServiceId parameter is not specified.
    403 Instance.IncorrectStatus The specified instance is in an incorrect status. The operation is not allowed in the current state.
    403 InvalidVSwitchId.IpShortage The specified vswitch ip shortage.
    403 InvalidFset.InUse Fset already used by other export. The specified Fileset is already in use.
    403 MntPathConflict.InvalidParam FilesetId and Path must and can only be specified one. Exactly one of Fileset and Path must be specified.
    403 OperationDenied.TooManyDepth The operation is denied due to Fsets path too deep. The intelligent directory path depth exceeds the threshold.
    403 OperationDenied.InvalidPtcStatus The operation is denied due to invalid protocol service status. The current protocol service status does not support this operation.
    403 OperationDenied.InvalidState The operation is denied due to invalid file system state.
    403 OperationDenied.CrossVPCExceedLimit Cross vpc mount exceed limit. The number of cross-VPC export directories has exceeded the upper limit of the current protocol service specification.
    403 OperationDenied.NoMountTargetQuota No mount target quota on this protocol service. The export directory quota of the protocol service is exhausted.
    403 OperationDenied.NotSupported The operation is denied due to not supported. The file system does not support the protocol service.
    404 InvalidFileSystem.NotFound The specified file system does not exist. The specified file system does not exist.
    404 InvalidProtocolService.NotFound The specified protocol service does not exist. The specified protocol service does not exist.
    404 InvalidVpcId.ConflictVpcCidr Vpc cidr conflict with file system The CIDR block of the specified VPC overlaps with the CIDR block of the file system VPC.
    404 InvalidFsetId.NotFound The specified fileset ID does not exist.
    404 Fset.IncorrectStatus The specified fset is in an incorrect status. The specified Fileset is unavailable.
    404 InvalidFileSystemPath.InvalidCharacters The specified fileset path contains invalid characters. The specified Fileset path contains invalid characters.
    404 InvalidAccessGroupName.NotFound The specified access group does not exist. The specified permission group does not exist.
    404 InvalidAccessGroupName.NotAccessRule There has no rule in access group. The specified permission group contains no rules.
    404 InvalidDescription.InvalidFormat Description format is invalid. The specified description format is invalid.
    404 InvalidParameter.VpcNotFound The specified VPC does not exist. The specified VPC does not exist.
    404 InvalidParameter.VswNotFound The specified VSwitch does not exist.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.