创建文件系统

最近更新时间:2024-03-12 01:15:35

我的收藏

1. 接口描述

接口请求域名: cfs.tencentcloudapi.com 。

用于添加新文件系统

默认接口请求频率限制:10次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateCfsFileSystem。
Version String 公共参数,本接口取值:2019-07-19。
Region String 公共参数,详见产品支持的 地域列表
Zone String 可用区名称,例如ap-beijing-1,请参考 概览 文档中的地域与可用区列表
示例值:ap-beijing-1
NetInterface String 网络类型,可选值为 VPC,CCN;其中 VPC 为私有网络, CCN 为云联网。通用标准型/性能型请选择VPC,Turbo标准型/性能型请选择CCN。
示例值:VPC
PGroupId String 权限组 ID
示例值:pgroupbasic
Protocol String 文件系统协议类型, 值为 NFS、CIFS、TURBO ; 若留空则默认为 NFS协议,turbo系列必须选择turbo,不支持NFS、CIFS
示例值:NFS
StorageType String 文件系统存储类型,默认值为 SD ;其中 SD 为通用标准型存储, HP为通用性能型存储, TB为Turbo标准型, TP 为Turbo性能型。
示例值:SD
VpcId String 私有网络(VPC) ID,若网络类型选择的是VPC,该字段为必填。
示例值:123
SubnetId String 子网 ID,若网络类型选择的是VPC,该字段为必填。
示例值:234
MountIP String 指定IP地址,仅VPC网络支持;若不填写、将在该子网下随机分配 IP,Turbo系列当前不支持指定
示例值:10.0.0.1
FsName String 用户自定义文件系统名称
示例值:QcloudCfs
ResourceTags.N Array of TagInfo 文件系统标签
示例值:[{"TagKey":"a","TagValue":1}]
ClientToken String 用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。用于保证请求幂等性的字符串失效时间为2小时。
示例值:QcloudCfs001
CcnId String 云联网ID, 若网络类型选择的是CCN,该字段为必填
示例值:ccn-12345
CidrBlock String 云联网中CFS使用的网段, 若网络类型选择的是Ccn,该字段为必填,且不能和Ccn中已经绑定的网段冲突
示例值:10.0.0.1/24
Capacity Integer 文件系统容量,turbo系列必填,单位为GiB。 turbo标准型单位GB,起售20TiB,即20480 GiB;扩容步长20TiB,即20480 GiB。turbo性能型起售10TiB,即10240 GiB;扩容步长10TiB,10240 GiB。
示例值:40960
SnapshotId String 文件系统快照ID
示例值:snapcfs-xx
AutoSnapshotPolicyId String 定期快照策略ID
示例值:asp-xx
EnableAutoScaleUp Boolean 是否开启默认扩容,仅Turbo类型文件存储支持
示例值:False

3. 输出参数

参数名称 类型 描述
CreationTime String 文件系统创建时间
示例值:2017-02-24 11:28:12
CreationToken String 用户自定义文件系统名称
示例值:QcloudCfs
FileSystemId String 文件系统 ID
示例值:cfs-abc
LifeCycleState String 文件系统状态,可能出现状态包括:“creating” 创建中, “create_failed” 创建失败, “available” 可用, “unserviced” 不可用, “upgrading” 升级中, “deleting” 删除中。
示例值:AVAILABLE
SizeByte Integer 文件系统已使用容量大小,单位为 Byte
示例值:1000
ZoneId Integer 可用区 ID
示例值:800001
FsName String 用户自定义文件系统名称
示例值:QcloudCfs
Encrypted Boolean 文件系统是否加密
示例值:False
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建文件系统实例

创建文件系统场景

输入示例

