CreateFileset - 创建文件集

更新时间:

创建一个Fileset。

接口说明

  • CPFS 使用说明

    • 仅支持 CPFS 2.2.0 及以上版本创建 Fileset。您可以在控制台文件系统详情页面查看版本信息。
    • 单个 CPFS 文件系统最多支持创建 10 个 Fileset。
    • 父目录必须是已存在的目录。
    • Fileset 路径支持的最大深度为 8 层,根目录/为 0 层。例如,Fileset 路径为/test/aaa/ccc/,则表示路径深度为 3 层。
    • 不支持 Fileset 中嵌套 Fileset。即当父目录已指定为 Fileset,其子目录不支持指定为 Fileset。
    • Fileset 最多支持 100 万个文件,如果文件数量超过此上限,添加新文件会返回no space错误信息。
  • CPFS 智算版使用说明

    • 仅支持 CPFS 智算版 2.7.0 及以上版本创建 Fileset。您可以在控制台文件系统详情页面查看版本信息。
    • 单个 CPFS 文件系统最多支持创建 500 个 Fileset。
    • Fileset 路径必须为新路径,不能为已存在路径,Fileset 路径不支持重命名,不支持路径为软链接。
    • Fileset 路径支持的最大深度为 8 层,根目录/为 0 层。例如,Fileset 路径为/test/aaa/ccc/,则表示路径深度为 3 层。
    • Fileset 路径为多层目录时,父目录必须是已存在的目录。
    • 不支持在 Fileset 中嵌套 Fileset,即当父目录已指定为 Fileset,其子目录不支持指定为 Fileset。一个 Fileset 路径只支持一个配额。
    • Fileset 容量配额,最小起步 10 GiB,扩容单位为 1 GiB,上限为 1000 TiB,容量配额不能超过文件系统的总容量。
    • Fileset 最多支持 100 亿个文件或目录,最小起步 10000,扩容单位为 1。
    • 修改目录配额时,设置的配额容量或文件数必须高于已使用容量或文件数。
    • 配额的统计有 5 分钟的延迟,当前的实际使用量 5 分钟之后才会生效。

调试

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

授权信息

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

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

请求参数

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

文件系统 ID。

  • CPFS:必须以cpfs-开头,例如 cpfs-099394bd928c****。

  • CPFS 智算版:必须以bmcpfs-开头,例如 bmcpfs-290w65p03ok64ya****。

说明 国际站不支持 CPFS。
bmcpfs-290w65p03ok64ya****
FileSystemPathstring

待创建的 Fileset 的绝对路径。

  • CPFS 路径限制。
    • 指定目录的父目录必须是文件系统中已存在的目录。
    • 长度为 2~1024 个字符。
    • 指定目录必须以正斜线(/)开头和结尾。
  • CPFS 智算版路径限制。
    • 长度为 2~1024 个字符。
    • 指定目录必须以正斜线(/)开头和结尾。
    • Fileset 路径必须为新路径,不能为已存在路径,Fileset 路径不支持重命名,不支持路径为软链接。
    • Fileset 路径支持的最大深度为 8 层,根目录/为 0 层。例如,Fileset 路径为/test/aaa/ccc/,则表示路径深度为 3 层。
    • Fileset 路径为多层目录时,父目录必须是已存在的目录。
    • 不支持在 Fileset 中嵌套 Fileset,即当父目录已指定为 Fileset,其子目录不支持指定为 Fileset。一个 Fileset 路径只支持一个配额。
/test/
DryRunboolean

是否对此次创建请求执行预检。

预检操作会帮助您检查参数有效性、校验库存等,并不会实际创建实例,也不会产生费用。

取值:

  • true:发送检查请求,不会创建实例。检查项包括是否填写了必需参数、请求格式、业务限制和 NAS 库存。如果检查不通过,则返回对应错误。如果检查通过,则返回 200 HttpCode,但 FsetId 为空。
  • false(默认):发送正常请求,通过检查后直接创建实例。
