本文记录火山引擎云手机服务端 OpenAPI 功能变更和相关文档的动态。
变更类型 | 接口名称 | 变更详情 |
|---|---|---|
| 参数边界变更 | PowerOnPodPowerOffPodUpdatePodUpdatePodPropertyPushFile | 调用上述接口批量操作实例时，支持的最大实例数量变更为 200 台。具体参看 PodIdList 字段说明。 |
| 参数变更 | 设置代理服务 SetProxy | ProxyConfig 参数新增键值对，支持选择是否在云手机页面内显示代理设置结果。详细参看 ProxyConfig 字段说明新增 proxyVisible 说明。 |
| 新增参数 | 任务执行回调 | 应用安装和应用卸载回调中，新增版本号 version_id 回调，通过 extra 字段返回。 |
变更类型 | 接口名称 | 变更详情 |
|---|---|---|
| 新增接口 | DNS 管理 | 新增 CreateDNSRule 等接口，支持自定义 DNS 配置。 |
变更类型 | 接口名称 | 变更详情 |
|---|---|---|
| 新增参数 | 上传应用 UploadApp | 新增请求参数 AppMode，允许用户指定上传的应用是否可在相同账号的不同业务之间共享。 |
| 新增接口 | AddPropertyRuleListPropertyRuleRemovePropertyRule | 新增接口，支持预设机型参数列表，创建云手机实例时可匹配任意预设机型参数。 |
| 新增 SDK | 服务端 SDK | 发布 Java、Golang 两种语言的服务端 SDK。您可以通过服务端 SDK 调用云手机 OpenAPI，实现快速对接云手机服务。 |
变更类型 | 接口名称 | 变更详情 |
|---|---|---|
| 新增参数 | InstallAppInstallAppsAutoInstallAppCreatePodOneStep | 新增请求参数 IsPreinstall，用于标记某应用是否为系统预安装应用。请注意配合同期发布的公共镜像使用。 |
| 新增参数 | 实例重置 ResetPod | 新增请求参数 PreInstallAppPersistedType，用于控制实例重置时，是否保留系统预安装应用及数据。 |
| 参数边界变更 | InstallAppUninstallApp | 指定实例上限变更为 1000，即单次接口调用支持至多对 1000 台实例执行应用安装或卸载操作。具体参看 PodIdList 字段说明。 |
| 新增接口 | 设置代理服务 SetProxy | 支持设置代理服务。 |
变更类型 | 接口名称 | 变更详情 |
|---|---|---|
| 新增接口 | 查询镜像信息 ListImage | 支持查询指定公共镜像或自定义镜像相关信息。 |
| 新增接口 | ListImageResourceGetImagePreheating | 支持查询指定镜像的部署规模和使用情况。 |
变更类型 | 接口名称 | 变更详情 |
|---|---|---|
| 新增请求参数 | 异步执行命令 RunCommand | 新增请求参数 TimeoutSeconds，支持设置异步命令执行的超时时长。 |
| 新增请求参数 | CreatePodUpdatePodProperty | 支持自定义传感器参数设置。详情参看 System Properties 属性 新增字段 debug.sensor.xxx.name、debug.sensor.xxx.vendor，以及 Settings global 属性 新增字段 inject_sensor/switch、inject_sensor/xxx "a,b,c"。 |
变更类型 | 接口名称 | 变更详情 |
|---|---|---|
| 新增请求参数 | 查询应用信息列表 ListApp | 新增请求参数 AppType，支持根据应用类型返回符合应用列表。 |
| 新增请求参数 | 分发文件至实例 DistributeFile | 新增请求参数 AutoUnzip，支持将文件分发后自动解压。 |
| 接口行为变更 | 自动下载安装应用 AutoInstallApp | 新增请求参数 InstallType，支持使用镜像安装模式安装应用。 |
| 新增返回参数 | 获取实例应用列表 GetPodAppList | 新增返回参数 Activity、Size，支持获取应用启动首页 Activity 和应用包体。 |
| 新增请求参数 | 创建端口映射规则 CreatePortMappingRule | 新增 Isp、direction 参数支持指定运营商线路。 |
| 新增接口 | BindPortMappingRuleUnbindPortMappingRuleDetailPortMappingRuleListPortMappingRule | 新增接口，支持为云机实例绑定/解绑端口映射规则，以及查询端口映射规则绑定详情。 |
| 参数变更 | 自动下单订购实例 SubscribeResourceAuto | 支持订购 “8vCPU｜16G内存｜256G存储”规格云机资源，且该规格下新增 6 种实例规格供选择，详情参看 ServerTypeCode 和 ConfigurationCode 参数说明。 |
变更类型 | 接口名称 | 变更详情 |
|---|---|---|
| 新增请求参数 | CreatePodCreatePodOneStepUpdatePodProperty | 设置 Settings 属性 enableScriptAutoRun 配置脚本自启动功能时，新增 value 2，支持在设备重启时，每满足脚本触发条件，均自动执行脚本。 |
变更类型 | 接口名称 | 变更详情 |
|---|---|---|
| 新增接口 | 分发文件至实例 DistributeFile | 该接口用于将文件或应用快速分发至云手机实例指定目录下。支持跨区域、跨集群的多实例文件分发。 |
| 新增请求参数 | 实例重置 ResetPod | 新增 SystemDirPersistedType 参数，指定实例重置时对系统目录的处理。若将应用或文件存储至 /system、/vendor 或 /odm 系统目录，可以通过该参数设置是否保留系统目录下的应用和数据。注意，该参数需配合 2024 年 5 月 16 日及之后发布的公共镜像版本使用。 |
服务端 OpenAPI 全面升级至 2023-10-30 版本。原 2022-08-01 版本接口文档移入历史版本 2022-08-01，并停止维护。建议您尽快将接口版本升级至 2023-10-30版本，以免对您的业务造成影响。
此次升级主要包含以下变动：
product_id 变更为 ProductId。DestroyPod 销毁实例接口 Action 更名为 DeletePod 删除实例。STSToken 签发临时 Token 接口，请参考获取临时密钥（STS）文档获取临时 Token。变更类型 | 接口名称 | 变更详情 |
|---|---|---|
| 参数变更 | 查询实例列表 ListPod | 该接口在返回参数 PortMappingRule 中新增 PublicPortInfoList 字段，用于返回自定义端口映射信息。 |
| 新增回调事件类型 | 资源状态告警回调 pod_monitor | 新增实例资源状态信息回调，回调消息类型为 pod_monitor，在控制台“功能配置 - 回调配置”中开启资源状态告警回调后触发。 |