更新时间:2025-07-22 GMT+08:00

API概览

弹性文件服务所提供的接口分为SFS接口、SFS Turbo接口与OpenStack原生接口。

通过配合使用弹性文件服务所提供的接口和OpenStack原生接口,您可以完整的使用弹性文件服务的所有功能。

SFS容量型接口调用频率限制为:400次/分钟。若您需要调用的接口较多,可能存在因限频出现拉取失败的情况,建议尽量将请求按时间维度均摊。

SFS容量型接口,与mitaka版本的openstack组件manila部分接口相同,相关接口使用方式也可以参考开源社区接口说明,链接地址:

https://docs.openstack.org/api-ref/shared-file-system/

使用企业项目功能时,关于SFS容量型API接口是否支持企业项目,请参考API授权项列表

当本文描述内容与上述开源社区的描述不一致时,请以本文描述为准。

SFS容量型接口

表1 接口说明

文件系统类型

接口类型

子类型

说明

SFS

OpenStack原生接口

查询API版本

通过这些接口,可以查询所有API的版本和API版本的详细信息。

文件共享

通过这些接口,您可以创建共享,可获取共享的详细信息,如共享挂载路径等。

共享访问规则

通过这些接口,您可以添加和修改、删除共享的访问规则,如配置VPC等。

配额管理

如果创建共享的个数已经到达上限,您可以通过这些接口,对相关配额进行修改。

扩容缩容

若需要改变已创建的共享的容量大小,您可以通过这些接口,实现文件共享的扩容和缩容。

SFS Turbo接口

通过使用SFS Turbo的接口,您可以完成SFS Turbo的创建、删除、查询、扩容等操作。

表2 接口说明

类型

子类型

说明

SFS Turbo接口

生命周期管理

包括创建文件系统、查询文件系统详细信息、删除文件系统、获取文件系统列表、扩容文件系统等接口。

SFS Turbo接口

连接管理

可以通过该接口修改SFS Turbo文件系统绑定的安全组。

SFS Turbo接口

共享标签

包括创建共享标签、查询共享标签、删除共享标签、批量添加共享标签、查询租户所有共享标签、通过标签查询文件系统列表等接口。

SFS Turbo接口

名称管理

对文件系统进行修改名称操作。

SFS Turbo接口

文件系统管理

包括创建文件系统异步任务、获取文件系统异步任务列表 、获取文件系统异步任务详情、取消/删除文件系统异步任务、获取已挂载的客户端ip信息等接口。

SFS Turbo接口

存储联动管理

指定SFS Turbo文件系统内的目录与OBS对象存储桶进行关联,然后通过创建导入导出任务实现数据同步。

SFS Turbo接口

目录管理

包括创建目标文件夹配额、更新目标文件夹配额、查询目标文件夹配额、删除目标文件夹配额、创建目录、查询目录是否存在、删除文件系统目录、查询目录资源使用情况等接口。

SFS Turbo接口

权限管理

SFS Turbo文件系统权限管理相关接口。

SFS Turbo接口

任务管理

包含查询job的状态详情接口。

通用文件系统接口

表3 接口说明

类型

子类型

说明

通用文件系统接口

文件共享

通过这些接口,您可以创建和删除通用文件系统,可以查询文件系统列表等。

通用文件系统接口

共享访问规则

通过这些接口,您可以设置和获取和删除共享访问规则等。

通用文件系统接口

标签

通过这些接口,您可以批量添加、批量删除和查询标签等。