1. Interface Description
Interface request domain name: cfs.api3.convergecloud.com.
Adds file systems
Default interface request rate limit: 10 times per second.
Interface update time: 2020-12-17 07:39:57.
The interface is both signature verification and authentication.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: CreateCfsFileSystem |
| Version | Yes | No | String | Public parameter, The value of this interface: 2019-07-19 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| ZoneId | No | No | Uint64 | Availability zone ID Example: 800001 |
| Zone | Yes | No | String | AZ name. For example, ap-zone-1. Example: ap-zone-1 |
| CreationToken | No | No | String | User-defined file system name, with a lower priority than FSNAME Example: fs-name-business |
| Protocol | No | No | String | File system protocol type. Values: NFS, CIFS. If not specified, this field will be NFS by default. Example: NFS |
| StorageType | No | No | String | File system storage type. Value: SD (standard type) Example: SD |
| NetInterface | Yes | No | String | Network type. VPC: Virtual Private Cloud; BASIC: Basic network Example: VPC |
| PGroupId | Yes | No | String | Permission group ID Example: pgroupbasic |
| VpcId | No | No | String | Virtual Private Cloud (VPC) ID. Either this field or UnVpcId must be specified when the network type is VPC. Example: vpc-ad1dd |
| UnVpcId | No | No | String | Unified VPC ID assigned by the system Example: vpc-cxasdad |
| SubnetId | No | No | String | Subnet. Either this field or UnSubnetId must be specified when the network type is VPC. Example: sbnet-id-business |
| UnSubnetId | No | No | String | Unified subnet ID assigned by the system Example: unsbnet-id-business |
| MountIP | No | No | String | Designated IP address, only supported in VPC. If this field is not specified, an IP address within the subnet will be randomly assigned. Example: 10.0.0.1 |
| StorageResourcePkgId | No | No | String | Storage package bound to the file system. Only one storage package can be bound to each file system. Example: no support current |
| BandwidthResourcePkgId | No | No | String | Bandwidth package bound to the file system. Only one bandwidth package can be bound to each file system. Example: no support current |
| FsName | No | No | String | User-defined file system name. Either this field or CreationToken must be specified. Example: fs-name-business |
| Encrypted | No | No | Bool | Indicates whether the file system is encrypted. If not specified, this field will be no by default. Example: False |
| KmsKeyId | No | No | String | Encryption key ID Example: 23e80852-1e38-11e9-b129-5cb9019b4b02 |
| TagId | No | No | Uint64 | CFS resource pool ID Example: 8 |
| SnapId | No | No | String | Snapshot ID Example: d51a195248-ab41-13be-c0e7-9924d5c4c6 |
| ResourceTags | No | No | Array of ResourceTags | Tag Example:View |
| ProjectId | No | No | String | Project ID Example: pr-aea4e215 |
| BackupSize | No | No | Uint64 | File system size during backup Example: 100000 |
| BackupId | No | No | String | Backup ID Example: 234 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| CreationTime | String | File system creation time Example: 2017-02-24 11:28:12 |
| CreationToken | String | User-defined file system name Example: fs-name-business |
| FileSystemId | String | File system ID Example: cfs-xcweqdx |
| LifeCycleState | String | File system status Example: AVAILABLE |
| SizeByte | Uint64 | File system capacity that is used Example: 1000 |
| ZoneId | Uint64 | Availability zone ID Example: 800001 |
| FsName | String | User-defined file system name Example: fs-name-business |
| Encrypted | Bool | Indicates whether the file system is encrypted Example: False |
| CfsId | String | File System ID Example: iriaio0h |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidParameterValue.FsNameLimitExceeded | User-defined name too long (exceeds 64 bytes). |
| InvalidParameterValue.InvalidVpcParameter | VPC parameter error. |
| InvalidParameterValue.MissingSubnetidOrUnsubnetid | SUBNETID and UNSUBNETID cannot both be empty. |
| InternalError.CreateFsFailed | Failed to create the file system. |
| ResourceInsufficient.RegionSoldOut | Region resources sold out. |
| InvalidParameterValue.InvalidEncrypted | Encryption parameter error. |
| InvalidParameterValue.InvalidFsName | Invalid user-defined name. |
| InvalidParameterValue.InvalidNetInterface | Invalid network type. |
| InvalidParameterValue.InvalidZoneOrZoneId | Invalid availability zone or availability zone ID. |
| InvalidParameterValue.MissingStorageResourcePkg | No storage package is bound. |
| UnsupportedOperation.UnverifiedUser | User not authenticated with real name. |
| InvalidParameterValue.InvalidZoneId | Invalid availability zone. |
| InvalidParameterValue.MissingZoneId | ZoneID missing. |
| ResourceInsufficient.FileSystemLimitExceeded | The number of file systems has reached the limit. |
| ResourceNotFound.PgroupNotFound | Permission group does not exist. |
| InternalError.GetAccountStatusFailed | Failed to obtain user fee status. |
| InvalidParameterValue.UnavailableRegion | This availability zone cannot provide service. |
| UnsupportedOperation.OutOfService | Out of service due to overdue payment. Top up and try again. |
| InvalidParameterValue.InvalidStorageType | Storage type error. |
| InvalidParameterValue.MissingKmsKeyId | Key ID or ARN missing. |
| InvalidParameterValue.InvalidRegionZoneInfo | Region error. Either (ZoneName) or (ZoneId, Region) must be selected. |
| InvalidParameterValue.InvalidVip | The specified VIP is unavailable. |
| InvalidParameterValue.ZoneIdRegionNotMatch | ZoneId and Region do not match. |
| InternalError | Internal error |
| InvalidParameterValue.InvalidPgroupId | Invalid permission group ID. |
| InvalidParameterValue.MissingVpcidOrUnvpcid | VPCID and UNVPCID cannot both be empty. |
| AuthFailure.UnauthorizedOperation | Request lacks CAM authorization. |
| FailedOperation | Operation failed |
| InvalidParameterValue.MissingVpcParameter | VPC parameter missing. |
| InvalidParameterValue.MissingZoneOrZoneId | Region error. Either (Zone) or (Zone_id) must be selected. |
| InvalidParameterValue.InvalidMountTargetIp | Invalid mount target IP. |
| InvalidParameterValue.UnavailableZone | This region cannot provide service. |
| InvalidParameter | Wrong parameter. |
| InvalidParameterValue.InvalidSubnetId | Invalid subnet ID. |
| InvalidParameterValue.InvalidProtocol | Protocol error. |
| ResourceInsufficient.SubnetIpAllOccupied | No available IP under this subnet. |
| InvalidParameterValue.InvalidVpcId | Invalid VPCID. |
| InvalidParameterValue.SnapSrcFsBusy | The original FS of the snapshot is busy. |
| InternalError.BillingJipingInterfaceQuotaFail | The measurement quota is insufficient. |
| InvalidParameter.InvalidTagKey | Parameter value error: Tag key cannot be empty. |
| ResourceInsufficient.TagLimitExceeded | Insufficient resources: The number of tags for this resource has reached the limit. |
| AuthFailure | CAM signature/authentication error |