CreateFileSystem_文件存储(NAS/CPFS)_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • 请确保在使用该接口前,已充分了解 NAS 产品的计费说明和价格。更多信息,请参见计费说明价格

  • 创建文件系统实例需要通过实名认证。具体操作,请参见账号实名认证

  • 调用此接口将自动创建操作所需的 NAS 服务关联角色。更多信息,请参见管理 NAS 服务关联角色

流控信息

请求速率为120/60(s)。

授权信息

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

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
nas:CreateFileSystem
Create
FileSystem
acs:nas:{#regionId}:{#accountId}:filesystem/*
nas:EncryptedType
nas:FileSystemType

请求参数

字段名称字段详情
FileSystemTypestring

文件系统类型。展开详情

示例值:standard枚举值:standardextremecpfs参考取值来源:
    DescribeFileSystems
ChargeTypestring

计费类型。展开详情

示例值:PayAsYouGo枚举值:PayAsYouGoSubscription
Durationinteger<int32>

包年包月时长。展开详情

示例值:1
Capacityinteger<int64>

文件系统容量。单位:GiB。展开详情

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:100
Bandwidthinteger<int64>

文件系统吞吐上限。展开详情

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:150
StorageTypestring

存储类型。展开详情

示例值:Performance枚举值:PremiumPerformanceCapacitystandardadvanceNasPlusSmartCacheadvance_100advance_200参考取值来源:
    DescribeStoragePackages
ZoneIdstring

可用区 ID。展开详情

示例值:cn-hangzhou-b参考取值来源:
    DescribeZones
ProtocolTypestring

文件传输协议类型。展开详情

示例值:NFS枚举值:NFSSMBNASPLUScpfs参考取值来源:
    CreateProtocolService
    DescribeProtocolService
EncryptTypeinteger<int32>

文件系统是否加密。展开详情

示例值:1枚举值:012
SnapshotIdstring

快照 ID。展开详情

示例值:s-xxx参考取值来源:
    CreateSnapshot
    DescribeSnapshots
VpcIdstring

专有网络 ID。展开详情

示例值:
VSwitchIdstring

交换机 ID。展开详情

示例值:
Descriptionstring

文件系统描述。展开详情

示例值:此文件系统的描述。
ClientTokenstring

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性展开详情

示例值:123e4567-e89b-12d3-a456-42665544****
KmsKeyIdstring

KMS 密钥 ID。展开详情

示例值:
DryRunboolean

是否对此次创建请求执行预检。展开详情

示例值:true
ResourceGroupIdstring

资源组 ID。展开详情

示例值:rg-acfmwavnfdf****
Tagarray<object>
子级条数 <= 21

请求说明

关于 API 幂等性,您需要注意以下事项:
由于 CreateFileSystem 接口涉及云资源的创建和费用,您在调用该 API 时,如果发生请求超时或服务端内部错误,客户端可能会尝试重发请求。建议您在请求中设置 ClientToken 参数以避免因多次重试导致的重复下单的问题。

说明 当前只有 FileSystemType 参数为 extreme、cpfs 时,该 API 支持幂等;当 FileSystemType 参数为 standard 时,该 API 不支持幂等。

ClientToken 参数的详细信息如下所示:

  • ClientToken 是一个由客户端生成的唯一的、大小写敏感、不超过 64 个 ASCII 字符的字符串。例如:ClientToken=123e4567-e89b-12d3-a456-42665544****
  • 如果您提供了一个已经使用过的 ClientToken,但其他请求参数有变化,则 NAS 会返回 IdempotentParameterMismatch 的错误代码。
说明 参数 SignatureNonce、Timestamp 和 Signature 在重试时是需要变化的。具体原因是 NAS 使用 SignatureNonce 防止重放攻击,使用 Timestamp 标记每次请求时间。所以再次请求必须提供不同的 SignatureNonce 和 Timestamp 参数值,同时也会导致 Signature 值的变化。
  • 添加了 ClientToken 参数后:

    • 返回结果是 200 HTTPCode 时,重试后客户端可以得到与上次相同的结果,但对您的服务端状态没有影响。
    • 返回结果是 4xx HTTPCode 时,如果错误信息没有表明 try it later 类似的信息,重试永远不会成功,您需要根据错误信息排查问题后修改请求参数后再重试请求。
    • 返回结果是 5xx HTTPCode 时,表明请求可能是发生网络超时或服务端内部错误,您可以重新发送同一个请求(必须包含相同 ClientToken 和业务请求参数)以确认请求结果。
  • ClientToken 有效期为 30 天。

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:98696EF0-1607-4E9D-B01D-F20930B6****
FileSystemIdstring

完成创建的文件系统 ID。

示例值:1ca404****

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
202
RequestAccepted
The request has been accepted by the server.诊断
400
IdempotentParameterMismatch
The same client token was passed in to different parameters.诊断
400
InvalidParameter.KmsServiceNotEnabled
Key Management Service is not enabled.诊断
400
InvalidParameter.KmsKeyIdNotFound
The KMS key ID does not exist.诊断
400
InvalidParameter.InvalidKmsKeyId
The KMS key ID is invalid.诊断
400
DryRunOperation
The request is validated with DryRun flag set.诊断
400
SubAccount.NoExtremeSLRPermission
The RAM user does not have the permission to create service linked role AliyunServiceRoleForNasExtreme. Please authorize the RAM user the permission ram:CreateServiceLinkedRole.诊断
400
SubAccount.NoStandardSLRPermission
The RAM user does not have the permission to create service linked role AliyunServiceRoleForNasStandard. Please authorize the RAM user the permission ram:CreateServiceLinkedRole.诊断
400
SubAccount.NoEncryptionSLRPermission
The RAM user does not have the permission to create service linked role AliyunServiceRoleForNasEncryption. Please authorize the RAM user the permission ram:CreateServiceLinkedRole.诊断
400
InvalidParam.NotSupportBYOK
The specified file system type does not support the BYOK encryption function.诊断
400
MissingParameter.KmsKeyId
When parameter EncryptType equals 2, the parameter KmsKeyId is mandatory for your request.诊断
403
OperationDenied.InvalidState
The operation is not permitted when the status is processing.诊断
403
InvalidFileSystem.AlreadyExisted
The specified file system already exists.诊断
403
Resource.OutOfStock
The inventory of the specified zone is insufficient.诊断

变更历史

变更时间变更内容概要操作
2025-04-19
新增请求参数Tag
2024-01-25
变更请求参数StorageType
2023-12-26
新增请求参数ResourceGroupId
  • 1
  • 2
  • 10 条/页

相关示例

创建网络文件系统并创建 VPC 网络下的挂载点
2021-02-16