API标准及多语言预置SDK
本产品（appstream-center/2021-09-01）的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
Agent管理
|
API |
标题 |
API概述 |
| Agent运行时管理 | Agent运行时管理 | |
| ListDesktopAgentRuntime | 查询Agent运行时列表 | 查询桌面Agent运行时列表。 |
| Agent模型管理 | Agent模型管理 | |
| GetRuntimeModelConfig | 查询Agent运行时的模型配置 | 查询云电脑模型配置详情 |
| ConfigRuntimeModelTemplate | 配置Agent运行时资源的模型分组 | 配置Agent运行时资源的模型分组。 |
| RemoveRuntimeModelTemplate | 移除Agent运行时资源的模型分组 | 移除Agent运行时资源的模型分组。 |
| ListModelTemplateResourceGroup | 查询模型分组绑定的资源组列表 | 查询模型分组绑定的资源组列表。 |
| ConfigResourceGroupModelTemplate | 配置资源组的模型分组 | 配置资源组的模型分组。 |
| RemoveResourceGroupModelTemplate | 移除资源组的模型分组 | 移除资源组的模型分组。 |
| Agent通道管理 | Agent通道管理 | |
| GetRuntimeChannel | 查询Agent运行时的三方通道配置 | 查询Agent运行时的三方通道配置。 |
| ConfigRuntimeChannel | 配置Agent运行时的三方通道 | 配置Agent运行时的三方通道。 |
| RemoveRuntimeChannel | 移除Agent运行时的三方通道配置 | 移除Agent运行时的三方通道配置。 |
| 模型分组管理 | 模型分组管理 | |
| CreateModelTemplate | 创建模型分组 | 创建模型模板 |
| UpdateModelTemplate | 更新模型分组 | 更新模型模板 |
| DeleteModelTemplate | 删除模型分组 | 删除模型模板 |
| ListModelTemplates | 查询模型分组列表 | 查询模型模板列表 |
| CreateModelProviderTemplate | 创建模型服务商模板 | 创建模型提供商模板 |
| UpdateModelProviderTemplate | 更新模型服务商模板 | 更新模型提供商模板 |
| DeleteModelProviderTemplate | 删除模型服务商模板 | 删除模型提供商模板 |
| GetModelProviderTemplate | 查询模型服务商模板详情 | 查询模型提供商模板详情 |
| ListModelProviderTemplates | 查询模型服务商模板列表 | 查询模型提供商模板列表 |
| BatchCreateLlmTemplates | 批量创建模型模板 | 批量创建LLM模板 |
| DeleteLlmTemplate | 删除模型模板 | 删除LLM模板 |
| ListLlmTemplates | 查询模型模板列表 | 查询LLM模板列表 |
地域
|
API |
标题 |
API概述 |
| ListRegions | 查询支持的地域 | 查询无影云应用支持的地域。 |
资源
|
API |
标题 |
API概述 |
| ListNodes | 查询资源节点列表 | 查询资源节点列表。 |
| ModifyNodePoolAmount | 资源节点池中节点变配 | 包年包月交付组节点数量升级。 |
| ListNodeInstanceType | 查询资源规格 | 查询创建交付组时可选购的资源规格。 |
| GetResourcePrice | 查询资源价格 | 查询资源的价格信息。 |
| GetResourceRenewPrice | 查询资源续费价格 | 查询无影云应用资源的续费价格。 |
镜像
|
API |
标题 |
API概述 |
| ListImage | 查询镜像信息 | 查询镜像信息。 |
| CreateImageByInstance | 通过实例创建自定义镜像 | 通过已部署好的无影实例创建自定义镜像，以便快速创建更多相同配置的无影实例，避免每次创建时重复配置实例环境。 |
| StartTaskForDistributeImage | 发起镜像地域复制任务 | 发起镜像复制到其他地域的任务。 |
| DeleteImage | 删除自定义镜像 | 删除一个自定义的无影镜像 |
交付组
|
API |
标题 |
API概述 |
| CreateAppInstanceGroup | 创建交付组 | 创建交付组。 |
| GetAppInstanceGroup | 查询指定交付组详细信息 | 查询指定交付组详细信息。 |
| ListAppInstanceGroup | 查询多个交付组详细信息 | 查询多个交付组详细信息，即不指定特定的交付组，而是查询所有满足条件的交付组的详细信息。 |
| PageListAppInstanceGroupUser | 分页查询交付组的分配用户 | 分页查询交付组中已添加的分配用户。 |
| RenewAppInstanceGroup | 为交付组续费 | 为交付组续费。 |
| UpdateAppInstanceGroupImage | 更新交付组镜像 | 更新交付组的镜像。 |
| ModifyAppInstanceGroupAttribute | 修改交付组通用策略 | 修改交付组的通用策略，包括并发会话数、会话断连保留时长等。 |
| ModifyNodePoolAttribute | 修改交付组弹性模式 | 修改交付组的弹性模式，包括固定数量（不使用弹性扩缩容）、定时扩缩容和自动扩缩容。 |
| AuthorizeInstanceGroup | 为交付组添加或移除分配用户 | 为交付组添加或移除分配用户。只有添加到分配用户的用户可访问云应用。 |
| LogOffAllSessionsInAppInstanceGroup | 注销交付组下所有会话 | 注销已开启定时扩缩容策略的按量付费交付组下所有会话。 |
| DeleteAppInstanceGroup | 删除按量付费交付组 | 删除"资源型-按量付费"形式的交付组。 |
| ModifyAppPolicy | 修改交付组显示策略 | 修改交付组显示策略，包括帧率、分辨率、协议类型等设置。 |
| ListAuthorizedUserGroups | 查询交付组授权的用户组列表 | 通过交付组查询该交付组授权的用户组列表。 |
应用实例
|
API |
标题 |
API概述 |
| ListAppInstances | 查询交付组内实例详细信息 | 查询交付组内会话实例的详细信息，包括实例ID、实例状态、创建时间、更新时间、会话状态、主网卡公网IP等。 |
| DeleteAppInstances | 删除指定应用实例 | 删除指定应用实例。 |
| ListPersistentAppInstances | 查询持久会话应用实例列表 | 查询交付组内的持久会话应用实例列表。 |
连接
|
API |
标题 |
API概述 |
| GetConnectionTicket | 获取云应用连接凭证 | 获取云应用连接凭证。 |
| Unbind | 解绑用户和会话 | 解绑用户和会话。 |
| ListBindInfo | 查询绑定信息 | 查询用户与资源之间的绑定信息。 |
调试
|
API |
标题 |
API概述 |
| CreateImageFromAppInstanceGroup | 通过调试交付组创建新镜像 | 通过调试交付组创建新镜像。 |
| GetDebugAppInstance | 获取调试应用实例信息 | 获取调试应用实例信息。 |
OTA升级
|
API |
标题 |
API概述 |
| ListOtaTask | 查询OTA升级历史记录 | 查询OTA升级历史记录。 |
| GetOtaTaskByTaskId | 查询OTA升级任务明细 | 查询OTA升级任务明细，包括可升级版本、版本说明等。 |
| ApproveOtaTask | 设置OTA升级执行时间 | 设置OTA升级的执行时间。 |
管理员账号
|
API |
标题 |
API概述 |
| ListTenantConfig | 查询管理员账号配置信息 | 查询管理员账号配置信息，例如是否已开启资源到期提醒。 |
| ModifyTenantConfig | 修改管理员账号配置信息 | 修改管理员账号配置信息，例如是否开启资源到期提醒。 |
资源标签
|
API |
标题 |
API概述 |
| ListTagCloudResources | 查询云资源的标签列表 | 查询一个或多个指定云资源的标签列表。 |
| TagCloudResources | 为云资源创建并绑定标签 | 为云资源创建并绑定标签，对于资源已有的标签，则更新标签的值。 |
| UntagCloudResources | 解除云资源的标签 | 为云资源统一解绑标签。 |
无影工作站
|
API |
标题 |
API概述 |
| DescribeWuyingServerEipInfo | 查询无影工作站EIP信息 | 查询无影工作站EIP信息。 |
| CreateWuyingServer | 创建工作站 | 创建一台或多台工作站。 |
| ListWuyingServer | 查询工作站 | 查询工作站列表。 |
| StartWuyingServer | 启动工作站 | 启动工作站。 |
| StopWuyingServer | 停止工作站 | 停止工作站。 |
| RestartWuyingServer | 重启工作站 | 重启工作站。 |
| ModifyWuyingServerAttribute | 修改工作站属性 | 修改工作站属性。 |
| UpdateWuyingServerImage | 更新工作站镜像 | 更新工作站镜像。 |
| RenewWuyingServer | 续费工作站 | 为一台工作站续费。 |
| DeleteWuyingServer | 删除工作站 | 删除工作站 |
其他
|
API |
标题 |
API概述 |
| ModifyBrowserInstanceGroup | 修改云浏览器 | 修改无影云浏览器属性。 |
| AssignWuyingServerPrivateAddresses | 无影工作站分配辅助私有IP地址 | 为研发主机分配辅助私有IP |
| DeliverToUserSls | 投递操作日志到用户SLS | 配置SLS日志投递 |
| DescribeWuyingServer | 查询无影工作站详情 | 查询研发主机详情 |
| UnassignWuyingServerPrivateAddresses | 解绑无影工作站的辅助私有IP地址 | 解绑研发主机的辅助私有IP |
该文章对您有帮助吗？