CreatePolarFs - 创建PolarFs集群

更新时间:
复制 MD 格式

开启polarfs支持。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardb:CreatePolarFs

create

*LakeCache

acs:polardb:{#regionId}:{#accountId}:lakecache/*

无 无

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

RegionId

string

是

地域 ID。

说明

您可以通过接口 DescribeRegions 查看地域 ID 详情。

cn-beijing

StorageType

string

否

存储类型。high_performance 使用小写 essdpl0 或 essdpl1;cold 使用 local_redundancy 或 city_redundancy。请按所属产品系列选择,大小写敏感。

枚举值:

  • essdpl1 :

    ESSD PL1 云盘

  • essdpl0 :

    ESSD PL0 云盘

  • city_redundancy :

    同城冗余

  • local_redundancy :

    本地冗余

local_redundancy

AuthorizedUserIds

string

否

冷存版实例授权账号列表,用,分隔

128***********,198***********

DBType

string

否

所属数据库生态。请求值可选 polardb_mysql(PolarDB MySQL)、polardb_pg(PolarDB PostgreSQL)或 polar_agentic_db(AgenticDB)。网关分别映射为后端 mysql、postgresql、agentic_db;请传请求值,不要传 MySQL 或 PostgreSQL 展示名称。若返回 ActionUnauthorized(HTTP 403),需检查调用权限。

枚举值:

  • polardb_mysql :

    PolarDB MySQL 版

  • polar_agentic_db :

    智能体数据库

  • polardb_pg :

    PolarDB PostgreSQL 版

polardb_mysql

VPCId

string

否

专有网络 ID。

vpc-*******************

VSwitchId

string

否

虚拟交换机 ID。

vsw-*********************

ZoneId

string

否

可用区 id。

cn-beijing-i

StorageSpace

integer

否

存储空间,单位 GB。

50

DBClusterId

string

否

PolarDB 集群 ID。调用本接口时必须提供;缺失会返回 InvalidDBClusterId.Malformed。

pc-**************

PayType

string

否

付费类型,取值范围如下:

  • Postpaid:按量付费

  • Prepaid:预付费(包年包月)

枚举值:

  • Prepaid :

    预付费(包年包月)

  • Postpaid :

    按量付费

Postpaid

Period

string

否

若付费类型为 Prepaid 时,该参数为必传参数。指定预付费集群为包年或包月类型。

  • Year:包年。即选择包年包月时,单位为年。

  • Month:包月。即选择包年包月时,单位为月。

枚举值:

  • Month :

    包月。即选择包年包月时,单位为月

  • Year :

    包年。即选择包年包月时,单位为年

Month

UsedTime

string

否

若付费类型为 Prepaid 时,该参数为必传参数。

  • 当 Period 为 Month 时,UsedTime 取值为整数类型,取值范围为[1-9]。

  • 当 Period 为 Year 时,UsedTime 取值为整数类型,取值范围为[1-3]。

1

AutoRenew

boolean

否

是否自动续费,取值范围如下:

  • true:自动续费。

  • false:不自动续费。

默认为 false。

说明

当参数 PayType 取值为 Prepaid 时,该参数才生效。

true

AccelerateSwitch

string

否

加速启动,取值范围如下:

  • ONLY:仅开启加速。

  • ON:开启冷叔据+加速。

ONLY

AccelerateStorageSize

integer

否

加速空间大小,单位为 GB。取值不小于 5000,且必须为 1000 的整数倍;basic 类型开启加速时需提供。

5000

CreationCategory

string

否

产品系列:basic(基础版,默认)、high_performance(高性能版)或 cold(冷存版)。basic 类型需指定 AccelerateSwitch 和 AccelerateStorageSize;high_performance 类型需指定 StorageType(essdpl0 或 essdpl1);cold 类型可选 StorageType(local_redundancy 或 city_redundancy)。

basic

CustomBucketCount

integer

否

Bucket 数量。

说明

仅开启加速(文件系统加速)场景必填

1

CustomBucketPath

string

否

bucket 路径。

说明

仅开启加速(文件系统加速)场景必填

/test

CustomOssAk

string

否

自定义 ak

LTAIExampleCustomOssKeyId

CustomOssSk

string

否

自定义 sk

ExampleCustomOssSecret123

AutoUseCoupon

boolean

否

是否自动使用优惠券,取值范围如下:

  • true:使用优惠券(默认值)。

  • false:不使用优惠券。

true

PromotionCode

string

否

优惠券编号,不填时使用默认优惠券

727xxxxxx934

AccelerateType

string

否

加速类型,取值为范围如下:

  • juice:文件系统加速。

  • alluxio:透明加速。

alluxio

CustomBucketPathList

array<object>

否

Bucket 及对应路径信息。

说明

透明加速场景必填

object

否

bucket 及对应路径信息

Bucket

string

否

自定义存储 bucket

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

Path

string

否

自定义存储 path

/data

ResourceGroupId

string

否

资源组 ID

rg-xxx

返回参数

名称

类型

描述

示例值

object

Schema of Response

OrderId

string

订单 ID。

2035638*******

PolarFsInstanceId

string

PolarFs 实例 ID

pfs-2ze0i74ka607wck3

PolarFsPath

string

PolarFs 文件系统路径

pfs-xxx*******

PolarFsStatus

string

PolarFs 实例状态

Creating

RequestId

string

请求 ID

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

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。