https://cfs.tencentcloudapi.com/?Action=CreateCfsFileSystem
&NetInterface=basic
&Zone=ap-beijing-1
&PGroupId=pgroupbasic
&FsName=test_fs
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "fjo8aejo-fjei-32eu-2je9-fhue83nd81",
        "CreationTime": "2017-11-23 20:51:34",
        "CreationToken": "test_fs",
        "FileSystemId": "cfs-ocakq8tt",
        "LifeCycleState": "creating",
        "SizeByte": 0,
        "ZoneId": 800001,
        "FsName": "test_fs",
        "Encrypted": false
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
FailedOperation.BindResourcePkgFailed 文件系统绑定资源包失败。
FailedOperation.ClientTokenInUse 资源正在创建中。
InternalError 内部错误。
InternalError.CreateFsFailed 创建文件系统失败。
InternalError.GetAccountStatusFailed 获取用户费用状态失败。
InvalidParameter 参数错误。
InvalidParameter.AutoPolicyNotFound 快照策略未找到。
InvalidParameterValue.ClientTokenLimitExceeded 用于保证请求幂等性的字符串长度超过限制(不能超过64字节)。
InvalidParameterValue.DuplicatedTagKey 标签键重复
InvalidParameterValue.FsNameLimitExceeded 用户自定义名称过长(超过64字节)。
InvalidParameterValue.InvalidClientToken 用于保证请求幂等性的字符串错误。
InvalidParameterValue.InvalidEncrypted 加密参数错误。
InvalidParameterValue.InvalidFsName 无效的自定义名称。
InvalidParameterValue.InvalidMountTargetIp 错误的挂载点IP。
InvalidParameterValue.InvalidNetInterface 无效的网络类型。
InvalidParameterValue.InvalidPgroupId 权限组ID无效。
InvalidParameterValue.InvalidProtocol 协议参数错误。
InvalidParameterValue.InvalidRegionZoneInfo 用户区域选择错误 (ZoneName) 或 (ZoneId, Region)二者必选一。
InvalidParameterValue.InvalidResourceTags 参数值错误: 资源标签值错误。
InvalidParameterValue.InvalidSnapshotStatus 无效的快照状态。
InvalidParameterValue.InvalidStorageResourcePkg 资源包不存在或已绑定。
InvalidParameterValue.InvalidStorageType 存储类型参数错误。
InvalidParameterValue.InvalidSubnetId 无效的子网ID。
InvalidParameterValue.InvalidTagKey 标签键不能为空。
InvalidParameterValue.InvalidTagValue 标签值为空或字符无效。
InvalidParameterValue.InvalidTurboCapacity 无效的容量值。
InvalidParameterValue.InvalidVip 用户指定不可用的vip。
InvalidParameterValue.InvalidVpcId 无效的VPCID。
InvalidParameterValue.InvalidVpcParameter VPC参数错误。
InvalidParameterValue.InvalidZoneId 无效的可用区。
InvalidParameterValue.InvalidZoneOrZoneId 无效的可用区或可用区ID。
InvalidParameterValue.MissingKmsKeyId 密钥ID或ARN参数缺失。
InvalidParameterValue.MissingStorageResourcePkg 未绑定存储包。
InvalidParameterValue.MissingSubnetidOrUnsubnetid SUBNETID和UNSUBNETID不能同时为空。
InvalidParameterValue.MissingVpcParameter VPC相关参数缺失。
InvalidParameterValue.MissingVpcidOrUnvpcid VPCID和UNVPCID不能同时为空。
InvalidParameterValue.MissingZoneId ZoneID缺失。
InvalidParameterValue.MissingZoneOrZoneId 用户区域选择错误 (Zone) 或 (Zone_id)二者必选一。
InvalidParameterValue.TagKeyFilterLimitExceeded 参数值错误: 标签键个数超过上限(6个)。
InvalidParameterValue.TagKeyLimitExceeded 标签键长度超过限制(不能超过127字节)。
InvalidParameterValue.TagValueFilterLimitExceeded 标签值个数超过上限(10个)。
InvalidParameterValue.TagValueLimitExceeded 标签值长度超过限制(不能超过255字节)。
InvalidParameterValue.UnavailableRegion 该可用区无法提供服务。
InvalidParameterValue.UnavailableZone 该地域无法提供服务。
InvalidParameterValue.ZoneIdRegionNotMatch ZoneId和Region不匹配。
ResourceInsufficient.FileSystemLimitExceeded 文件系统数量达到上限。
ResourceInsufficient.RegionSoldOut 区域资源售罄。
ResourceInsufficient.SubnetIpAllOccupied 该子网下已无可用IP。
ResourceInsufficient.TagLimitExceeded 该资源的标签个数达到最大限制。
ResourceInsufficient.TagQuotasExceeded 标签限额不足。
ResourceInsufficient.TurboSpecialCapacityFileSystemCountLimit Turbo类型特殊容量文件系统数量限制
ResourceNotFound.PgroupNotFound 权限组不存在。
UnsupportedOperation 操作不支持。
UnsupportedOperation.BasicNetInterfaceNotSupported 该可用区不支持基础网络。
UnsupportedOperation.OutOfService 用户已欠费, 请充值后重试。
UnsupportedOperation.UnverifiedUser 用户未经过实名认证。