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

文档中心

导航

UpdateFs

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

调用 UpdateFs 接口，启用文件存储实例的缓存加速功能，或扩大缓存容量。

请求参数

名称	类型	是否必填	示例值	描述
FsName	String	是	doc-test-cfs-1	目标文件存储实例的名称。
CachePlan	String	是	T2	文件存储实例的加速方案： 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：默认值，表示不开启。

返回数据

字段	类型	示例值	说明
OrderNo	String	7bf2846***-8a486daece	返回的费用中心订单 ID。

请求示例

启用缓存加速功能

POST https://open.volcengineapi.com?Action=UpdateFs&Version=2022-02-02
Content-Type: application/json
Region: cn-beijing
ServiceName: cfs
{
"FsName": "doc-test-cfs-1",
"CachePlan": "T2",
"CacheCapacityTiB": 10,
"VpcId": "vpc-id123",
"SubnetId": "subnet-id123",
"SecurityGroupId": "sg-id123"
}

扩大缓存容量

POST https://open.volcengineapi.com?Action=UpdateFs&Version=2022-02-02
Content-Type: application/json
Region: cn-beijing
ServiceName: cfs
{
"FsName": "doc-test-cfs-1",
"CachePlan": "T2",
"CacheCapacityTiB": 15
}

返回示例

{
    "Result": {
        "OrderNO": "7bf2846***8a486daece"
    },
    "ResponseMetadata": {
        "RequestId": "202304231637**200D183103359D",
        "Action": "UpdateFs ",
        "Version": "2022-02-02",
        "Service": "cfs",
        "Region": "cn-beijing",
        "Error": null
    }
}

错误码

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

HttpCode	错误码	错误信息
400	InvalidFsName	输入 FsName 时，文件存储实例名称不合法。文件存储实例名称仅支持字母、数字、英文，且以字母开头。文件存储实例名称字符长度在 2-63 内。
404	FsNameNotFound	FsName 不属于本账户。
400	EmptyRegionId	可用地域不应为空。
400	InvalidRegionId	可用区域不存在或者与 cfs 服务注册的 region 不符。
500	NoImproveCachePlan	加速方案应该等于或者大于之前的方案。
500	NoImproveCacheCapacity	容量应大于等于之前的容量。