All Products
Search

This Product

    Cloud Parallel File Storage:CreateProtocolMountTarget

    Document Center

    Cloud Parallel File Storage:CreateProtocolMountTarget

    Last Updated:Dec 03, 2025

    Creates an export directory for a protocol service.

    Operation description

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

    • Prerequisites

      A protocol service is created.

    • Others

      • The virtual private cloud (VPC) CIDR block of the export directory for the protocol service cannot overlap with the VPC CIDR block of the file system.
      • The VPC CIDR blocks of multiple export directories of a protocol service cannot overlap.
      • You can create a maximum of 10 export directories for a protocol service.
      • A protocol service can use a maximum of 32 IP addresses that are allocated by a specified vSwitch. Make sure that the vSwitch can provide sufficient IP addresses.

    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:
      • For mandatory resource types, indicate with a prefix of * .
      • 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:CreateProtocolMountTargetcreate
    *FileSystem
    acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ProtocolServiceIdstringYes

    The ID of the protocol service.

    		ptc-123****
    FileSystemIdstringYes

    The ID of the file system.

    		cpfs-123****
    VpcIdstringYes

    The VPC ID of the export directory for the protocol service.

    		vpc-123****
    VSwitchIdstringYes

    The vSwitch ID of the export directory for the protocol service.

    		vsw-123****
    FsetIdstringNo

    The ID of the fileset that you want to export.

    Limits:

    • The fileset already exists.
    • You can create only one export directory for a fileset.
    • You can specify either a fileset or a path.
    		fset-123****
    PathstringNo

    The path of the CPFS directory that you want to export.

    Limits:

    • The directory already exists in the CPFS file system.
    • You can create only one export directory for a directory.
    • You can specify either a fileset or a 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 /.
    		/
    AccessGroupNamestringNo

    The name of the permission group.

    Default value: DEFAULT_VPC_GROUP_NAME.

    		DEFAULT_VPC_GROUP_NAME
    DescriptionstringNo

    The description of the export directory for the protocol service. The name of the export directory appears in the console.

    Limits:

    • The description must be 2 to 128 characters in length.
    • The description must start with a letter but cannot start with http:// or https://.
    • The description can contain letters, digits, colons (:), underscores (_), and hyphens (-).
    		test
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests.

    The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How do I ensure the idempotence?

    Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
    		473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
    DryRunbooleanNo

    Specifies whether to perform a dry run. The dry run checks parameter validity and prerequisites. The dry run does not create an export directory or incur fees.

    Valid values:

    • true: performs a dry run. The system checks the request format, service limits, prerequisites, and whether the required parameters are specified. If the request fails the dry run, an error message is returned. If the request passes the dry run, the HTTP status code 200 is returned. No value is returned for the ExportId parameter.
    • false (default): performs a dry run and sends the request. If the request passes the dry run, an export directory is created.
    		true

    Response parameters

    ParameterTypeDescriptionExample
    object

    Schema of Response

    RequestIdstring

    The request ID.

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

    The ID of the export directory for the protocol service.

    		exp-123****

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400MissingFileSystemIdFileSystemId is mandatory for this action.-
    400MissingProtocolServiceIdProtocolServiceId is mandatory for this action.-
    403Instance.IncorrectStatusThe specified instance is in an incorrect status.-
    403InvalidVSwitchId.IpShortageThe specified vswitch ip shortage.The available IP addresses within the CIDR block of the specified vSwitch are insufficient.
    403InvalidFset.InUseFset already used by other export.-
    403MntPathConflict.InvalidParamFilesetId and Path must and can only be specified one.-
    403OperationDenied.TooManyDepthThe operation is denied due to Fsets path too deep.-
    403OperationDenied.InvalidPtcStatusThe operation is denied due to invalid protocol service status.-
    403OperationDenied.InvalidStateThe operation is denied due to invalid file system state.-
    403OperationDenied.CrossVPCExceedLimitCross vpc mount exceed limit.-
    403OperationDenied.NoMountTargetQuotaNo mount target quota on this protocol service.-
    403OperationDenied.NotSupportedThe operation is denied due to not supported.-
    404InvalidFileSystem.NotFoundThe specified file system does not exist.The specified file system does not exist.
    404InvalidProtocolService.NotFoundThe specified protocol service does not exist.-
    404InvalidVpcId.ConflictVpcCidrVpc cidr conflict with file system-
    404InvalidFsetId.NotFoundThe specified fileset ID does not exist.-
    404Fset.IncorrectStatusThe specified fset is in an incorrect status.-
    404InvalidFileSystemPath.InvalidCharactersThe specified fileset path contains invalid characters.-
    404InvalidAccessGroupName.NotFoundThe specified access group does not exist.-
    404InvalidAccessGroupName.NotAccessRuleThere has no rule in access group.-
    404InvalidDescription.InvalidFormatDescription format is invalid.-
    404InvalidParameter.VpcNotFoundThe specified VPC does not exist.The specified VPC does not exist.
    404InvalidParameter.VswNotFoundThe specified VSwitch does not exist.The specified vSwitch does not exist.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-09-05The Error code has changedView Change Details