文档

API概览

更新时间:
本产品(文件存储(NAS/CPFS)/2017-06-26)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用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概述
ChangeResourceGroup更改资源组修改文件系统实例所属的资源组。
  • 本页导读 (1)