API概览

本产品(无影云电脑/2020-10-02)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

云资源管理

API标题API概述
DescribeRegions查看可选的地域和可用区
DescribeDirectories查询目录详细信息查询目录详细信息。
DescribeOfficeSites查询办公网络详细信息查询办公网络的详细信息。
DescribeGlobalDesktops查询全地域云电脑详细信息查询多个地域的云电脑详细信息。目前仅支持中国内地对应的地域查询(不包含南京本地地域)。
DescribeUserResources查询用户拥有的无影云资源列表查询用户资源列表。
UnbindUserDesktop将用户与云电脑解绑将用户与云电脑解绑。
GetConnectionTicket获取云电脑连接凭证获取云电脑连接凭证。
StartDesktops启动云电脑启动一台或者多台云电脑。
StopDesktops停止云电脑停止一台或者多台云电脑。
RebootDesktops重启云电脑重启一台或者多台云电脑。
ApproveFotaUpdate允许云电脑OTA升级允许云电脑OTA升级。
DescribeSnapshots查询云电脑快照信息查询一台云电脑的快照列表和快照详细信息。
ResetSnapshot恢复快照对应的磁盘数据恢复快照对应的磁盘数据。
GetCloudDriveServiceMountToken获取企业网盘登录凭证获取企业网盘登录凭证。
VerifyCredential验证客户端本地会话解锁的凭证验证客户端本地会话解锁的凭证。

用户登录

API标题API概述
GetLoginToken获取登录凭证获取登录凭证。
RefreshLoginToken刷新登录凭证刷新登录凭证。
SendTokenCode发送登录验证码信息发送登录验证码信息。
ChangePassword修改密码修改用户密码。
ResetPassword重置密码重置用户密码。
EncryptPassword加密密码加密用户密码。
DescribeFingerPrintTemplates查询指纹模板查询指纹模板。
SetFingerPrintTemplate设置指纹模板
SetFingerPrintTemplateDescription设置指纹模板描述
DeleteFingerPrintTemplate删除指纹模板
IsKeepAlive判断是否已开启保持登录判断客户端是否保持登录状态。