All Products
Search

This Product

    PolarDB:CreatePolarFs

    Document Center

    PolarDB:CreatePolarFs

    Last Updated:Aug 05, 2026

    Enables PolarFS support.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request syntax

    POST  HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID.

    Note

    You can call the DescribeRegions operation to query region IDs.

    cn-beijing
    StorageType

    string

    No

    Valid values for high-performance storage type:

    • ESSDPL0

    • ESSDPL1

    Valid values for Basic Edition storage type:

    • city_redundancy (zone-redundant)

    Valid values for Cold Storage Edition storage type:

    • city_redundancy (zone-redundant)

    • local_redundancy (locally redundant)

    Valid values:

    • ESSDPL0 :

      ESSDPL0

    • ESSDPL1 :

      ESSDPL1

    • city_redundancy :

      city_redundancy

    • local_redundancy :

      local_redundancy

    local_redundancy
    AuthorizedUserIds

    string

    No

    The list of authorized account IDs for Cold Storage Edition instances, separated by commas (,).

    128***********，198***********
    DBType

    string

    No

    The database engine. Valid values:

    • MySQL

    • PostgreSQL

    Valid values:

    • PostgreSQL :

      polardb_pg

    • MySQL :

      polardb_mysql

    MySQL
    VPCId

    string

    No

    The VPC ID.

    vpc-*******************
    VSwitchId

    string

    No

    The vSwitch ID.

    vsw-*********************
    ZoneId

    string

    No

    The zone ID.

    cn-beijing-i
    StorageSpace

    integer

    No

    The storage space. Unit: GB.

    50
    DBClusterId

    string

    No

    The cluster ID.

    pc-**************
    PayType

    string

    No

    The billing method. Valid values:

    • Postpaid: pay-as-you-go.

    • Prepaid: subscription.

    Postpaid
    Period

    string

    No

    This parameter is required when PayType is set to Prepaid. Specifies whether the subscription cluster uses a yearly or monthly billing cycle. You must pass this parameter when the billing method is subscription.

    • Year: The subscription period is measured in years.

    • Month: The subscription period is measured in months.

    Month
    UsedTime

    string

    No

    This parameter is required when PayType is set to Prepaid.

    • When Period is set to Month, the valid values of UsedTime are integers in the range of [1-9].

    • When Period is set to Year, the valid values of UsedTime are integers in the range of [1-3].

    1
    AutoRenew

    boolean

    No

    Specifies whether to enable auto-renewal. Valid values:

    • true: Auto-renewal is enabled.

    • false: Auto-renewal is disabled.

    Default value: false.

    Note

    This parameter takes effect only when PayType is set to Prepaid.

    true
    AccelerateSwitch

    string

    No

    The acceleration mode. Valid values:

    • ONLY: enables acceleration only.

    • ON: enables cold data storage and acceleration.

    ONLY
    AccelerateStorageSize

    integer

    No

    The acceleration storage space for Basic Edition with acceleration enabled. Unit: GB.

    500
    CreationCategory

    string

    No

    The edition. Valid values:

    • basic: Basic Edition (default).

    • cold: Cold Storage Edition.

    • high_performance: High-performance Edition.

    basic
    CustomBucketCount

    integer

    No

    The number of buckets.

    Note

    This parameter is required only when acceleration (file system acceleration) is enabled.

    1
    CustomBucketPath

    string

    No

    The bucket path.

    Note

    This parameter is required only when acceleration (file system acceleration) is enabled.

    /test
    CustomOssAk

    string

    No

    The custom AccessKey ID.

    xxx
    CustomOssSk

    string

    No

    The custom AccessKey secret.

    xxx
    AutoUseCoupon

    boolean

    No

    Specifies whether to automatically use coupons. Valid values:

    • true: Coupons are used (default).

    • false: Coupons are not used.

    true
    PromotionCode

    string

    No

    The coupon code. If this parameter is not specified, the default coupon is used.

    727xxxxxx934
    AccelerateType

    string

    No

    The acceleration type. Valid values:

    • juice: file system acceleration.

    • alluxio: transparent acceleration.

    alluxio
    CustomBucketPathList

    array<object>

    No

    The bucket and path information.

    Note

    This parameter is required for transparent acceleration scenarios.

    object

    No

    The bucket and path information.

    Bucket

    string

    No

    The custom storage bucket.

    pfs-xxx.oss-[regionId]-internal.aliyuncs.com
    Path

    string

    No

    The custom storage path.

    /data

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The request ID.

    CED079B7-A408-41A1-BFF1-EC608E******
    PolarFsPath

    string

    The PolarFS file system path.

    pfs-xxx*******
    PolarFsStatus

    string

    The PolarFS instance status.

    Creating
    OrderId

    string

    The order ID.

    2035638*******
    PolarFsInstanceId

    string

    The PolarFS instance ID.

    pfs-2ze0i74ka607wck3

    Examples

    Success response

    JSON format

    {
  "RequestId": "CED079B7-A408-41A1-BFF1-EC608E******",
  "PolarFsPath": "pfs-xxx*******",
  "PolarFsStatus": "Creating",
  "OrderId": "2035638*******",
  "PolarFsInstanceId": "pfs-2ze0i74ka607wck3"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.