本产品（
无影云应用/2021-09-01）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
云Flow
| API | 标题 | API概述 |
|---|---|---|
| 访问页面 | 访问页面 | |
| AccessPageSetAcl | 访问页面的访问控制管理 | 访问页面的访问控制管理。 |
| CreateAccessPage | 创建访问页面 | 创建访问页面。 |
| GetAccessPageSession | 获取访问页的会话 | 获取访问页的会话凭据，连接至访问页面 |
| ListAccessPages | 获取访问页面列表 | 获取访问页面列表。 |
| RefreshAccessUrl | 刷新访问页超链接 | 重新生成访问页面的超链接 |
| UpdateAccessPageState | 更新访问页面状态 | 更新访问页面状态。 |
| DeleteAccessPage | 删除访问页面 | 删除已经发布的访问页面以及访问页相关的资源。 |
| AccessPageGetAcl | 获取访问页面配置 | 获取访问管理页配置。 |
| 会话包 | 会话包 | |
| AskSessionPackagePrice | 会话包收费查询 | 云Flow会话包收费查询。 |
| ListSessionPackages | 获取项目的会话包列表 | 获取项目的会话包列表。 |
| BuySessionPackage | 加购会话包 | 购买云Flow会话包。 |
| 项目 | 项目 | |
| ModifyProjectPolicy | 修改项目策略 | 修改项目策略。 |
| GetProjectPolicies | 获取项目策略配置 | 获取项目的策略配置。 |
| DeleteProject | 删除项目 | 删除项目。 |
| CreateProject | 创建项目 | 创建一个项目实例，项目实例作用如下 1. 云上环境、会话包和交付组配置的组合体，用户关联这几个实例 2. 作为访问页面的主要输入。 |
| ListProjects | 获取项目列表 | 获取项目列表 |
地域
| API | 标题 | API概述 |
|---|---|---|
| ListRegions | 查询支持的地域 | 查询无影云应用支持的地域。 |
资源
| API | 标题 | API概述 |
|---|---|---|
| ListNodeInstanceType | 查询资源规格 | 查询创建交付组时可选购的资源规格。 |
| GetResourcePrice | 查询资源价格 | 查询资源的价格信息。 |
| GetResourceRenewPrice | 查询资源续费价格 | 查询无影云应用资源的续费价格。 |
交付组
| API | 标题 | API概述 |
|---|---|---|
| CreateAppInstanceGroup | 创建交付组 | 创建交付组。 |
| GetAppInstanceGroup | 查询指定交付组详细信息 | 查询指定交付组详细信息。 |
| ListAppInstanceGroup | 查询多个交付组详细信息 | 查询多个交付组详细信息，即不指定特定的交付组，而是查询所有满足条件的交付组的详细信息。 |
| PageListAppInstanceGroupUser | 分页查询交付组的分配用户 | 分页查询交付组中已添加的分配用户。 |
| RenewAppInstanceGroup | 为交付组续费 | 为交付组续费。 |
| UpdateAppInstanceGroupImage | 更新交付组镜像 | 更新交付组的镜像。 |
| ModifyAppInstanceGroupAttribute | 修改交付组通用策略 | 修改交付组的通用策略，包括并发会话数、会话断连保留时长等。 |
| ModifyNodePoolAttribute | 修改交付组弹性模式 | 修改交付组的弹性模式，包括固定数量（不使用弹性扩缩容）、定时扩缩容和自动扩缩容。 |
| AuthorizeInstanceGroup | 为交付组添加或移除分配用户 | 为交付组添加或移除分配用户。只有添加到分配用户的用户可访问云应用。 |
| LogOffAllSessionsInAppInstanceGroup | 注销交付组下所有会话 | 注销已开启定时扩缩容策略的按量付费交付组下所有会话。 |
| DeleteAppInstanceGroup | 删除按量付费交付组 | 删除使用按量付费资源的交付组。 |
应用实例
| API | 标题 | API概述 |
|---|---|---|
| ListAppInstances | 查询交付组内实例详细信息 | 查询交付组内会话实例的详细信息，包括实例ID、实例状态、创建时间、更新时间、会话状态、主网卡公网IP等。 |
| DeleteAppInstances | 删除指定应用实例 | 删除指定应用实例。 |
连接
| API | 标题 | API概述 |
|---|---|---|
| GetConnectionTicket | 获取云应用连接凭证 | 获取云应用连接凭证。 |
| Unbind | 解绑用户和会话 | 解绑用户和会话。 |
调试
| API | 标题 | API概述 |
|---|---|---|
| CreateImageFromAppInstanceGroup | 通过调试交付组创建新镜像 | 通过调试交付组创建新镜像。 |
| GetDebugAppInstance | 获取调试应用实例信息 | 获取调试应用实例信息。 |
OTA升级
| API | 标题 | API概述 |
|---|---|---|
| ListOtaTask | 查询OTA升级历史记录 | 查询OTA升级历史记录。 |
| GetOtaTaskByTaskId | 查询OTA升级任务明细 | 查询OTA升级任务明细，包括可升级版本、版本说明等。 |
| ApproveOtaTask | 设置OTA升级执行时间 | 设置OTA升级的执行时间。 |
| CancelOtaTask | 取消OTA升级任务 | 取消OTA升级任务。 |
管理员账号
| API | 标题 | API概述 |
|---|---|---|
| ListTenantConfig | 查询管理员账号配置信息 | 查询管理员账号配置信息，例如是否已开启资源到期提醒。 |
| ModifyTenantConfig | 修改管理员账号配置信息 | 修改管理员账号配置信息，例如是否开启资源到期提醒。 |
其他
| API | 标题 | API概述 |
|---|---|---|
| MigrateSessionPackage | 会话包转移 | 支持会话包转移功能，将已付费会话包从 源项目 迁移到 目标项目，源项目和目标项目不可同时为空。 |
| AskSessionPackageRenewPrice | 会话包续费询价 | 查询会话包续费价格 |
| RenewSessionPackage | 会话包续费 | 为已购买未超期的会话包续费 |