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概述 |
|---|---|---|
| DescribeZones | 查询可用区 | 查询一个地域下的所有可用区及可用区所支持的文件系统类型。 |
| DescribeRegions | 查询地域 | 查询可以使用的阿里云地域。 |
文件系统
| API | 标题 | API概述 |
|---|---|---|
| CreateFileSystem | 创建文件系统 | 创建一个文件系统。 |
| DeleteFileSystem | 删除文件系统 | 删除一个文件系统。 |
| ModifyFileSystem | 修改文件系统的描述信息 | 修改文件系统的描述信息。 |
| DescribeFileSystems | 查询文件系统信息 | 查询文件系统信息。 |
| UpgradeFileSystem | 扩容文件系统存储容量 | 扩容极速型NAS文件系统或CPFS文件系统的存储容量。 |
挂载点
| API | 标题 | API概述 |
|---|---|---|
| CreateMountTarget | 创建挂载点 | 创建挂载点。 |
| DeleteMountTarget | 删除挂载点 | 删除已存在挂载点。 |
| DescribeMountTargets | 查询挂载点信息 | 查询挂载点信息。 |
权限组
| API | 标题 | API概述 |
|---|---|---|
| DescribeAccessGroups | 查询权限组信息 | 查询权限组信息。 |
文件集
| API | 标题 | API概述 |
|---|---|---|
| CreateFileset | 创建文件集 | 创建一个Fileset。 |
| DeleteFileset | 删除文件集 | 删除一个Fileset。 |
| ModifyFileset | 修改文件集 | 修改一个Fileset信息。 |
| GetFileset | 查询文件集信息 | 查询创建的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 | 查询协议服务导出目录 | 查询协议服务导出目录。 |
| GetProtocolMountTarget | 查询协议服务导出目录信息 |
虚拟存储通道
| API | 标题 | API概述 |
|---|---|---|
| DetachVscFromFilesystems | 取消VSC设备关联到文件系统 | 取消 VSC 设备关联到文件系统。 |
| AttachVscToFilesystems | 关联VSC设备到文件系统 | 关联 VSC 设备到文件系统。 |
| DescribeFilesystemsVscAttachInfo | 查询文件系统关联的虚拟存储通道信息 | 查询文件系统关联的虚拟存储通道信息。 |
其他-不发布文档
| API | 标题 | API概述 |
|---|---|---|
| LDAP | LDAP | |
| CreateLDAPConfig | 添加LDAP | 添加LDAP配置。 |
| DeleteLDAPConfig | 删除LDAP设置 | 用于删除LDAP设置。 |