API概览

更新时间:
复制为 MD 格式

API标准及多语言预置SDK

本产品(文件存储(NAS/CPFS)/2017-06-26)的 OpenAPI 采用 RPC 签名机制,具体签名方式请参见签名机制说明我们已为开发者封装了主流编程语言的 SDK,您可通过 下载 SDK 快速调用 API,无需关注签名等底层实现细节,显著降低开发门槛与集成复杂度。

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的 RAM 用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

服务操作

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

文件集

API标题API概述
CreateFileset创建文件集创建一个Fileset。
DeleteFileset删除文件集删除一个Fileset。
ModifyFileset修改文件集修改一个Fileset信息。
GetFileset查询文件集信息查询创建的Fileset信息。
DescribeFilesets查询文件集列表查询已创建的Fileset列表信息。
SetFilesetQuota为文件集设置配额设置文件集配额。
CancelFilesetQuota为文件集取消配额取消文件集设置的配额。

数据流动

API标题API概述
CreateDataFlow创建数据流动创建一个CPFS文件系统与源端存储的数据流动。
DeleteDataFlow删除数据流动删除一个数据流动。
ModifyDataFlow修改数据流动修改数据流动的属性。
DescribeDataFlows查询数据流动列表查询一个CPFS文件系统的数据流动信息。
CreateDataFlowTask创建数据流动任务创建一个数据流动任务。
CreateDataFlowSubTask创建数据流动流式子任务创建数据流动流式任务的子任务。
CancelDataFlowTask取消数据流动任务取消一个Pending(等待)或Executing(运行中)状态的数据流动批式任务或流式任务。
CancelDataFlowSubTask取消数据流动流式子任务取消数据流动流式任务。
DescribeDataFlowTasks查询数据流动任务列表查询数据流动任务详细信息。
DescribeDataFlowSubTasks查询数据流动流式子任务列表查询数据流动批量子任务。

资源组

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

协议服务

API标题API概述
GetProtocolMountTarget查询协议服务导出目录信息查询协议服务导出目录信息。

虚拟存储通道

API标题API概述
DetachVscFromFilesystems取消VSC设备关联到文件系统取消 VSC 设备关联到文件系统。
AttachVscToFilesystems关联VSC设备到文件系统关联 VSC 设备到文件系统。
DescribeFilesystemsVscAttachInfo查询文件系统关联的虚拟存储通道信息查询文件系统关联的虚拟存储通道信息。