Last updated: 2020-09-04 11:20:59

    1. API Description

    Domain name for API request:

    This API is used to create a file system.

    A maximum of 10 requests can be initiated per second for this API.

    Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example:

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common parameter. The value used for this API: CreateCfsFileSystem.
    Version Yes String Common parameter. The value used for this API: 2019-07-19.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    Zone Yes String AZ name, such as "ap-beijing-1". For the list of regions and AZs, please see Overview
    NetInterface Yes String Network type. Valid values: VPC (VPC), BASIC (basic network)
    PGroupId Yes String Permission group ID
    Protocol No String File system protocol type. Valid values: NFS, CIFS. If this parameter is left empty, NFS will be used by default
    StorageType No String File system storage class. Valid values: SD (standard), HP (high-performance)
    VpcId No String VPC ID. This field is required if network type is VPC.
    SubnetId No String Subnet ID. This field is required if network type is VPC.
    MountIP No String Specifies an IP address, which is supported only for VPC. If this parameter is left empty, a random IP will be assigned in the subnet
    FsName No String Custom file system name
    ResourceTags.N No Array of TagInfo File system tag

    3. Output Parameters

    Parameter Name Type Description
    CreationTime String File system creation time
    CreationToken String Custom file system name
    FileSystemId String File system ID
    LifeCycleState String File system status
    SizeByte Integer Used file system capacity
    ZoneId Integer AZ ID
    FsName String Custom file system name
    Encrypted Boolean Whether a file system is encrypted
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Creating a file system

    Input Example
    &<common request parameters>

    Output Example

      "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. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.


    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation Operation failed.
    InternalError Internal error.
    InternalError.CreateFsFailed Failed to create the file system.
    InternalError.GetAccountStatusFailed Failed to get the payment status of the user.
    InvalidParameter Invalid parameter.
    InvalidParameterValue.FsNameLimitExceeded The length of the custom file system name exceeds the limit (64 bytes).
    InvalidParameterValue.InvalidEncrypted Invalid encryption parameter.
    InvalidParameterValue.InvalidFsName Invalid custom name.
    InvalidParameterValue.InvalidMountTargetIp Incorrect mount target IP.
    InvalidParameterValue.InvalidNetInterface Invalid network type.
    InvalidParameterValue.InvalidPgroupId Invalid permission group ID.
    InvalidParameterValue.InvalidProtocol Invalid protocol parameter.
    InvalidParameterValue.InvalidRegionZoneInfo Either ZoneName or ZoneId, Region must be selected.
    InvalidParameterValue.InvalidStorageResourcePkg The resource pack does not exist or has been bound.
    InvalidParameterValue.InvalidStorageType Invalid storage class parameter.
    InvalidParameterValue.InvalidSubnetId Invalid subnet ID.
    InvalidParameterValue.InvalidTagKey Tag key cannot be left blank.
    InvalidParameterValue.InvalidVip The specified VIP is unavailable.
    InvalidParameterValue.InvalidVpcId Invalid VPCID.
    InvalidParameterValue.InvalidVpcParameter Invalid VPC parameter.
    InvalidParameterValue.InvalidZoneId Invalid AZ.
    InvalidParameterValue.InvalidZoneOrZoneId Invalid AZ or AZ ID.
    InvalidParameterValue.MissingKmsKeyId Key ID or ARN is missing.
    InvalidParameterValue.MissingStorageResourcePkg No storage pack is bound to.
    InvalidParameterValue.MissingSubnetidOrUnsubnetid SUBNETID and UNSUBNETID cannot both be empty.
    InvalidParameterValue.MissingVpcParameter A VPC parameter is missing.
    InvalidParameterValue.MissingVpcidOrUnvpcid VPCID and UNVPCID cannot both be empty.
    InvalidParameterValue.MissingZoneId ZoneID is missing.
    InvalidParameterValue.MissingZoneOrZoneId Either Zone or Zone_id must be selected.
    InvalidParameterValue.TagKeyLimitExceeded The length of the tag key exceeds the limit of 127 bytes.
    InvalidParameterValue.TagValueLimitExceeded The length of the tag value exceeds the limit of 255 bytes.
    InvalidParameterValue.UnavailableRegion Services are unavailable in this AZ.
    InvalidParameterValue.UnavailableZone Services are unavailable in this region.
    InvalidParameterValue.ZoneIdRegionNotMatch ZoneId and Region do not match.
    ResourceInsufficient.FileSystemLimitExceeded The number of file systems has reached the upper limit.
    ResourceInsufficient.RegionSoldOut Resources in the region have been sold out.
    ResourceInsufficient.SubnetIpAllOccupied There is no IP available in this subnet.
    ResourceInsufficient.TagLimitExceeded The quantity of the resource tags reached the maximum limit.
    ResourceNotFound.PgroupNotFound The permission group does not exist.
    UnsupportedOperation.BasicNetInterfaceNotSupported This AZ does not support the basic network.
    UnsupportedOperation.OutOfService Your account is in arrears. Please top up and try again.
    UnsupportedOperation.UnverifiedUser Unverified user.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback