API概览

更新时间:
复制为 MD 格式

本产品(NAS/2017-06-26)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

服务操作

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 IDvSwitch ID不允许修改,如果需要修改,需要删除导出目录再新建。
DescribeProtocolMountTarget 查询协议服务导出目录 查询协议服务导出目录。
GetProtocolMountTarget 查询协议服务导出目录信息 查询协议服务导出目录信息。