All Products
Search

This Product

    Cloud Parallel File Storage:CreateProtocolService

    Document Center

    Cloud Parallel File Storage:CreateProtocolService

    Last Updated:Dec 03, 2025

    Creates a protocol service for a Cloud Parallel File Storage (CPFS) file system. The creation takes about 5 to 10 minutes.

    Operation description

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

    • Only CPFS V2.3.0 and later support protocol services. You can query the version information of the file system by calling the DescribeFileSystems operation.

    • Protocol service types

      Protocol services are classified into general-purpose protocol services and cache protocol services. Different from general-purpose protocol services, cache protocol services can cache hot data. If data exists in the cache, the bandwidth of the cache protocol service may exceed the bandwidth of the CPFS file system, reaching the maximum bandwidth specified for the protocol service.

      • General-purpose protocol services: provide NFS access and directory-level mount targets for CPFS file systems. You do not need to configure a POSIX client to manage clusters. The compliance package check feature is free of charge.
      • Cache protocol services: provide the server memory cache based on the least recently used (LRU) policy. When data is cached in the memory, CPFS provides higher internal bandwidth. Cache protocol services are divided into Cache L1 and Cache L2 specifications. The differences are the internal bandwidth size and memory cache size.

      **

      Note You are charged for using cache protocol services, which are in invitational preview. For more information about the billing method of cache protocol services, see Billable items. If you have any feedback or questions, you can join the DingTalk group (group number: 31045006299).

    • Protocol Type

      Only NFSv3 is supported.

    • Others

      • Only one protocol service can be created for a CPFS file system.
      • 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:CreateProtocolServicecreate
    *FileSystem
    acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    FileSystemIdstringYes

    The ID of the file system.

    		cpfs-123****
    ProtocolSpecstringYes

    The specification of the protocol service.

    Set the value to General (default).

    Valid values:

    • CL2
    • General
    • CL1
    		General
    ThroughputintegerNo

    The throughput of the protocol service.

    Unit: MB/s.

    		8000
    ProtocolTypestringYes

    The protocol type of the protocol service.

    Valid value: NFS (default). Only NFSv3 is supported.

    		NFS
    DescriptionstringNo

    The description of the protocol service. The name of the protocol service appears in the console.

    Limits:

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

    The virtual private cloud (VPC) ID of the protocol service. The VPC ID of the protocol service must be the same as the VPC ID of the file system.

    		vpc-123****
    VSwitchIdstringYes

    The vSwitch ID of the protocol service.

    		vsw-123****
    DryRunbooleanNo

    Specifies whether to perform a dry run.

    The dry run checks parameter validity and prerequisites. The dry run does not create a protocol service or incur fees.

    Valid values:

    • true: performs only a dry run and does not create the protocol service. 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 ProtocolServiceId parameter.
    • false (default): performs a dry run and sends the request. If the request passes the dry run, a protocol service is created.
    		false
    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.
    		123e4567-e89b-12d3-a456-42665544****

    Response parameters

    ParameterTypeDescriptionExample
    object

    Schema of Response

    RequestIdstring

    The request ID.

    		98696EF0-1607-4E9D-B01D-F20930B6****
    ProtocolServiceIdstring

    The ID of the protocol service.

    		ptc-123****

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****",
  "ProtocolServiceId": "ptc-123****"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400MissingFileSystemIdFileSystemId is mandatory for this action.-
    400MissingVpcIdVpcId is mandatory for this action.-
    400MissingVSwitchIdVSwitchId is mandatory for this action.-
    403InvalidProtocolSpec.NotSupportedThe specified protocol spec does not supported.-
    403InvalidNetworkType.NotSupportedThe specified network type does not supported.-
    403Instance.IncorrectStatusThe specified instance is in an incorrect status.-
    403OperationDenied.ProtocolServiceExceedLimitThe protocol service amount exceed file system limit.-
    403PermissionDenied.CapacityTooLowCapacity of file system too low to subscribe protocol service.-
    403PermissionDenied.ThroughputInvalidStandard protocol service should not specified throughput.-
    403PermissionDenied.ThroughputTooSmallThroughput of protocol service too small.-
    403PermissionDenied.ThroughputExceedThroughput of protocol service must less than throughput of file system.-
    403InvalidProtocolType.NotSupportedThe specified protocol type does not supported.-
    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.-
    403InvalidFileSystemPath.InvalidCharactersThe specified filesystem path contains invalid characters.-
    403MntPathConflict.InvalidParamFilesetId and Path must and can only be specified one.-
    403OperationDenied.TooManyDepthThe operation is denied due to Fsets path too deep.-
    403OperationDenied.InvalidStateThe operation is denied due to invalid file system state.-
    403OperationDenied.NoProtocolServiceQuotaNo protocol service quota.-
    403OperationDenied.NotSupportedThe operation is denied due to not supported.-
    403PermissionDenied.CLThroughputInvalidThroughput of caching protocol service is invalid.-
    403InvalidVpcId.CrossVpcNotSupport.Cross VPC not support.-
    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.
    404InvalidFileSystem.NotFoundThe specified file system does not exist.The specified file system does not exist.
    404InvalidDescription.InvalidFormatDescription format is invalid.-
    404InvalidVpcId.ConflictVpcCidrVpc cidr conflict with file system-
    404InvalidAccessGroupName.NotFoundThe specified access group does not exist.-
    404InvalidAccessGroupName.NotAccessRuleThere has no rule in access group.-
    404OperationDenied.NoStockThe operation is denied due to no stock.-
    404PathNotExistInFileSystem.InvalidParamGiven path does not exist in file system.-
    404InvalidFsetId.NotFoundThe specified Fileset ID does not exist.-
    404InvalidParameter.VpcVswitchMismatchGiven vSwitch mismatch with given VPC.-

    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