CreateProtocolService_文件存储（NAS/CPFS）_API文档-阿里云OpenAPI开发者门户

接口说明

该接口仅适用于中国站 CPFS 文件系统。
仅 CPFS 2.3.0 及以上版本支持协议服务。您可以通过调用 DescribeFileSystems 接口查询目标文件系统的版本号。
协议服务规格

协议服务包括两种协议类型：通用型和缓存型。缓存型相比通用型，提供热点数据缓存能力。在命中缓存的情况下，缓存型协议服务的带宽可超过 CPFS 文件系统的带宽，达到协议服务设定的最大带宽值。
- 通用型：为 CPFS 提供 NFS 协议访问能力和目录级挂载点，用户无需配置 POSIX 客户端管理集群。该功能免费。
- 缓存型：在通用型基础上提供基于 LRU 策略的服务端内存缓存。当数据缓存于内存中时，CPFS 可提供更高的内网带宽。缓存型协议服务分为缓存 1 型和缓存 2 型两种协议服务规格，差异点为内网带宽大小和内存缓存大小。
说明缓存型协议服务为收费服务，正在邀测。有关缓存型协议服务的付费方式，请参见计费项。如果您有任何反馈或疑问，欢迎加入钉钉用户群（钉钉群号：31045006299）与 CPFS 工程师进行交流讨论。
协议类型

仅支持 NFSv3 协议。
其它
- 一个 CPFS 文件系统只能创建一个协议服务。
- 创建协议服务会消耗指定 vSwitch 上的 IP 地址（最多消耗 32 个 IP 地址），请确保目标 vSwitch IP 资源充足。

流控信息

请求速率为100/1(s)。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

nas:CreateProtocolService	Create	FileSystem acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId}	无	无

请求参数

字段名称	字段详情
FileSystemIdstring	文件系统 ID。示例值:cpfs-099394bd928c****枚举值:参考取值来源: CreateFileSystem DescribeFileSystems SetFilesetQuota
ProtocolSpecstring	协议服务的规格。展开详情示例值:General枚举值:CL2GeneralCL1参考取值来源: DescribeProtocolService
Throughputinteger<int32>	协议服务的带宽。展开详情示例值:8000
ProtocolTypestring	协议服务的协议类型。展开详情示例值:NFS参考取值来源: DescribeProtocolService
Descriptionstring	协议服务的描述。控制台中显示为“协议服务名称”。展开详情示例值:此协议服务的描述。
VpcIdstring	协议服务 VpcId，需与文件系统 VPC 保持一致。示例值:vpc-2vct297b8157bth9z****
VSwitchIdstring	协议服务 VSwitchId。示例值:vsw-2vc3c2lybvdllxyq4****
DryRunboolean	是否对此次创建请求执行预检。展开详情示例值:false
ClientTokenstring	保证请求幂等性，从您的客户端生成一个参数值，确保不同请求间该参数值唯一。展开详情示例值:123e4567-e89b-12d3-a456-42665544****字符长度 <= 64字符长度 >= 1

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:98696EF0-1607-4E9D-B01D-F20930B6****
ProtocolServiceIdstring	协议机集群 ID。示例值:ptc-197ed6a00f2b****

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

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.	诊断
404	InvalidParameter.VswNotFound	The specified VSwitch does not exist.	诊断
404	InvalidFileSystem.NotFound	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.	诊断

变更历史

	变更时间	变更内容概要	操作
	2022-04-28	新增OpenAPI，创建协议服务

CreateProtocolService_文件存储（NAS/CPFS）_API文档

接口说明

流控信息

授权信息

请求参数

返回参数

返回示例

错误码

变更历史

相关示例