本產品（
文件存儲（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概述 |
|---|---|---|
| CreateMountTarget | 創建掛載點 | 創建掛載點。 |
| DeleteMountTarget | 刪除掛載點 | 刪除已存在掛載點。 |
| ModifyMountTarget | 修改掛載點信息 | 修改掛載點信息。 |
| DescribeMountTargets | 查詢掛載點信息 | 查詢掛載點信息。 |
| DescribeMountedClients | 查詢已掛載的客戶端列表 | 查詢已掛載的客戶端列表。 |
接入點
| API | 標題 | API概述 |
|---|---|---|
| CreateAccessPoint | 創建接入點 | 創建接入點。 |
| ModifyAccessPoint | 修改接入點信息 | 修改接入點信息。 |
| DescribeAccessPoints | 查詢接入點信息 | 查詢接入點信息。 |
| DescribeAccessPoint | 查詢接入點詳情 | 查詢接入點詳情。 |
| DeleteAccessPoint | 刪除接入點 | 刪除接入點。 |
| CreateDir | 創建目錄 | 在文件系統中創建目錄。 |
權限組
| API | 標題 | API概述 |
|---|---|---|
| CreateAccessGroup | 創建權限組 | 創建權限組。 |
| DeleteAccessGroup | 刪除權限組 | 刪除已有的權限組。 |
| ModifyAccessGroup | 修改權限組 | 修改權限組。 |
| DescribeAccessGroups | 查詢權限組信息 | 查詢權限組信息。 |
| CreateAccessRule | 創建權限組規則 | 創建權限組規則。 |
| DeleteAccessRule | 刪除權限組規則 | 刪除已創建的權限組規則。 |
| ModifyAccessRule | 修改權限組規則 | 修改一個權限組規則。 |
| DescribeAccessRules | 查詢權限規則描述 | 查詢權限規則描述。 |
快照
| API | 標題 | API概述 |
|---|---|---|
| CreateSnapshot | 創建快照 | 創建一個快照。 |
| DeleteSnapshot | 刪除快照或取消正在創建的快照任務 | 刪除指定的快照或取消正在創建的快照任務。 |
| DescribeSnapshots | 查詢快照列表 | 查詢指定文件系統一個或多個快照的信息。 |
| CreateAutoSnapshotPolicy | 創建一條自動快照策略 | 創建一條自動快照策略。 |
| DeleteAutoSnapshotPolicy | 刪除自動快照策略 | 刪除一條自動快照策略。 |
| ModifyAutoSnapshotPolicy | 修改自動快照策略 | 修改一條自動快照策略。修改自動快照策略后，之前已應用該策略的文件系統隨即執行修改后的自動快照策略。 |
| ApplyAutoSnapshotPolicy | 為文件系統應用自動快照策略 | 為一個或者多個文件系統應用自動快照策略。 |
| CancelAutoSnapshotPolicy | 取消一個或者多個文件系統的自動快照策略 | 取消一個或者多個文件系統的自動快照策略。 |
| DescribeAutoSnapshotPolicies | 查詢已創建的自動快照策略 | 查詢已創建的自動快照策略。 |
| DescribeAutoSnapshotTasks | 查詢自動快照的任務列表 | 查詢自動快照的任務列表。 |
| ResetFileSystem | 使文件系統回滾至某一階段 | 使文件系統回滾至某一歷史快照的文件系統狀態。 |
標簽
| API | 標題 | API概述 |
|---|---|---|
| TagResources | 為文件系統創建并綁定標簽 | 為指定文件系統創建并綁定標簽。 |
| UntagResources | 解綁并刪除標簽 | 刪除指定文件系統標簽。 |
| ListTagResources | 查詢標簽的資源 | 查詢標簽列表。 |
配額
| API | 標題 | API概述 |
|---|---|---|
| SetDirQuota | 設置文件系統的目錄配額 | 設置文件系統的目錄配額。 |
| CancelDirQuota | 取消文件系統的目錄配額 | 取消文件系統的目錄配額。 |
| DescribeDirQuotas | 查詢文件系統的目錄配額 | 獲取文件系統每個目錄配額的詳細信息。 |
生命周期管理
| API | 標題 | API概述 |
|---|---|---|
| CreateLifecyclePolicy | 創建生命周期管理策略 | 創建一個生命周期管理策略。 |
| DeleteLifecyclePolicy | 刪除生命周期管理策略 | 刪除一個生命周期管理策略。 |
| ModifyLifecyclePolicy | 修改生命周期管理策略 | 修改一個生命周期管理策略。 |
| GetDirectoryOrFileProperties | 查詢低頻/歸檔的文件信息 | 查詢指定目錄下是否包含低頻存儲和歸檔存儲文件，或者查詢指定文件是否為低頻存儲或歸檔存儲文件。 |
| DescribeLifecyclePolicies | 查詢生命周期管理策略列表 | 獲取生命周期管理策略列表。 |
| CreateLifecycleRetrieveJob | 創建數據取回任務 | 創建一個數據取回任務。 |
| CancelLifecycleRetrieveJob | 取消數據取回任務 | 取消任務狀態為運行中（active）的一個數據取回任務。 |
| RetryLifecycleRetrieveJob | 重試數據取回任務 | 重試任務狀態為已失敗（failed）的數據取回任務。 |
| ListLifecycleRetrieveJobs | 查詢數據取回任務列表 | 獲取已創建的數據取回任務列表。 |
| ListDirectoriesAndFiles | 查詢目錄和文件列表 | 獲取通用型NAS指定目錄下的低頻存儲文件和包含低頻存儲文件的子目錄列表。 |
回收站
| API | 標題 | API概述 |
|---|---|---|
| EnableRecycleBin | 開啟回收站功能 | 開啟回收站功能。 |
| DisableAndCleanRecycleBin | 關閉并清空回收站 | 關閉通用型NAS文件系統的回收站功能，并清空回收站中的數據。 |
| UpdateRecycleBinAttribute | 更改回收站的屬性 | 修改一個回收站中數據的保留時間。 |
| GetRecycleBinAttribute | 獲取回收站的屬性 | 查詢指定通用型NAS文件系統的回收站配置。 |
| CreateRecycleBinRestoreJob | 恢復回收站中暫存的文件 | 恢復一個暫存回收站中的文件。 |
| CreateRecycleBinDeleteJob | 徹底刪除回收站中暫存的文件或目錄 | 創建一個徹底刪除回收站中暫存的文件或目錄的任務。 |
| CancelRecycleBinJob | 取消回收站中的任務 | 取消一個回收站中正在運行中的任務。 |
| ListRecycleBinJobs | 查詢回收站中的任務列表 | 查詢回收站中的一個或多個任務信息。 |
| ListRecentlyRecycledDirectories | 查詢最近刪除的目錄 | 查詢最近執行過刪除操作的目錄。 |
| ListRecycledDirectoriesAndFiles | 查詢已刪除的文件或目錄 | 查詢已刪除的文件或目錄。 |
SMB AD ACL
| API | 標題 | API概述 |
|---|---|---|
| EnableSmbAcl | 開啟SMB AD ACL | 開啟SMB AD ACL功能。 |
| DisableSmbAcl | 關閉SMB AD ACL | 關閉SMB AD ACL功能。 |
| ModifySmbAcl | 更新SMB AD ACL | 更新SMB AD ACL功能。 |
| DescribeSmbAcl | 查看SMB AD ACL | 查看SMB AD ACL功能。 |
| CreateFile | 創建目錄或者文件 | 創建目錄或者文件。 |
NFS NAS ACL
| API | 標題 | API概述 |
|---|---|---|
| EnableNfsAcl | 打開NFS ACL功能 | 開啟NFS ACL功能。 |
| DisableNfsAcl | 關閉NFS ACL功能 | 關閉NFS ACL功能。 |
| DescribeNfsAcl | 查詢NFS ACL | 查詢指定文件系統是否啟用了NFS ACL功能。 |
日志管理
| API | 標題 | API概述 |
|---|---|---|
| CreateLogAnalysis | 創建日志管理的日志模板 | 將通用型NAS文件系統日志轉儲到日志服務中。 |
| DeleteLogAnalysis | 刪除日志管理的日志 | 停止通用型NAS文件系統的日志轉儲。 |
| DescribeLogAnalysis | 獲取日志管理的日志信息 | 列出日志分析中配置的日志轉儲信息。 |
文件集
| API | 標題 | API概述 |
|---|---|---|
| SetFilesetQuota | 為文件集設置配額 | 設置文件集配額。 |
| CancelFilesetQuota | 為文件集取消配額 | 取消文件集設置的配額。 |
資源組
| API | 標題 | API概述 |
|---|---|---|
| ChangeResourceGroup | 更改資源組 | 修改文件系統實例所屬的資源組。 |