CreateProtocolService-阿里云帮助中心

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

Operation description

This operation is applicable only to CPFS file systems.
Only CPFS 2.3.0 and later support protocol services. You can call the DescribeFileSystems operation to query the version of the file system.
Protocol service specifications.

Protocol services include two Protocol Types: General and Cache. Compared with the General type, the Cache type provides hot spot data caching. When the cache is hit, the bandwidth of the Cache type protocol service can exceed the bandwidth of the CPFS file system and reach the maximum bandwidth configured for the protocol service.
- General: Provides NFS protocol access and folder-level mount targets for CPFS. You do not need to configure a POSIX client cluster management. This feature is free of charge.
- Cache: Provides server-side in-memory caching based on the LRU policy in addition to the General type capabilities. When data is cached in memory, CPFS can provide higher internal network bandwidth. The Cache type protocol service is available in two specifications: Cache L1 and Cache L2, which differ in internal network bandwidth and memory cache size.
Note
The Cache type protocol service is a paid service and is in invitational preview. For information about the billing of the Cache type protocol service, see Billable items. If you have any feedback or questions, join the DingTalk user group (group ID: 31045006299) to communicate with CPFS engineers.
Protocol type.

Only NFSv3 is supported.
Prerequisites.

The CPFS file system must be created and in the Running state.
Other information.
- Only one protocol service can be created for each CPFS file system.
- Creating a protocol service consumes IP addresses on 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:CreateProtocolService

create

*FileSystem

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

None

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	The file system ID.	cpfs-099394bd928c****
ProtocolSpec	string	Yes	The specification of the protocol service. Valid values: General (default). Valid values: CL2 : Cache L2. General : General. CL1 : Cache L1.	General
Throughput	integer	No	The bandwidth of the protocol service. Unit: MB/s.	8000
ProtocolType	string	Yes	The protocol type of the protocol service. Valid values: NFS (default). Only NFSv3 access is supported.	NFS
Description	string	No	The description of the protocol service. This value is displayed as "Protocol service name" in the console. Limits: The description must be 2 to 128 characters in length. The description must start with a letter or Chinese character and cannot start with `http://` or `https://`. The description can contain digits, colons (:), underscores (_), and hyphens (-).	此协议服务的描述。
VpcId	string	No	The VPC ID of the protocol service. The VPC must be the same as the VPC of the file system. If the storage redundancy type of the file system is zone-redundant storage (ZRS), do not set this parameter. Otherwise, this parameter is required.	vpc-2vct297b8157bth9z****
VSwitchId	string	No	The vSwitch ID of the protocol service. If the storage redundancy type of the file system is zone-redundant storage (ZRS), do not set this parameter. Otherwise, this parameter is required.	vsw-2vc3c2lybvdllxyq4****
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 check request without creating the protocol service. The check items include whether required parameters are specified, the 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 ProtocolServiceId is empty. false (default): Sends a normal request. After the check passes, the instance is directly created.	false
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but 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 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 differ for each API request.	123e4567-e89b-12d3-a456-42665544****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	98696EF0-1607-4E9D-B01D-F20930B6****
ProtocolServiceId	string	The protocol service cluster ID.	ptc-197ed6a00f2b****

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	MissingFileSystemId	FileSystemId is mandatory for this action.
400	MissingVpcId	VpcId is mandatory for this action.
400	MissingVSwitchId	VSwitchId is mandatory for this action.
403	InvalidProtocolSpec.NotSupported	The specified protocol spec does not supported.
403	InvalidNetworkType.NotSupported	The specified network type does not supported.
403	Instance.IncorrectStatus	The specified instance is in an incorrect status.
403	OperationDenied.ProtocolServiceExceedLimit	The protocol service amount exceed file system limit.
403	PermissionDenied.CapacityTooLow	Capacity of file system too low to subscribe protocol service.
403	PermissionDenied.ThroughputInvalid	Standard protocol service should not specified throughput.
403	PermissionDenied.ThroughputTooSmall	Throughput of protocol service too small.
403	PermissionDenied.ThroughputExceed	Throughput of protocol service must less than throughput of file system.
403	InvalidProtocolType.NotSupported	The specified protocol type does not supported.
403	InvalidVSwitchId.IpShortage	The specified vswitch ip shortage.
403	InvalidFset.InUse	Fset already used by other export.
403	InvalidFileSystemPath.InvalidCharacters	The specified filesystem path contains invalid characters.
403	MntPathConflict.InvalidParam	FilesetId and Path must and can only be specified one.
403	OperationDenied.TooManyDepth	The operation is denied due to Fsets path too deep.
403	OperationDenied.InvalidState	The operation is denied due to invalid file system state.
403	OperationDenied.NoProtocolServiceQuota	No protocol service quota.
403	OperationDenied.NotSupported	The operation is denied due to not supported.
403	PermissionDenied.CLThroughputInvalid	Throughput of caching protocol service is invalid.
403	InvalidVpcId.CrossVpcNotSupport.	Cross VPC not support.
404	InvalidParameter.VpcNotFound	The specified VPC does not exist.	The specified VPC does not exist.
404	InvalidParameter.VswNotFound	The specified VSwitch does not exist.
404	InvalidFileSystem.NotFound	The specified file system does not exist.	The specified file system does not exist.
404	InvalidDescription.InvalidFormat	Description format is invalid.
404	InvalidVpcId.ConflictVpcCidr	Vpc cidr conflict with file system
404	InvalidAccessGroupName.NotFound	The specified access group does not exist.
404	InvalidAccessGroupName.NotAccessRule	There has no rule in access group.
404	OperationDenied.NoStock	The operation is denied due to no stock.
404	PathNotExistInFileSystem.InvalidParam	Given path does not exist in file system.
404	InvalidFsetId.NotFound	The specified Fileset ID does not exist.
404	InvalidParameter.VpcVswitchMismatch	Given vSwitch mismatch with given VPC.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.