API标准及多语言预置SDK
本产品（NAS/2017-06-26）的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 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文件系统的存储容量。 |
| 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 | 查询低频/归档的文件信息 | 查询指定目录下是否包含低频存储和归档存储文件，或者查询指定文件是否为低频存储或归档存储文件。 |
| 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 | 查询已删除的文件或目录 | 查询已删除的文件或目录。 |
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概述 |
| ChangeResourceGroup | 更改资源组 | 修改文件系统实例所属的资源组。 |
虚拟存储通道
|
API |
标题 |
API概述 |
| DetachVscFromFilesystems | 取消VSC设备关联到文件系统 | 取消 VSC 设备关联到文件系统。 |
| AttachVscToFilesystems | 关联VSC设备到文件系统 | 关联 VSC 设备到文件系统。 |
| DescribeFilesystemsVscAttachInfo | 查询文件系统关联的虚拟存储通道信息 | 查询文件系统关联的虚拟存储通道信息。 |
该文章对您有帮助吗？