public class ACEPTrait extends BaseServiceImpl
| Modifier and Type | Class and Description |
|---|---|
static class |
ACEPTrait.ResponseModel |
apiInfoList, credentials, ISigner, serviceInfo| Modifier | Constructor and Description |
|---|---|
protected |
ACEPTrait() |
protected |
ACEPTrait(ServiceInfo serviceInfo) |
destroy, getAccessKey, getApiInfoList, getHttpClient, getISigner, getRegion, getSecretKey, getServiceInfo, getSessionToken, getSignUrl, json, makeRequest, post, postDataWithResponse, postFileMultiPart, prepareRequest, proto, put, putData, putData, putDataWithResponse, putDataWithResponse, query, setAccessKey, setClientNoReuse, setConnectionTimeout, setHost, setHttpClient, setRegion, setScheme, setSecretKey, setServiceInfo, setSessionToken, setSocketTimeout, signSts2protected ACEPTrait()
protected ACEPTrait(ServiceInfo serviceInfo)
public PullFileRes pullFile(PullFileBody body) throws Exception
pullFile
下载文件或文件夹到对象存储
从指定云手机实例下载文件或文件夹到对象存储(异步任务)。
body - body payloadException - error during requestpublic UpdatePodPropertyRes updatePodProperty(UpdatePodPropertyBody body) throws Exception
updatePodProperty
修改实例属性
修改指定实例的属性信息,包括系统属性(SystemProperties)和设置(Settings)。
body - body payloadException - error during requestpublic CloseAppRes closeApp(CloseAppBody body) throws Exception
closeApp
关闭应用
在一个或多个云实例中关闭指定应用(异步任务)。
关闭应用的结果通过任务执行回调返回,详请参考 [回调服务接入指南](https://www.volcengine.com/docs/6394/138583)。
body - body payloadException - error during requestpublic CreatePodRes createPod(CreatePodBody body) throws Exception
createPod
创建实例
创建指定套餐规格配置的实例,支持单个实例创建及批量实例创建:
- 如不指定 `PodSpecList` 参数,则创建单个实例。
- 如指定 `PodSpecList` 参数,则批量创建多个实例,且 `PodSpecList` 中指定的实例配置参数优先级高于外部参数。
body - body payloadException - error during requestpublic CreatePodOneStepRes createPodOneStep(CreatePodOneStepBody body) throws Exception
createPodOneStep
创建实例并部署应用
一键快速创建实例、启动实例,并完成应用部署(异步任务)。实例创建结果通过任务执行回调返回,详细信息,参考 [云手机回调服务接入指南](https://www.volcengine.com/docs/6394/138583)。
body - body payloadException - error during requestpublic AddPropertyRuleRes addPropertyRule(AddPropertyRuleBody body) throws Exception
addPropertyRule
创建机型参数规则
创建机型参数库,创建云手机时可从机型库里匹配一组预设参数。
body - body payloadException - error during requestpublic DeletePodRes deletePod(DeletePodBody body) throws Exception
deletePod
删除实例
删除实例。删除后,实例上的所有用户数据将直接被清除,并且无法还原,请谨慎操作。
body - body payloadException - error during requestpublic RunSyncCommandRes runSyncCommand(RunSyncCommandBody body) throws Exception
runSyncCommand
同步执行命令
在一个或多个云手机实例中同步执行命令,执行结果同步返回。
该接口适用于执行时间小于 10s 的命令,超过 10s 的命令建议使用异步执行命令 [`RunCommand`](https://www.volcengine.com/docs/6394/1262358) 接口。
body - body payloadException - error during requestpublic LaunchAppRes launchApp(LaunchAppBody body) throws Exception
launchApp
启动应用
在一个或多个云实例中启动指定应用(异步任务)。
body - body payloadException - error during requestpublic LaunchAppsRes launchApps(LaunchAppsBody body) throws Exception
launchApps
启动应用
此接口用于启动应用,可在一个实例中实现批量启动多个 App。
body - body payloadException - error during requestpublic PowerOffPodRes powerOffPod(PowerOffPodBody body) throws Exception
powerOffPod
实例停机
对指定实例执行关机操作,释放 CPU 算力。返回结果包含对每个实例的关机操作执行结果。
body - body payloadException - error during requestpublic PodStopRes podStop(PodStopBody body) throws Exception
podStop
实例停止推流
停止指定实例推流,释放实例资源。
body - body payloadException - error during requestpublic PowerOnPodRes powerOnPod(PowerOnPodBody body) throws Exception
powerOnPod
实例开机
对指定实例执行开机操作,占用 CPU 算力。
body - body payloadException - error during requestpublic CopyPodRes copyPod(CopyPodBody body) throws Exception
copyPod
实例拷贝
拷贝指定实例的信息,得到若干个实例;同时支持同机房实例拷贝。仅适用于云盘存储资源类型。
body - body payloadException - error during requestpublic PodDataTransferRes podDataTransfer(PodDataTransferBody body) throws Exception
podDataTransfer
实例迁移
将指定实例的数据迁移到已经存在的其他实例上(异步任务)。仅适用于云盘存储资源类型。
body - body payloadException - error during requestpublic RebootPodRes rebootPod(RebootPodBody body) throws Exception
rebootPod
实例重启
对指定实例执行重启操作,用以解决系统无响应、卡死等问题。
body - body payloadException - error during requestpublic ResetPodRes resetPod(ResetPodBody body) throws Exception
resetPod
实例重置
此接口用于对指定实例执行重置操作,清理应用和文件(异步任务)。
body - body payloadException - error during requestpublic BanUserRes banUser(BanUserBody body) throws Exception
banUser
封禁用户
封禁或断开指定客户端用户连接云手机实例。
body - body payloadException - error during requestpublic PushFileRes pushFile(PushFileBody body) throws Exception
pushFile
将TOS文件上传至Pod
从对象存储或下载链接推送文件到一个或多个云手机实例(异步任务)。
body - body payloadException - error during requestpublic DistributeFileRes distributeFile(DistributeFileBody body) throws Exception
distributeFile
将文件分发至Pod
该接口用于将文件或应用快速分发至云手机实例指定目录下。支持跨区域、跨集群的多实例文件分发。
你可以通过 [`GetTaskInfo`](https://www.volcengine.com/docs/6394/1262190) 接口查询分发任务执行结果详细信息。
body - body payloadException - error during requestpublic StartRecordingRes startRecording(StartRecordingBody body) throws Exception
startRecording
开始录屏
对当前云手机画面发起录屏请求(异步任务)。录屏请求结果通过回调返回,详请参考 [回调服务接入指南](https://www.volcengine.com/docs/6394/138583)。
body - body payloadException - error during requestpublic ScreenShotRes screenShot(ScreenShotBody body) throws Exception
screenShot
截图
对云手机实例的画面发起批量截图请求(异步任务)。截图请求结果通过回调返回,详细信息,参考 [回调服务接入指南](https://www.volcengine.com/docs/6394/138583)。
body - body payloadException - error during requestpublic PodAdbRes podAdb(PodAdbBody body) throws Exception
podAdb
打开/关闭实例adb
打开/关闭指定实例的 ADB 连接功能。
body - body payloadException - error during requestpublic RunCommandRes runCommand(RunCommandBody body) throws Exception
runCommand
执行命令
在一个或多个云手机实例中执行命令(异步任务)。命令执行的结果通过回调返回,详细信息,参考 [回调服务接入指南](https://www.volcengine.com/docs/6394/138583)。
该接口适用于执行时间大于 10s 的命令,小于 10s 的命令建议使用同步执行命令 [`RunSyncCommand`](https://www.volcengine.com/docs/6394/1262359) 接口。
body - body payloadException - error during requestpublic BatchScreenShotRes batchScreenShot(BatchScreenShotBody body) throws Exception
batchScreenShot
批量截图
对多个云手机实例的画面发起批量截图请求(异步任务)。截图请求结果通过回调返回,详请参考 [回调服务接入指南](https://www.volcengine.com/docs/6394/138583)。
body - body payloadException - error during requestpublic PodMuteRes podMute(PodMuteBody body) throws Exception
podMute
暂停/恢复推流
暂停或恢复指定实例推流。
body - body payloadException - error during requestpublic UpdatePodRes updatePod(UpdatePodBody body) throws Exception
updatePod
更新实例
此接口用于更新指定实例的属性信息,包括:
- 更改实例名称
- 实例镜像升级,暂不支持从高版本镜像更配为低版本镜像。
- 更改实例的套餐配置,需要在关机状态下更配,实例重启后生效。
- 更改实例的屏幕布局,需要在关机状态下更配,实例重启后生效。
- 套餐规格更配支持 12G 变更到 16G 算力,16G 变更到 12G 算力。
body - body payloadException - error during requestpublic ListDcRes listDc(ListDcQuery query) throws Exception
listDc
机房列表
此接口用于查询当前业务已订购的机房列表信息。仅适用于本地存储资源类型。
query - query argumentsException - error during requestpublic GetPodMetricRes getPodMetric(GetPodMetricQuery query) throws Exception
getPodMetric
查询实例云机资源状态
此接口用于查询指定实例的资源状态。例如,指定实例所属业务 ID 和实例 ID,获取实例资源状态。
query - query argumentsException - error during requestpublic DetailPodRes detailPod(DetailPodQuery query) throws Exception
detailPod
查询实例信息
此接口用于查询指定实例的详细信息。
query - query argumentsException - error during requestpublic ListPodRes listPod(ListPodQuery query) throws Exception
listPod
查询实例列表
此接口用于查询指定业务的实例列表信息。
query - query argumentsException - error during requestpublic GetPodPropertyRes getPodProperty(GetPodPropertyQuery query) throws Exception
getPodProperty
查询实例属性列表
查询指定实例的属性信息,包括系统属性信息(SystemProperties)和设置信息(Settings)。
query - query argumentsException - error during requestpublic ListPropertyRuleRes listPropertyRule(ListPropertyRuleQuery query) throws Exception
listPropertyRule
查询机型参数规则列表
查询已创建的机型参数规则列表。
query - query argumentsException - error during requestpublic PodDataDeleteRes podDataDelete(PodDataDeleteBody body) throws Exception
podDataDelete
清除用户数据
删除指定实例中的用户数据(异步任务)。
body - body payloadException - error during requestpublic RemovePropertyRuleRes removePropertyRule(RemovePropertyRuleBody body) throws Exception
removePropertyRule
移除机型参数规则
移除机型参数规则,立即生效。
body - body payloadException - error during requestpublic StopRecordingRes stopRecording(StopRecordingBody body) throws Exception
stopRecording
结束录屏
主动停止对当前云手机画面进行录屏。
body - body payloadException - error during requestpublic GetPodAppListRes getPodAppList(GetPodAppListQuery query) throws Exception
getPodAppList
获取实例应用列表
此接口用于查询指定实例上应用安装情况。
query - query argumentsException - error during requestpublic SetProxyRes setProxy(SetProxyBody body) throws Exception
setProxy
设置代理服务
为指定实例设置代理服务,并配置代理规则。
body - body payloadException - error during requestpublic ListTaskRes listTask(ListTaskQuery query) throws Exception
listTask
查询任务列表信息
查询实例、应用等相关任务的列表信息。
query - query argumentsException - error during requestpublic GetTaskInfoRes getTaskInfo(GetTaskInfoQuery query) throws Exception
getTaskInfo
查询任务详情
查询指定任务的执行结果详细信息。
query - query argumentsException - error during requestpublic CreatePortMappingRuleRes createPortMappingRule(CreatePortMappingRuleBody body) throws Exception
createPortMappingRule
创建端口映射规则
此接口用于在指定云手机业务下创建端口映射规则。
body - body payloadException - error during requestpublic ListPortMappingRuleRes listPortMappingRule(ListPortMappingRuleQuery query) throws Exception
listPortMappingRule
查询端口映射列表
查询业务下已创建的端口映射规则列表信息。
query - query argumentsException - error during requestpublic DetailPortMappingRuleRes detailPortMappingRule(DetailPortMappingRuleQuery query) throws Exception
detailPortMappingRule
查询端口映射详情
查询指定端口映射规则的详细信息。
query - query argumentsException - error during requestpublic BindPortMappingRuleRes bindPortMappingRule(BindPortMappingRuleBody body) throws Exception
bindPortMappingRule
绑定端口映射
此接口用于实例绑定端口映射规则。您可通过 `ProductId` 、`PodIdList`、`PortMappingRuleIdList` 参数,绑定端口映射规则。
body - body payloadException - error during requestpublic UnbindPortMappingRuleRes unbindPortMappingRule(UnbindPortMappingRuleBody body) throws Exception
unbindPortMappingRule
解绑端口映射
此接口用于实例解绑端口映射规则,您可通过 `ProductId` 、`PodIdList`、`PortMappingRuleIdList` 参数,解绑端口映射规则。
body - body payloadException - error during requestpublic AttachTagRes attachTag(AttachTagBody body) throws Exception
attachTag
实例打标签
为指定实例添加分组标签(将指定标签批量关联绑定实例)。
body - body payloadException - error during requestpublic ListTagRes listTag(ListTagQuery query) throws Exception
listTag
标签列表
此接口用于查询业务下创建的标签列表信息。
query - query argumentsException - error during requestpublic CreateTagRes createTag(CreateTagBody body) throws Exception
createTag
标签创建
在业务下创建标签(定义标签名称、标签描述等信息)。
body - body payloadException - error during requestpublic DeleteTagRes deleteTag(DeleteTagBody body) throws Exception
deleteTag
标签删除
删除已创建的标签。
body - body payloadException - error during requestpublic UpdateTagRes updateTag(UpdateTagBody body) throws Exception
updateTag
标签更改
更新指定标签的属性信息。
body - body payloadException - error during requestpublic UploadAppRes uploadApp(UploadAppBody body) throws Exception
uploadApp
应用上传
上传应用安装文件到应用管理中心(异步任务)。
body - body payloadException - error during requestpublic DetailAppRes detailApp(DetailAppQuery query) throws Exception
detailApp
应用信息查询
此接口用于查询指定应用的详情及应用版本信息。
query - query argumentsException - error during requestpublic UpdateAppRes updateApp(UpdateAppBody body) throws Exception
updateApp
应用修改
修改已发布的应用属性信息。
body - body payloadException - error during requestpublic ListAppRes listApp(ListAppQuery query) throws Exception
listApp
应用列表查询
此接口用于查询业务下的应用列表信息。
query - query argumentsException - error during requestpublic DeleteAppRes deleteApp(DeleteAppBody body) throws Exception
deleteApp
应用删除
删除账号下的指定应用及应用信息。
body - body payloadException - error during requestpublic UninstallAppRes uninstallApp(UninstallAppBody body) throws Exception
uninstallApp
应用卸载
将指定应用从云实例中卸载(异步任务)。
应用卸载结果通过任务执行回调返回,详请参考 [回调服务接入指南](https://www.volcengine.com/docs/6394/138583)。
body - body payloadException - error during requestpublic InstallAppRes installApp(InstallAppBody body) throws Exception
installApp
应用安装
此接口将指定应用安装部署到指定的云实例中(异步任务)。
body - body payloadException - error during requestpublic InstallAppsRes installApps(InstallAppsBody body) throws Exception
installApps
应用批量安装
此接口用于将多个应用批量安装部署到指定云机实例中(异步任务)。
body - body payloadException - error during requestpublic ListAppVersionDeployRes listAppVersionDeploy(ListAppVersionDeployQuery query) throws Exception
listAppVersionDeploy
应用版本部署信息
此接口用于查询应用在实例上的部署情况。
query - query argumentsException - error during requestpublic AutoInstallAppRes autoInstallApp(AutoInstallAppBody body) throws Exception
autoInstallApp
应用自动下载安装
通过下载应用安装文件方式,或应用镜像安装的方式,将应用自动安装部署到指定云手机实例。(异步任务)。
body - body payloadException - error during requestpublic GetAppCrashLogRes getAppCrashLog(GetAppCrashLogQuery query) throws Exception
getAppCrashLog
查询应用崩溃
查询一个或多个云实例中应用的崩溃信息,包括应用名称和崩溃时间点。
query - query argumentsException - error during requestpublic CreateDisplayLayoutMiniRes createDisplayLayoutMini(CreateDisplayLayoutMiniBody body) throws Exception
createDisplayLayoutMini
创建基础版屏幕布局
创建基础版屏幕布局,适用于单屏云手机实例。
body - body payloadException - error during requestpublic DeleteDisplayLayoutRes deleteDisplayLayout(DeleteDisplayLayoutBody body) throws Exception
deleteDisplayLayout
删除屏幕布局
删除指定屏幕布局配置信息(系统屏幕布局配置不可删除)。
body - body payloadException - error during requestpublic ListDisplayLayoutMiniRes listDisplayLayoutMini(ListDisplayLayoutMiniQuery query) throws Exception
listDisplayLayoutMini
查询基础版屏幕布局列表
此接口用于查询当前业务支持的基础版屏幕布局配置列表。
query - query argumentsException - error during requestpublic DetailDisplayLayoutMiniRes detailDisplayLayoutMini(DetailDisplayLayoutMiniQuery query) throws Exception
detailDisplayLayoutMini
查询基础版屏幕布局详情
查询指定基础版屏幕布局配置的详细信息。
query - query argumentsException - error during requestpublic CreateAppImageRes createAppImage(CreateAppImageBody body) throws Exception
createAppImage
创建应用镜像
该接口发起异步任务,基于用户指定云手机实例中已经安装的应用程序包,自动打包并生成一个可部署的应用镜像。
此操作允许用户将特定实例的应用程序环境,转换为可在云手机平台上重复使用的标准化镜像。用户可以轻松复制和部署到具有相同应用环境的多个实例中,从而提高应用部署的一致性和效率。
body - body payloadException - error during requestpublic DetailAppVersionImageRes detailAppVersionImage(DetailAppVersionImageQuery query) throws Exception
detailAppVersionImage
查询应用镜像信息
获取指定应用镜像的详细信息
query - query argumentsException - error during requestpublic CreateImageOneStepRes createImageOneStep(CreateImageOneStepBody body) throws Exception
createImageOneStep
镜像内置应用
基于已有镜像,快速构建内置应用和文件的自定义镜像(异步任务)。
body - body payloadException - error during requestpublic ListImageResourceRes listImageResource(ListImageResourceQuery query) throws Exception
listImageResource
镜像分布列表
查询当前业务下使用的所有镜像 ID,以及每个镜像所关联的实例数量。
查询结果为调用接口前最后一次数据库刷新的数据,而非实时数据。如果在最后一次数据库刷新之后至本次接口调用期间有新镜像被实例化,这些新增实例将不会被包含在返回的结果中。
query - query argumentsException - error during requestpublic ListImageRes listImage(ListImageQuery query) throws Exception
listImage
镜像列表
查询指定公共镜像或自定义镜像相关信息。
query - query argumentsException - error during requestpublic GetImagePreheatingRes getImagePreheating(GetImagePreheatingQuery query) throws Exception
getImagePreheating
镜像预热信息
查询指定镜像的预热进度。
query - query argumentsException - error during requestpublic ListConfigurationRes listConfiguration(ListConfigurationQuery query) throws Exception
listConfiguration
套餐列表-后端使用
查询业务下已订购的资源套餐列表。
query - query argumentsException - error during requestpublic ListPodResourceSetRes listPodResourceSet(ListPodResourceSetQuery query) throws Exception
listPodResourceSet
实例资源组列表
此接口用于查询当前业务已订购的实例资源组列表信息。
query - query argumentsException - error during requestpublic ListPodResourceRes listPodResource(ListPodResourceQuery query) throws Exception
listPodResource
资源列表
查询当前业务已订购的实例资源信息。
query - query argumentsException - error during requestpublic ListResourceQuotaRes listResourceQuota(ListResourceQuotaQuery query) throws Exception
listResourceQuota
资源配额
查询业务维度实例资源配额信息。
query - query argumentsException - error during requestpublic UpdatePodResourceApplyNumRes updatePodResourceApplyNum(UpdatePodResourceApplyNumBody body) throws Exception
updatePodResourceApplyNum
修改实例订单并发数量
在后付费计费模式下,修改已订购的实例数量。
body - body payloadException - error during requestpublic SubscribeResourceAutoRes subscribeResourceAuto(SubscribeResourceAutoBody body) throws Exception
subscribeResourceAuto
实例订购预付费-自动下单
此接口用于自动下单订购并发实例。
适用于云盘存储的预付费订购,本地存储的预付费、后付费订购。
body - body payloadException - error during requestpublic RenewResourceAutoRes renewResourceAuto(RenewResourceAutoBody body) throws Exception
renewResourceAuto
并发实例自动下单续订
此接口用于自动下单续订并发实例。
body - body payloadException - error during requestpublic UpdateProductResourceRes updateProductResource(UpdateProductResourceBody body) throws Exception
updateProductResource
更新业务存储资源
修改指定业务的存储资源订购总量。
body - body payloadException - error during requestpublic GetProductResourceRes getProductResource(GetProductResourceQuery query) throws Exception
getProductResource
查询业务存储资源
查询指定业务的存储资源信息。
query - query argumentsException - error during requestpublic UnsubscribeHostResourceRes unsubscribeHostResource(UnsubscribeHostResourceBody body) throws Exception
unsubscribeHostResource
退订后付费云机资源
此接口用于后付费云机资源退订。通过 `ProductId`、`HostIdList`、`Force` 参数完成退订操作。
body - body payloadException - error during requestpublic UpdateHostRes updateHost(UpdateHostBody body) throws Exception
updateHost
更新云机
此接口用于更新指定云机信息,支持更新云机套餐。仅适用于本地存储资源类型。
body - body payloadException - error during requestpublic ListHostRes listHost(ListHostQuery query) throws Exception
listHost
查询云机列表
此接口用于查询云机列表,仅适用于本地存储资源类型。
query - query argumentsException - error during requestpublic DetailHostRes detailHost(DetailHostQuery query) throws Exception
detailHost
查询云机详情
此接口用于查询云机详情,您可通过 `ProductId` 或者 `HostId` 参数获取云机详情,仅适用于本地存储业务类型。
query - query argumentsException - error during requestpublic RebootHostRes rebootHost(RebootHostBody body) throws Exception
rebootHost
重启云机
此接口用于重启指定云机。仅适用于本地存储资源类型。
body - body payloadException - error during requestpublic ResetHostRes resetHost(ResetHostBody body) throws Exception
resetHost
重置云机
此接口用于重置指定云机。仅适用于本地存储资源类型。
body - body payloadException - error during requestpublic CreateDNSRuleRes createDNSRule(CreateDNSRuleBody body) throws Exception
createDNSRule
创建DNS规则
为同一机房(Dc)内的云手机实例创建自定义 DNS 解析规则。您可以通过定制 DNS 解析行为,将指定域名定向到特定的 IP 地址。
该接口适用于需要优化网络性能、增强数据可控性的场景,如加速内部网络中的文件下载,或对网络流量进行精确控制和分发。
使用本接口可将云手机的 DNS 请求指向自己的服务器进行处理,为特定域名的解析结果进行定制,或为云手机实例设置默认 DNS 服务器,从而满足特定的业务需求。
body - body payloadException - error during requestpublic DeleteDNSRuleRes deleteDNSRule(DeleteDNSRuleBody body) throws Exception
deleteDNSRule
删除DNS规则
删除创建的自定义 DNS 解析规则。
删除某规则后,所有与之关联的云手机实例将会在下一次开机时自动恢复使用默认 DNS 设置;若无默认 DNS,则恢复使用集群公共 DNS。
body - body payloadException - error during requestpublic UpdateDNSRuleRes updateDNSRule(UpdateDNSRuleBody body) throws Exception
updateDNSRule
更新DNS规则
更新或修改已创建的 DNS 解析规则。若使用该接口修改的 DNS 规则已关联某实例,则修改后的配置将在关联实例重启后生效。
body - body payloadException - error during requestpublic DetailDNSRuleRes detailDNSRule(DetailDNSRuleBody body) throws Exception
detailDNSRule
查看DNS规则详情
查询某个已创建的自定义 DNS 解析规则详情。
body - body payloadException - error during requestpublic ListDNSRuleRes listDNSRule(ListDNSRuleBody body) throws Exception
listDNSRule
查询DNS规则列表
查询业务下已创建的自定义 DNS 解析规则详情列表。
body - body payloadException - error during requestCopyright © 2025. All rights reserved.