文档

CreateProtocolMountTarget - 创建协议服务导出目录

更新时间:

创建一个协议服务导出目录。

接口说明

  • 该接口仅适用于中国站 CPFS 文件系统。

  • 前提条件

    已创建协议服务。

  • 其它

    • 协议服务的导出 VPC 网段不可与文件系统 VPC 网段重叠。
    • 一个协议服务上的多个导出 VPC 之间网段不可重叠。
    • 同一个协议服务最多可以创建 10 个导出目录。
    • 创建协议服务导出目录会消耗指定 vSwitch 上的 IP 地址(最多消耗 32 个 IP 地址),请确保目标 vSwitch IP 资源充足。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
nas:CreateProtocolMountTargetWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ProtocolServiceIdstring

协议服务 ID。

ptc-197ed6a00f2b****
FileSystemIdstring

文件系统 ID。

cpfs-099394bd928c****
VpcIdstring

协议服务导出的专有网络 ID。

vpc-2vct297b8157bth9z****
VSwitchIdstring

协议服务导出的交换机 ID。

vsw-2vc3c2lybvdllxyq4****
FsetIdstring

需导出的 Fileset ID。

限制:

  • 该 Fileset 必须已存在。
  • 一个 Fileset 只允许创建一个导出目录。
  • Fileset 和 Path 只能且必须指定一个。
fset-1902718ea0ae****
Pathstring

需导出的 CPFS 目录的路径。

限制:

  • 该目录必须是 CPFS 上的已有目录。
  • 同一目录只允许创建一个导出。
  • Fileset 和 Path 只能且必须指定一个。

格式:

  • 长度为 1~1024 个字符。
  • 使用 UTF-8 编码。
  • 必须以正斜线(/)开头和结尾,根目录为/
/
AccessGroupNamestring

权限组名称。

默认值:DEFAULT_VPC_GROUP_NAME

DEFAULT_VPC_GROUP_NAME
Descriptionstring

协议服务导出目录的描述。控制台中显示为导出目录名称

限制:

  • 长度为 2~128 个英文或中文字符。
  • 必须以大小写字母或中文开头,不能以http://https://开头。
  • 可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。
此导出目录的描述
ClientTokenstring

保证请求幂等性,从您的客户端生成一个参数值,确保不同的请求间该参数值唯一。

ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性

说明 若用户未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
DryRunboolean

是否对此次创建请求执行预检。 预检操作会帮助您检查参数有效性、依赖条件等,并不会实际创建实例,也不会产生费用。

取值:

  • true:发送检查请求,不会创建导出目录。检查项包括是否填写了必需参数、请求格式、业务限制依赖条件。如果检查不通过,则返回对应错误。如果检查通过,则返回 200 HttpCode,但 ExportId 为空。

  • false(默认):发送正常请求,通过检查后直接创建实例。

true

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

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

协议服务导出目录 ID。

exp-19abf5beab8d****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400MissingFileSystemIdFileSystemId is mandatory for this action.未指定FileSystemId参数。
400MissingProtocolServiceIdProtocolServiceId is mandatory for this action.未指定ProtocolServiceId参数。
403Instance.IncorrectStatusThe specified instance is in an incorrect status.当前状态不允许操作。
403InvalidVSwitchId.IpShortageThe specified vswitch ip shortage.指定的vSwitch可用IP不足。
403InvalidFset.InUseFset already used by other export.指定的Fileset已被使用。
403MntPathConflict.InvalidParamFilesetId and Path must and can only be specified one.Fileset和Path只能且必须指定一个。
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.跨VPC导出目录数量超过当前协议服务规格上限。
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.指定的文件系统不存在。
404InvalidProtocolService.NotFoundThe specified protocol service does not exist.指定的协议服务不存在。
404InvalidVpcId.ConflictVpcCidrVpc cidr conflict with file system指定VPC与文件系统VPC网段重叠。
404InvalidFsetId.NotFoundThe specified fileset ID does not exist.指定的Fileset不存在。
404Fset.IncorrectStatusThe specified fset is in an incorrect status.指定的Fileset不可用。
404InvalidFileSystemPath.InvalidCharactersThe specified fileset path contains invalid characters.指定的Fileset路径包含非法字符。
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.指定的VPC网络不存在。
404InvalidParameter.VswNotFoundThe specified VSwitch does not exist.指定的虚拟交换机不存在。

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