CreateFs--大数据文件存储-火山引擎

文档中心

导航

CreateFs

最近更新时间：2023.05.18 15:33:39首次发布时间：2022.05.26 14:18:33

调用 CreateFs 接口，创建一个文件存储实例。

请求参数

参数	类型	是否必填	示例值	说明
FsName	String	是	doc-test-cfs-1	文件系统名称，同一个地域内唯一。文件系统命名规则如下：全局唯一且不能为空字符串。长度为 2~63 个字符。支持英文字母、数字和短横线（-），且必须以英文字母开头。
ChargeType	String	是	POST_CHARGE	计费类型，目前仅支持 POST_CHARGE。如需了解详细的计费说明，请参见计费说明。
BillingType	String	是	MONTHLY	账单类型，目前仅支持 monthly。
ZoneId	String	是	cn-beijing-a	实例所在可用区 ID。
CachePlan	String	是	T2	加速方案，取值： DISABLED：不启用缓存加速 T2：200 MB/s/TiB 基线 T4：400 MB/s/TiB 基线
CacheCapacityTiB	Integer	否	10	缓存加速容量，单位 TiB。起步 10 TiB，调整步长为 5 TiB。说明启用缓存加速功能时，此参数必填。文件存储模式实例已正式计费，最大支持设置为 200 TiB 容量。如需申请更大的缓存容量，请提交工单。数据湖模式实例处于公测期，最大支持设置为 50 TiB 容量。
VpcId	String	否	vpc-id23	私有网络 ID。如何创建私有网络，请参见私有网络。说明启用缓存加速功能时，此参数必填。
SubnetId	String	否	subnet-id23	子网 ID。如何创建子网，请参见子网。说明启用缓存加速功能时，此参数必填。
SecurityGroupId	String	否	sg-id23	安全组 ID。如何创建安全组，请参见安全组。说明启用缓存加速功能时，此参数必填。
VpcRouteEnabled	Boolean	否	false	是否开启全 VPC 访问。 true：开启。 false：默认值，表示不开启。
Mode	String	是	HDFS_MODE	选择应用场景： HDFS_MODE：文件存储场景 ACC_MODE：数据湖场景
TosBucket	String	否	bucket-name	设置文件存储实例所关联的 TOS 对象存储桶，实例场景不同，设置 TOS 存储桶的方式也不同。文件存储场景为空：表示由系统提供相关联的存储桶。设置 Bucket 名称：使用当前账号的目标存储桶。数据湖场景设置 Bucket 名称：使用当前账号或其他账号的目标存储桶。
TosPrefix	String	否	prefix/	支持将 TOS 的子路径挂载到文件存储实例。非必填项，可为空，为空时表示根路径。填写时不得以左斜线（/）开头，需要以左斜线（/）结尾，如 `prefix/` 。示例： TOS 路径为 `tos://tos-doctest/prefix`，配置的文件存储前缀可以为 `prefix/`。此时访问 CFS 实例的根目录就等同于访问 TOS 的`prefix/`；访问 CFS 实例的 `/test`，就等于 TOS 的 `prefix/test`。
TosAccountId	Integer	否	2100***0000	当数据湖场景实例选择关联其他账号下的存储桶时，需要设置该账号的 ID。
TosAk	String	否	AKxxxx	当数据湖场景选择关联其他账号下的存储桶时，需要设置该账号的 Access Key ID。
TosSk	String	否	SKxxxx	当数据湖场景选择关联其他账号下的存储桶时，需要设置该账号的 Secret Access Key。
ReadOnly	Boolean	否	true	挂载 TOS Bucket 时自动创建的 Namespace，是否为只读。 true：是 false：否说明判断挂载 TOS Bucket 时自动创建的 Namespace是否为只读的判断逻辑说明如下：如果请求中填了 ReadOnly 参数，则使用当前配置值来判断是否只读。如果请求中没有填 ReadOnly 参数，但是填了 TosAk 和 TosSk，则会根据 TosAk 和 TosSk 的读写权限情况来判断是否只读。如果上述两种情况相关参数都没填，则表示使用默认值 false。

返回参数

参数	类型	示例值	说明
OrderNo	String	Order722439***919397	费用中心订单 ID。