false
DeletionProtectionboolean

实例释放保护属性,指定是否支持通过控制台或 API( DeleteFileset )释放实例。

  • true:开启实例释放保护。
  • false(默认):关闭实例释放保护。
说明 该属性只能限制手动释放操作,对系统释放操作不生效。
false
Descriptionstring

Fileset 的描述信息。

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

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

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

说明 若用户未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
123e4567-e89b-12d3-a456-42665544****
Quotaobject

配额信息。

说明 仅 CPFS 智算版 2.7.0 及以上版本支持此参数。
FileCountLimitlong

配额文件数量限制。取值范围:

  • 最小值:10,000。

  • 最大值:10,000,000,000。

10000
SizeLimitlong

配额总容量限制。单位:Byte。

取值范围:

  • 最小值:10,737,418,240(10 GiB)。

  • 最大值:1,073,741,824,000(1,024,000 GiB)。

  • 步长:107,3741,824(1 GiB)。

10737418240

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

Fileset ID。

fset-1902718ea0ae****

示例

正常返回示例

JSON格式

{
  "RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****",
  "FsetId": "fset-1902718ea0ae****"
}

错误码

HTTP status code错误码错误信息描述
400IllegalCharactersThe parameter contains illegal characters.参数非法。
400MissingFileSystemIdFileSystemId is mandatory for this action.未指定FileSystemId参数。
400MissingFileSystemPathFileSystemPath is mandatory for this action.缺少FileSystemPath参数。
400InvalidFilesystemType.NotSupportThis Api does not support this fileSystem type.当前接口不支持该类型文件系统。
400InvalidFilesystemVersion.NotSupportThis Api does not support this fileSystem version.当前接口不支持该版本文件系统。
400InvalidRequestThe request is invalid.请求无效。
400Quota.Invalid.LimitQuota limit is invalid.无效的配额。
400Resource.Exceed.LimitResource exceed limit.资源数量超过限制。
400Resource.Check.FailResource check failed.资源检查失败。
400Fileset.Path.DuplicateFileset path is duplicate.Fileset路径已存在。
400Fileset.Path.NestedFileset path is nested.Fileset路径存在嵌套。
400Fileset.Path.NotExistFileset.Path.Not.Exist.Fileset父目录路径不存在。
400Fileset.Path.ExistFileset already exist.Fileset路径已经存在。
403OperationDenied.AlreadyExistsThe operation is denied due to IdirName already exists in parent path.创建的目录名在父目录中已存在。
403OperationDenied.TooManyFilesetsThe operation is denied due to too many fileset in filesystem.文件系统的Fileset目录数量超过阈值。
403OperationDenied.TooManyDepthsThe operation is denied due to Fileset path too deep.Fileset目录路径深度超过阈值。
403OperationDenied.NestedDirThe operation is denied due to nested directory.目录存在嵌套导致无法创建自动更新配置。
403OperationDenied.DependencyViolationThe operation is denied due to dependancy violation.进行该操作的条件不满足。
403OperationDenied.FilesetNotSupportedThe operation is not supported.该文件系统不支持Fileset。
404InvalidFileSystem.NotFoundThe specified file system does not exist.指定的文件系统不存在。
404InvalidFileSystemPath.ParentNotFoundThe specified parent path does not exist.指定的父目录不存在。
404InvalidFileSystemPath.NotDirectoryThe specified idir parent path is not directory.指定的父目录不是目录。
404InvalidFileSystemPath.InvalidCharactersThe specified fileset path contains invalid characters.指定的Fileset路径包含非法字符。
404InvalidFilesetPath.InvalidParameterFileset path is invalid.指定的Fileset路径无效。

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

变更历史

变更时间变更内容概要操作
2024-10-24OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2024-05-31OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2023-04-24OpenAPI 错误码发生变更查看变更详情