调用CreateDbfs创建一个按量付费的数据库文件系统。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dbfs:CreateDbfs | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | DBFS 实例所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
FsName | string | 是 | 数据库文件系统名称。 取值范围:2~128 个字符,以英文大小写字母或中文开头,可包含数字、下划线和连字符(-)。 | testdbfs-001 |
Category | string | 是 | 数据库文件系统类型。取值范围:
| standard |
SizeG | integer | 是 | 容量大小,以 GiB 为单位。指定该参数后,其取值必须≥指定快照 ID 的容量大小。 取值范围:不使能 RAID0 条带化时为 20-32768 之间的整数;使能 RAID0 条带化时为 160-262144 之间的整数。 | 200 |
ZoneId | string | 是 | DBFS 实例所属的可用区 ID。 | cn-hangzhou-i |
ClientToken | string | 否 | 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多详情,请参见如何保证幂等性。 | 123e4567-e89b-12d3-a456-426655440000 |
SnapshotId | string | 否 | 创建 DBFS 实例使用的快照 ID。 | s-y2vZ3********vvMilZ2hQ |
DeleteSnapshot | boolean | 否 | 使用快照创建 DBFS 后是否删除原始快照。 | false |
PerformanceLevel | string | 否 | 创建 DBFS 实例时,设置 DBFS 的性能等级。取值范围:
| PL1 |
EnableRaid | boolean | 否 | 是否以 RAID 方式来创建 DBFS。 取值范围:true 或 false,默认值为 false。 | false |
RaidStripeUnitNumber | integer | 否 | 条带数量。当 EnableRaid 参数为 true 时必传。 取值范围:2-8 之间的整数。 | 8 |
KMSKeyId | string | 否 | DBFS 使用的 KMS 密钥 ID。 | 0e478b7a-4262-4802-b8cb-00d3fb40826X |
Encryption | boolean | 否 | 是否加密 DBFS。 取值范围:true 或 false,默认值为 false。 | false |
UsedScene | string | 否 | DBFS 的使用场景。取值范围:
| PostgreSQL |
InstanceType | string | 否 | 实例规格。取值范围:
| dbfs.small |
AdvancedFeatures | string | 否 | 可定制数据库文件存储实例使用的 CPU 核数、内存上限值等。
| {"cpuCoreCount":0.5,"memorySize":512,"pageCacheSize":128} |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"FsId": "dbfs-GOrr********Yd0VLOyBpg"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidCategory.DBFS | The category is not supported. | 非法的版本类型。 |
400 | InvalidName.DBFS | Invalid DBFS instance name. | 非法的DBFS实例名称。 |
400 | InvalidPerformanceLevel.DBFS | The performance level is not supported. | 非法的性能等级。 |
400 | InvalidRegion.DBFS | The region is not supported. | 不支持的区域。 |
400 | InvalidSize.DBFS | The size of DBFS is invalid. | 非法的容量大小。 |
400 | InvalidZone.DBFS | The zone is not supported. | 不支持的可用区。 |
404 | EntityNotExist.Snapshot | The snapshot does not exist. | 快照不存在。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2022-03-02 | OpenAPI 错误码发生变更 | 查看变更详情 |
2022-02-28 | OpenAPI 错误码发生变更 | 查看变更详情 |