请求示例

创建一个不开启缓存加速的文件存储场景实例。

POST https://open.volcengineapi.com?Action=CreateFs&Version=2022-02-02
Content-Type: application/json
Region: cn-beijing
ServiceName: cfs
{
"FsName": "doc-test-cfs-1",
"ChargeType": "POST_CHARGE",
"BillingType": "MONTHLY",
"ZoneId": "cn-beijing-b",
"CachePlan": "DISABLED",
"Mode": "HDFS_MODE"
}

创建一个开启缓存加速的文件存储场景实例。

POST https://open.volcengineapi.com?Action=CreateFs&Version=2022-02-02
Content-Type: application/json
Region: cn-beijing
ServiceName: cfs
{
"FsName": "doc-test-cfs-2",
"ChargeType": "POST_CHARGE",
"BillingType": "MONTHLY",
"ZoneId": "cn-beijing-b",
"CachePlan": "T2",
"CacheCapacityTiB": 10,
"VpcId": "vpc-id23",
"SubnetId": "subnet-id23",
"SecurityGroupId": "sg-id23",
"Mode": "HDFS_MODE",
"TosBucket": "bucket-name",
"TosPrefix": "prefix/"
}

创建一个数据湖场景实例。

POST https://open.volcengineapi.com?Action=CreateFs&Version=2022-02-02
Content-Type: application/json
Region: cn-beijing
ServiceName: cfs
{
"FsName": "doc-test-cfs-3",
"ChargeType": "POST_CHARGE",
"BillingType": "MONTHLY",
"ZoneId": "cn-beijing-b",
"CachePlan": "T2",
"CacheCapacityTiB": 10,
"VpcId": "vpc-id23",
"SubnetId": "subnet-id23",
"SecurityGroupId": "sg-id23",
"Mode": "ACC_MODE",
"TosBucket": "bucket-name",
"TosPrefix": "prefix/"
}

返回示例

{
    "Result": {
        "OrderNo": "Order722439***919397"
    },
    "ResponseMetadata": {
        "RequestId": "202304211451**D062E884CED795",
        "Action": "CreateFs",
        "Version": "2022-02-02",
        "Service": "cfs",
        "Region": "cn-beijing",
        "Error": null
    }
}

错误码

下表列举了本接口的错误码信息。公共错误码信息，请参考公共错误码。

HttpCode	错误码	错误信息
400	InvalidFsName	输入 FsName 时，文件存储实例名称不合法。文件存储实例名称仅支持字母、数字、英文，且以字母开头。文件存储实例名称字符长度在 2-63 内。
400	EmptyRegionId	可用地域不应为空。
400	InvalidRegionId	可用区域不存在或者与 CFS 服务注册的 Region 不符。
400	InvalidZoneId	可用区域不存在。
400	EmptyZoneId	可用区域不应为空。
400	InvalidCachePlan	不支持的加速方案，可用方案为 T2 和 T4。
400	EmptyVpcId	当 EnableCache 为 true 时，VpcId 不应为空。
404	VpcIdNotFound	VpcId 不存在。
400	InvalidVpcId	VpcId 不在本区。
400	EmptySubnetId	当 EnableCache 为 true 时，SubnetId 不应为空。
404	SubnetIdNotFound	SubnetId 不存在。
400	InvalidSubnetId	SubnetId 不在本区。
400	EmptySecurityId	EnableCache 为 true 时，SecurityGroupId 不为空。
400	InvalidSecurityId	SecurityId 不在本区。
404	SecurityIdNotFound	SecurityId 不存在。
400	InvalidMode	Mode 不合法。
400	ModeNotSupport	当前 Mode 不受支持，无法开通。
400	EmptyTosBucket	TosBucket 不应为空。
404	TosBucketNotFound	TosBucket 不存在或不属于该用户。
400	InvalidTosPrefix	TosPrefix 不合法。
404	TosAccountIdNotFound	TosAccountId 不存在。
400	EmptyTosAk	TosAk 为空。
400	EmptyTosSk	TosSk 为空。
400	InvalidTosCredentials	TosCredentials 不合法。
500	FsNameExisted	FsName 已存在，无法创建。