创建文件系统

最近更新时间:2019-09-26 22:10:06

1. 接口描述

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

用于添加新文件系统

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cfs.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateCfsFileSystem
Version String 公共参数,本接口取值:2019-07-19
Region String 公共参数,详见产品支持的 地域列表
Zone String 可用区名称,例如ap-beijing-1,请参考 概览 文档中的地域与可用区列表
NetInterface String 网络类型,值为 VPC,BASIC;其中 VPC 为私有网络,BASIC 为基础网络
PGroupId String 权限组 ID
Protocol String 文件系统协议类型, 值为 NFS、CIFS; 若留空则默认为 NFS协议
StorageType String 文件系统存储类型,值为 SD ;其中 SD 为标准型存储
VpcId String 私有网路(VPC) ID
SubnetId String 子网 ID
MountIP String 指定IP地址,仅VPC网络支持;若不填写、将在该子网下随机分配 IP
FsName String 用户自定义文件系统名称

3. 输出参数

参数名称 类型 描述
CreationTime String 文件系统创建时间
CreationToken String 用户自定义文件系统名称
FileSystemId String 文件系统 ID
LifeCycleState String 文件系统状态
SizeByte Integer 文件系统已使用容量大小
ZoneId Integer 可用区 ID
FsName String 用户自定义文件系统名称
Encrypted Boolean 文件系统是否加密
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 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 Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InternalError.CreateFsFailed 创建文件系统失败。
InternalError.GetAccountStatusFailed 获取用户费用状态失败。
InvalidParameter 参数错误。
InvalidParameterValue.FsNameLimitExceeded 用户自定义名称过长(超过64字节)。
InvalidParameterValue.InvalidEncrypted 加密参数错误。
InvalidParameterValue.InvalidFsName 无效的自定义名称。
InvalidParameterValue.InvalidMountTargetIp 错误的挂载点IP。
InvalidParameterValue.InvalidNetInterface 无效的网络类型。
InvalidParameterValue.InvalidPgroupId 权限组ID无效。
InvalidParameterValue.InvalidProtocol 协议参数错误。
InvalidParameterValue.InvalidRegionZoneInfo 用户区域选择错误 (ZoneName) 或 (ZoneId, Region)二者必选一。
InvalidParameterValue.InvalidStorageType 存储类型参数错误。
InvalidParameterValue.InvalidSubnetId 无效的子网ID。
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.UnavailableRegion 该可用区无法提供服务。
InvalidParameterValue.UnavailableZone 该地域无法提供服务。
InvalidParameterValue.ZoneIdRegionNotMatch ZoneId和Region不匹配。
ResourceInsufficient.FileSystemLimitExceeded 文件系统数量达到上限。
ResourceInsufficient.RegionSoldOut 区域资源售罄。
ResourceNotFound.PgroupNotFound 权限组不存在。
UnsupportedOperation.OutOfService 用户已欠费, 请充值后重试。
UnsupportedOperation.UnverifiedUser 用户未经过实名认证。