API標準及多語言預置SDK
本產品（NAS/2017-06-26）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。
在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。
自訂簽名情境
若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：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文件系统的存储容量。 |
| DescribeFilesystemsAssociatedHpnZones | 查询文件系统关联的HpnZone列表 | 查询文件系统关联的 HpnZone 列表，当计算节点位于关联的 HpnZone 中时，访问文件系统的性能最优。 |
掛載點
|
API |
標題 |
API概述 |
| CreateMountTarget | 创建挂载点 | 创建挂载点。 |
| DeleteMountTarget | 删除挂载点 | 删除已存在挂载点。 |
| DescribeMountTargets | 查询挂载点信息 | 查询挂载点信息。 |
權限群組
|
API |
標題 |
API概述 |
| DescribeAccessGroups | 查询权限组信息 | 查询权限组信息。 |
檔案集
|
API |
標題 |
API概述 |
| CreateFileset | 创建文件集 | 创建一个Fileset。 |
| DeleteFileset | 删除文件集 | 删除一个Fileset。 |
| ModifyFileset | 修改文件集 | 修改一个Fileset信息。 |
| GetFileset | 查询文件集信息 | 查询创建的Fileset信息。 |
| DescribeFilesets | 查询文件集列表 | 查询已创建的Fileset列表信息。 |
資料流動
|
API |
標題 |
API概述 |
| CreateDataFlow | 创建数据流动 | 创建一个CPFS通用版或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 | 查询协议服务导出目录信息 | 查询协议服务导出目录信息。 |