1. 接口描述
接口请求域名: turbofs.api3.gsesgpucloud.com。
用于添加新文件系统
默认接口请求频率限制:10次/秒。
接口更新时间:2024-08-06 16:19:22。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 | 
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:CreateCfsFileSystem | 
| Version | 是 | 否 | String | 公共参数,本接口取值:2019-07-19 | 
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 | 
| ZoneId | 否 | 否 | Uint64 | 可用区 ID 示例值:  | 
| Zone | 是 | 否 | String | 可用区名称,例如:ap-beijing-1 示例值:  | 
| CreationToken | 否 | 否 | String | 用户自定义文件系统名称,优先级低于 FSNAME 示例值:  | 
| Protocol | 否 | 否 | String | 文件系统协议类型, 值为 NFS、CIFS; 若留空则默认为 NFS协议 示例值:  | 
| StorageType | 否 | 否 | String | 文件系统存储类型,值为 SD ;其中 SD 为标准型存储 示例值:  | 
| NetInterface | 是 | 否 | String | 网络类型,值为 VPC,BASIC;其中 VPC 为私有网络,BASIC 为基础网络 示例值:  | 
| PGroupId | 是 | 否 | String | 权限组 ID 示例值:  | 
| VpcId | 否 | 否 | String | 私有网路(VPC) ID;当网络类型值为 VPC时,与UnVpcId 两者必须填一项 示例值:  | 
| UnVpcId | 否 | 否 | String | 系统分配的VPC统一ID 示例值:  | 
| SubnetId | 否 | 否 | String | 子网, 当网络类型值为 VPC时,与UnSubnetId 两者必须填一项 示例值:  | 
| UnSubnetId | 否 | 否 | String | 系统分配的子网统一 ID 示例值:  | 
| MountIP | 否 | 否 | String | 指定IP地址,仅VPC网络支持;若不填写、将在该子网下随机分配 IP 示例值:  | 
| StorageResourcePkgId | 否 | 否 | String | 文件系统绑定的存储包,每个文件系统只能绑定一个 示例值:  | 
| BandwidthResourcePkgId | 否 | 否 | String | 文件系统绑定的带宽包,每个文件系统只能绑定一个 示例值:  | 
| FsName | 否 | 否 | String | 用户自定义文件系统名称,与CreationToken 两者必须填一项 示例值:  | 
| Encrypted | 否 | 否 | Bool | 文件系统是否加密,若留空则默认为不加密 示例值:  | 
| KmsKeyId | 否 | 否 | String | 加密密钥 ID 示例值:  | 
| TagId | 否 | 否 | Uint64 | cfs资源池id 示例值:  | 
| SnapshotId | 否 | 否 | String | 快照id 示例值:  | 
| ResourceTags | 否 | 否 | Array of ResourceTags | 标签 示例值:查看  | 
| ProjectId | 否 | 否 | String | 项目id 示例值:  | 
| CfsVersion | 是 | 否 | String | CFS 文件系统版本 示例值:  | 
| Capacity | 否 | 否 | Uint64 | TURBO文件系统的容量(TiB) 示例值:  | 
| PoolId | 否 | 否 | String | 资源池ID 示例值:  | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| CreationTime | String | 文件系统创建时间 示例值:  | 
| CreationToken | String | 用户自定义文件系统名称 示例值:  | 
| FileSystemId | String | 文件系统 ID 示例值:  | 
| LifeCycleState | String | 文件系统状态 示例值:  | 
| SizeByte | Uint64 | 文件系统已使用容量大小 示例值:  | 
| ZoneId | Uint64 | 可用区 ID 示例值:  | 
| FsName | String | 用户自定义文件系统名称 示例值:  | 
| Encrypted | Bool | 文件系统是否加密 示例值:  | 
| CfsId | String | 文件系统ID 示例值:  | 
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 | 
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 | 
|---|---|
| InvalidParameterValue.FsNameLimitExceeded | 用户自定义名称过长(超过64字节)。 | 
| InvalidParameterValue.InvalidVpcParameter | VPC参数错误。 | 
| InvalidParameterValue.MissingSubnetidOrUnsubnetid | SUBNETID和UNSUBNETID不能同时为空。 | 
| InternalError.CreateFsFailed | 创建文件系统失败。 | 
| ResourceInsufficient.RegionSoldOut | 区域资源售罄。 | 
| InvalidParameterValue.InvalidEncrypted | 加密参数错误。 | 
| InvalidParameterValue.InvalidFsName | 无效的自定义名称。 | 
| InvalidParameterValue.InvalidNetInterface | 无效的网络类型。 | 
| InvalidParameterValue.InvalidZoneOrZoneId | 无效的可用区或可用区ID。 | 
| InvalidParameterValue.MissingStorageResourcePkg | 未绑定存储包。 | 
| UnsupportedOperation.UnverifiedUser | 用户未经过实名认证。 | 
| InvalidParameterValue.InvalidZoneId | 无效的可用区。 | 
| InvalidParameterValue.MissingZoneId | ZoneID缺失。 | 
| ResourceInsufficient.FileSystemLimitExceeded | 文件系统数量达到上限。 | 
| ResourceNotFound.PgroupNotFound | 权限组不存在。 | 
| InternalError.GetAccountStatusFailed | 获取用户费用状态失败。 | 
| InvalidParameterValue.UnavailableRegion | 该可用区无法提供服务。 | 
| UnsupportedOperation.OutOfService | 用户已欠费, 请充值后重试。 | 
| InvalidParameterValue.InvalidStorageType | 存储类型参数错误。 | 
| InvalidParameterValue.MissingKmsKeyId | 密钥ID或ARN参数缺失。 | 
| InvalidParameterValue.InvalidRegionZoneInfo | 用户区域选择错误 (ZoneName) 或 (ZoneId, Region)二者必选一。 | 
| InvalidParameterValue.InvalidVip | 用户指定不可用的vip。 | 
| InvalidParameterValue.ZoneIdRegionNotMatch | ZoneId和Region不匹配。 | 
| InternalError | 内部错误。 | 
| InvalidParameterValue.InvalidPgroupId | 权限组ID无效。 | 
| InvalidParameterValue.MissingVpcidOrUnvpcid | VPCID和UNVPCID不能同时为空。 | 
| AuthFailure.UnauthorizedOperation | 请求未CAM授权。 | 
| FailedOperation | 操作失败。 | 
| InvalidParameterValue.MissingVpcParameter | VPC相关参数缺失。 | 
| InvalidParameterValue.MissingZoneOrZoneId | 用户区域选择错误 (Zone) 或 (Zone_id)二者必选一。 | 
| InvalidParameterValue.InvalidMountTargetIp | 错误的挂载点IP。 | 
| InvalidParameterValue.UnavailableZone | 该地域无法提供服务。 | 
| InvalidParameter | 参数错误。 | 
| InvalidParameterValue.InvalidSubnetId | 无效的子网ID。 | 
| InvalidParameterValue.InvalidProtocol | 协议参数错误。 | 
| ResourceInsufficient.SubnetIpAllOccupied | 该子网下已无可用IP。 | 
| InvalidParameterValue.InvalidVpcId | 无效的VPCID。 | 
| InvalidParameterValue.SnapSrcFsBusy | 快照原fs正忙 | 
| InvalidParameter.InvalidTagKey | 参数值错误: 标签键不能为空 | 
| ResourceInsufficient.TagLimitExceeded | 资源不足: 该资源的标签个数达到最大限制 | 
| AuthFailure | CAM签名/鉴权错误 | 
| InternalError.DBError | 数据库错误 | 
| InternalError.ChargeSystemError | 计费回调错误 | 
| InvalidParameterValue.FSNmaeLimitExceeded | 用户自定义名称超过64字节 |