API概览

更新时间:
复制 MD 格式

API标准及多语言预置SDK

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

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

自定义签名场景

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

账号与安全准备

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

云资源管理

API

标题

API概述

DescribeUserResources 查询用户拥有的无影云资源列表 查询用户资源列表。
GetCloudDriveServiceMountToken 获取企业网盘登录凭证 获取企业网盘登录凭证。
VerifyCredential 验证客户端本地会话解锁的凭证 验证客户端本地会话解锁的凭证。

用户登录

API

标题

API概述

GetLoginToken 获取登录凭证 获取登录凭证。
RefreshLoginToken 刷新登录凭证 刷新登录凭证。
SendTokenCode 发送登录验证码信息 发送登录验证码信息。
ChangePassword 修改密码 修改用户密码。
ResetPassword 重置密码 重置用户密码。
EncryptPassword 加密密码 加密用户密码。
DescribeFingerPrintTemplates 查询指纹模板 查询指纹模板。

其他

API

标题

API概述

ApproveFotaUpdate 允许云电脑OTA升级 允许云电脑OTA升级。
DescribeDirectories 查询目录详细信息 查询目录详细信息。
DescribeGlobalDesktops 查询全地域云电脑详细信息 查询多个地域的云电脑详细信息。目前仅支持中国内地对应的地域查询(不包含:南京-本地地域-关停中)。
DescribeOfficeSites 查询办公网络详细信息 查询办公网络的详细信息。
DescribeSnapshots 查询云电脑快照信息 查询一台云电脑的快照列表和快照详细信息。
GetConnectionTicket 获取云电脑连接凭证 获取云电脑连接凭证。
RebootDesktops 重启云电脑 重启一台或者多台云电脑。
ResetSnapshot 恢复快照对应的磁盘数据 恢复快照对应的磁盘数据。
StartDesktops 启动云电脑 启动一台或者多台云电脑。
StopDesktops 停止云电脑 停止一台或者多台云电脑。
UnbindUserDesktop 将用户与云电脑解绑 将用户与云电脑解绑。