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 | 刪除掛載點 | 刪除已存在掛載點。 |
| 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 | 建立生命週期管理策略。 | 建立一個生命週期管理策略。 |
| UpdateLifecyclePolicy | 更新生命週期管理原則的規則 | 更新一個生命週期管理原則的規則。僅智算 CPFS 支援。 UpdateLifecyclePolicy 是覆蓋語義，非必選參數為空白則表示刪除對應欄位。當您需要追加生命週期規則時，請先調用 DescribeLifecyclePolicies 介面擷取當前生命週期規則配置，然後追加新的生命週期規則配置，最後調用 UpdateLifecyclePolicy 介面更新生命週期規則配置。 |
| DeleteLifecyclePolicy | 刪除生命週期管理原則 | 刪除一個生命週期管理原則。 |
| ModifyLifecyclePolicy | 修改生命週期管理原則 | 修改一個生命週期管理原則。 |
| GetDirectoryOrFileProperties | 查詢低頻/歸檔的檔案資訊 | 查詢指定目錄下是否包含低頻儲存和Archive Storage檔案，或者查詢指定檔案是否為低頻儲存或Archive Storage檔案。 |
| DescribeLifecyclePolicies | 查詢生命週期管理策略清單 | 取得生命週期管理策略清單。 |
| CreateLifecycleRetrieveJob | 建立資料取回工作 | 建立一個資料取回工作。 |
| CancelLifecycleRetrieveJob | 取消資料取回任務 | 取消任務狀態為運行中（active）的一個資料取回任務。 |
| RetryLifecycleRetrieveJob | 重試資料取回任務 | 重試任務狀態為已失敗（failed）的資料取回任務。 |
| StartLifecyclePolicyExecution | 啟動執行生命週期策略 | 啟動執行生命週期策略。 |
| StopLifecyclePolicyExecution | 停止執行生命週期策略 | 停止執行生命週期策略。 |
| DescribeLifecyclePolicyLogs | 查詢生命週期策略的作業記錄 | 查詢生命週期策略的作業記錄。 可查詢最近 90 天或最多 1000 條日誌。 僅 CPFS 智算版支援。 |
| ListLifecycleRetrieveJobs | 查詢資料取回工作清單 | 擷取已建立的資料取回工作清單。 |
| ListDirectoriesAndFiles | 查詢目錄和檔案清單 | 擷取通用型NAS指定目錄下的低頻隱藏檔和包含低頻隱藏檔的子目錄列表。 |
資源回收筒
|
API |
標題 |
API概述 |
| EnableRecycleBin | 開啟資源回收筒功能 | 開啟資源回收筒功能。 |
| DisableAndCleanRecycleBin | 關閉並清空資源回收筒 | 關閉通用型NAS檔案系統的資源回收筒功能，並清空資源回收筒中的資料。 |
| UpdateRecycleBinAttribute | 更改資源回收筒的屬性 | 修改一個資源回收筒中資料的保留時間。 |
| GetRecycleBinAttribute | 擷取資源回收筒的屬性 | 查詢指定通用型NAS檔案系統的資源回收筒配置。 |
| CreateRecycleBinRestoreJob | 恢複資源回收筒中暫存的檔案 | 恢複一個暫存資源回收筒中的檔案。 |
| CreateRecycleBinDeleteJob | 徹底刪除資源回收筒中暫存的檔案或目錄。 | 建立一個徹底刪除資源回收筒中暫存的檔案或目錄的任務。 |
| CancelRecycleBinJob | 取消資源回收筒中的任務 | 取消一個資源回收筒中正在運行中的任務。 |
| ListRecycleBinJobs | 查詢資源回收筒中的工作清單 | 查詢資源回收筒中的一個或多個任務資訊。 |
| ListRecentlyRecycledDirectories | 查詢最近刪除的目錄 | 查詢最近執行過刪除操作的目錄。 |
| ListRecycledDirectoriesAndFiles | 查詢已刪除的檔案或目錄 | 查詢已刪除的檔案或目錄。 |
AgenticSpace
|
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 | 建立目錄或者檔案 | 建立目錄或者檔案。 |
SMB AD ACL
|
API |
標題 |
API概述 |
| EnableNfsAcl | 開啟NFS ACL功能 | 開啟NFS ACL功能。 |
| DisableNfsAcl | 關閉NFS ACL功能 | 關閉NFS ACL功能。 |
| DescribeNfsAcl | 查詢NFS ACL | 查詢指定檔案系統是否啟用了NFS ACL功能。 |
NFS NAS ACL
|
API |
標題 |
API概述 |
| CreateLogAnalysis | 建立日誌管理的日誌模板 | 將通用型NAS檔案系統日誌轉儲到Log Service中。 |
| DeleteLogAnalysis | 刪除日誌管理的日誌 | 停止通用型NAS檔案系統的日誌轉儲。 |
| DescribeLogAnalysis | 取得日誌管理的日誌資訊 | 列出日誌分析中配置的日誌轉儲資訊。 |
日誌管理
|
API |
標題 |
API概述 |
| ChangeResourceGroup | 變更資源群組 | 修改檔案系統執行個體所屬的資源群組。 |
資源群組
|
API |
標題 |
API概述 |
| DetachVscFromFilesystems | 取消VSC設備關聯到檔案系統。 | 取消 VSC 設備關聯到檔案系統。 |
| AttachVscToFilesystems | 關聯VSC裝置到檔案系統 | 關聯 VSC 裝置到檔案系統。 |
| DescribeFilesystemsVscAttachInfo | 查詢檔案系統關聯的虛擬儲存通道資訊。 | 查詢檔案系統關聯的虛擬儲存通道資訊。 |