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

文档中心

立即注册

导航

EnableCacheAccess

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

调用 EnableCacheAccess 接口，为启用缓存加速功能的文件存储实例挂载 VPC。

注意事项

只有开启缓存加速功能的文件存储实例，才支持挂载 VPC。启用缓存加速相关接口，请参见UpdateFs。
一个文件存储实例中，最多支持挂载 3 个 VPC。达到最大数量限制时，无法继续挂载 VPC。

请求参数

参数	类型	是否必填	示例值	说明
FsName	String	是	doc-test-cfs-1	文件系统存储名称。
AccessAccountId	Integer	否	2100**903	挂载当前账号的 VPC 时，该参数无需填写。需要挂载其他账号的 VPC 时，需要填写该账号的 ID。
AccessIamRole	String	否	RoleForCFSCacheAccess	如果挂载其他账号的 VPC，其他账号需要创建一个具有 `CFSCacheAccess` 权限的角色，并将角色名作为参数输入。说明如果填写其他账号的 ID，则该参数必填。
VpcId	String	是	vpc-id23	私有网络 ID。如何创建私有网络，请参见私有网络。
SubnetId	String	是	subnet-id23	子网 ID。如何创建子网，请参见子网。
SecurityGroupId	String	是	sg-id23	安全组 ID。如何创建安全组，请参见安全组。
VpcRouteEnabled	Boolean	否	false	是否开启全 VPC 访问。 true：开启 false：默认值，表示不开启。

返回参数

参数	类型	示例值	说明
TaskId	String	c53af254-**-23c48c442719	返回的后端任务 ID。

请求示例

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

返回示例

{
    "Result": {
        "TaskId": "c53af254-***-23c48c442719"
    },
    "ResponseMetadata": {
        "RequestId": "202304231***84DEB65B06D0E7",
        "Action": "EnableCacheAccess",
        "Version": "2022-02-02",
        "Service": "cfs",
        "Region": "cn-beijing",
        "Error": null
    }
}

错误码

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

HttpCode	错误码	错误信息
400	EmptyFsName	FsName 为空。
400	InvalidFsName	输入 FsName 时，文件存储实例名称不合法。文件存储实例名称仅支持字母、数字、英文，且以字母开头。文件存储实例名称字符长度在 2-63 内。
400	EmptyAccessIamRole	AccessIamRole 为空。
400	InvalidAccessIamRole	AccessIamRole 不合法。