API概览

更新时间:
本产品(文件存储(NAS/CPFS)/2017-06-26)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

服务操作

API标题API概述
OpenNASService开通NAS服务开通NAS服务。

地域

API标题API概述
DescribeZones查询可用区查询一个地域下的所有可用区及可用区所支持的文件系统类型。
DescribeRegions查询地域查询可以使用的阿里云地域。

文件系统

API标题API概述
CreateFileSystem创建文件系统创建一个文件系统。
DeleteFileSystem删除文件系统删除一个文件系统。
ModifyFileSystem修改文件系统的描述信息修改文件系统的描述信息。
DescribeFileSystems查询文件系统信息查询文件系统信息。
UpgradeFileSystem扩容文件系统存储容量扩容极速型NAS文件系统或CPFS文件系统的存储容量。

权限组

API标题API概述
DescribeAccessGroups查询权限组信息查询权限组信息。

文件集

API标题API概述
CreateFileset创建文件集创建一个Fileset。
DeleteFileset删除文件集删除一个Fileset。
ModifyFileset修改文件集修改一个Fileset信息。
DescribeFilesets查询文件集列表查询已创建的Fileset列表信息。

数据流动

API标题API概述
CreateDataFlow创建数据流动创建一个CPFS文件系统与源端存储的数据流动。
DeleteDataFlow删除数据流动删除一个数据流动。
ModifyDataFlow修改数据流动修改数据流动的属性。
DescribeDataFlows查询数据流动列表查询一个CPFS文件系统的数据流动信息。
StopDataFlow停用数据流动停用一个数据流动。
StartDataFlow启用数据流动启用一个数据流动。
CreateDataFlowTask创建数据流动任务创建一个数据流动任务。
CancelDataFlowTask取消数据流动任务取消一个Pending(等待)或Executing(运行中)状态的数据流动批式任务或流式任务。
DescribeDataFlowTasks查询数据流动任务列表查询数据流动任务详细信息。
ApplyDataFlowAutoRefresh添加数据流动自动更新配置为指定数据流动配置自动更新。
CancelDataFlowAutoRefresh取消数据流动自动更新配置取消指定数据流动上的自动更新配置。
ModifyDataFlowAutoRefresh修改数据流动自动更新配置修改数据流动中的自动更新配置。

资源组

API标题API概述
ChangeResourceGroup更改资源组修改文件系统实例所属的资源组。

协议服务

API标题API概述
CreateProtocolService创建协议服务创建CPFS文件系统的协议服务,创建协议服务过程大约需要5~10分钟。
DeleteProtocolService删除协议服务删除CPFS文件系统的协议服务。
ModifyProtocolService修改协议服务修改一个协议服务,支持修改协议服务描述信息。
DescribeProtocolService查询协议服务信息查询协议服务信息。
CreateProtocolMountTarget创建协议服务导出目录创建一个协议服务导出目录。
DeleteProtocolMountTarget删除协议服务导出目录删除一个协议服务导出目录。
ModifyProtocolMountTarget修改协议服务的导出目录参数修改协议服务的导出目录参数,只能修改权限组和描述信息。VPC ID和vSwitch ID不允许修改,如果需要修改,需要删除导出目录再新建。
DescribeProtocolMountTarget查询协议服务导出目录查询协议服务导出目录。