API概览

更新时间:
复制为 MD 格式

API标准及多语言预置SDK

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

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

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

地域

API

标题

API概述

DescribeRegions 查询可以使用的阿里云地域 查询您可以使用的阿里云地域。
GetRegion 查询可用区 查询指定地域下每个可用区的配置信息。

文件系统

API

标题

API概述

CreateFileSystem 创建文件系统 创建文件系统。
DeleteFileSystem 删除文件系统 删除已有的文件系统。
ModifyFileSystem 修改文件系统属性 修改文件系统属性。
ListFileSystems 批量获取文件系统详细信息 批量获取文件系统详细信息。
GetFileSystem 获取文件系统详细信息 查询文件系统信息。

挂载点

API

标题

API概述

CreateMountPoint 创建挂载点 创建一个挂载点。
DeleteMountPoint 删除挂载点 删除一个挂载点。
ModifyMountPoint 修改挂载点信息 修改一个挂载点信息。
ListMountPoints 批量查询挂载点信息 批量查询挂载点信息。
GetMountPoint 查询挂载点信息 查询一个挂载点信息。

权限组

API

标题

API概述

CreateAccessGroup 创建权限组 创建一个权限组。
DeleteAccessGroup 删除权限组 删除一个权限组。
ModifyAccessGroup 修改权限组信息 修改一个权限组信息。
ListAccessGroups 批量查询权限组详细信息 批量查询权限组详细信息。
GetAccessGroup 获取权限组信息 获取权限组信息。

权限规则

API

标题

API概述

CreateAccessRule 创建权限规则 创建权限组规则。
DeleteAccessRule 删除权限组规则 删除一个权限组规则。
ModifyAccessRule 修改权限组规则 修改一个权限组规则。
GetAccessRule 查询权限组规则信息 查询权限组规则信息。
ListAccessRules 批量查询权限组规则 批量查询权限组规则。

用户和组映射

API

标题

API概述

CreateUserGroupsMapping 创建用户和组的映射关系 创建文件存储 HDFS 版文件系统实例的用户和组的映射关系。
DeleteUserGroupsMapping 删除用户和组的映射关系 删除文件存储 HDFS 版文件系统实例的用户和组的映射关系。
ListUserGroupsMappings 查看用户和组的映射关系 查看文件存储 HDFS 版文件系统实例的用户和组的映射关系 。

VSC挂载点

API

标题

API概述

CreateVscMountPoint 创建VSC挂载点 创建一个VSC挂载点。
DeleteVscMountPoint 删除VSC挂载点 删除已存在的VSC挂载点。
AttachVscMountPoint 绑定VSC挂载点 为挂载点添加计算实例。
BindVscMountPointAlias 绑定VSC挂载点别名 为文件系统绑定VSC挂载点别名。
DetachVscMountPoint 解绑VSC挂载点 为挂载点解绑计算实例。
DescribeVscMountPoints 获取VSC挂载点信息列表 获取VSC挂载点信息列表。

其他

API

标题

API概述

AttachVscToMountPoints 批量挂载存储 批量挂载VSC挂载点
DescribeMountPointsVscAttachInfo 批量查询挂载信息 批量查询VSC挂载信息
DetachVscFromMountPoints 批量卸载存储 批量卸载VSC 挂载点