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 | 查詢協議服務匯出目錄資訊 | 查詢協議服務匯出目錄資訊。 |