消息通知服务支持以下事件的回调： |功能 |event_type |事件描述 | |---|---|---| |实例状态相关 |[pod_start](https://www.volcengine.com/docs/6394/1386614#a1WJMpfk) |实例启动成功回调 | |^^|[pod_status](https://www.volcengine.com/docs/6394/1386614#QcgCK8Sx) |实例状态回调 | |^^|[pod_monitor](https://www.volcengine.com/docs/6394/1386614#BjTgb52m) |实例资源与网络监控数据回调 | |实例操控相关 |[screen_shot](https://www.volcengine.com/docs/6394/1386614#KaJZiAyo) |截图结果回调 | |^^|[recording](https://www.volcengine.com/docs/6394/1386614#4QLlA8rE) |录屏结果回调 | |任务相关 |[task](https://www.volcengine.com/docs/6394/1386614#p9VXdwgR) |任务执行回调 | |^^|[job](https://www.volcengine.com/docs/6394/1386614#aYUIYV4x) |子任务执行回调 | |应用相关 |[manage_app](https://www.volcengine.com/docs/6394/1386614#JXfFvo1m) |应用运行回调 | |^^|[app_monitor](https://www.volcengine.com/docs/6394/1386614#FX154Cgq) |应用崩溃回调 | |^^|[task/job](https://www.volcengine.com/docs/6394/1386614#qtpGoyPV) |手动卸载应用回调 | |机房相关 |[bandwidth_package_monitor](https://www.volcengine.com/docs/6394/1386614#nMJNnVrH) |带宽包限速告警回调 | |测试相关 |[verify](https://www.volcengine.com/docs/6394/1386614#pUIgz71i) |测试回调 | ## 实例状态相关 ### 实例启动成功回调 **event_type**：`pod_start` **事件详情**：云手机成功启动推流时的回调。 **event_data**： |参数名 |参数类型 |示例值 |参数说明 | |---|---|---|---| |pod_id |String |7431784499430xxxxxx |实例 ID。 | |user_id |String |001 |用户自定义客户端用户 ID | |app_id |String |7430764159425xxxxxx |启动的应用 ID。 | |width |String |1080 |实例推流视频流宽度。 | |height |String |2340 |实例推流视频流高度。 | |extra |Map |\- |用户自定义扩展参数内容。 | **回调内容示例**： ```JSON { "pod_id": "7431784499430xxxxxx", "user_id": "001", "app_id": "7430764159425xxxxxx", "width": "1080", "height": "2340", "extra": "" } ``` ### 实例状态回调 **event_type**：`pod_status` **事件详情**：实例状态发生改变时的回调。 **event_data**： |参数名 |参数类型 |示例值 |参数说明 | |---|---|---|---| |pod_id |String |7433722018757xxxxxx |实例 ID。 | |pod_status |Int32 |4355 |实例当前状态，参考[实例状态说明](https://www.volcengine.com/docs/6394/1386614#BvcjHUbq)。 | |pod_ip |String |10.17.4.4 |实例 IP。 | |pod_start_extra |Map |\- |调用客户端 [start](https://www.volcengine.com/docs/6394/75742#%E5%BC%80%E5%A7%8B%E6%92%AD%E6%94%BE) 接口传入的自定义扩展参数内容。 | **回调内容示例**： ```JSON { "pod_id": "7431784499430xxxxxx", "pod_status": 4355, "pod_ip": "10.17.4.4" } ``` #### 实例状态说明 |状态 |状态分类 |具体状态 |十六进制状态码 |十进制状态码 | |---|---|---|---|---| |实例状态 |开机 |开机中 |0x1101 |4353 | |^^|^^|运行中 |0x1103 |4355 | |^^|关机 |关机中 |0x1201 |4609 | |^^|^^|已关机 |0x1202 |4610 | |^^|重启 |重启中 |0x1301 |4865 | |推流状态 |推流 |推流中 |0x2001 |8193 | |^^|^^|推流就绪 |0x2003 |8195 | 不同实例推流状态与不同实例状态组合时，推流操作说明如下： | ||实例状态 ||||| |^^||运行中 |开机中 |关机中 |已关机 |重启中 | |---|---|---|---|---|---|---| |实例推流状态 |推流就绪|实例正常运行中，已具备推流条件，可随时发起推流。 |实例正在开机中，不具备推流条件，不可发起推流。 |实例正在关机中，不具备推流条件，不可发起推流。 |实例已经关机，具备推流条件，不可发起推流。 |实例正在重启中，不具备推流条件，不可发起推流。 |\ | |（未推流） | | | | | | |^^|推流中 |正在推流 |N/A |N/A |N/A |N/A | ### 实例资源与网络监控数据回调 **event_type**：`pod_monitor` **事件详情**：云手机实例的资源与网络监控指标（含部分指标阈值告警）回调事件，具体包括： * 资源运行时负载指标：CPU 使用量、单 Pod 最大可使用 CPU 核数、总内存、内存使用量、磁盘容量以及磁盘使用量等。 * 网络监控指标：上/下行公网带宽、上/下行累计公网流量等。 **回调频次**：配置后每间隔 2 分钟触发一次。若设置了内存用量、CPU 用量、磁盘用量或上下行带宽阈值，超出阈值时会触发回调，并回调 exceed_map 字段。 **重试机制**：回调失败（即非成功响应）时，系统将每间隔 1 秒重试 1 次，累计重试 3 次仍未成功将停止推送。 **event_data**： |参数名 |参数类型 |示例值 |参数说明 | |---|---|---|---| |pod_id |String |7426677458793xxxxxx |实例 ID。|\ | | | | | |dc_id |String |boe\-zjwz\-ctcucm\-02\-xxxxxx |机房集群 ID。 | |cpu_max |Double |2 |单个 Pod 最大可使用核数。 | |cpu_usage |Double |2.21 |CPU 使用量。 | |cpu_alloc |Double |2 |理论分配的 CPU 核数。以单个云机 8C12G 为例，单开 8 核，双开 4 核，以此类推。 | |mem_total |Int64 |3766484992 |总内存，单位 byte。 | |mem_usage |Int64 |566505472 |实际已使用内存，单位 byte。 | |mem_alloc |Int64 |3766484992 |理论分配的内存数，单位 byte。 | |disk_total |Int64 |18889785344 |磁盘总量，单位 byte。 | |disk_usage |Int64 |1113899008 |实际已使用磁盘容量，单位 byte。 | |up_bandwidth |Int64 |0 |Pod 上行带宽（出向），单位 byte/s。 | |down_bandwidth |Int64 |0 |Pod 下行带宽（入向），单位 byte/s。 | |time_stamp |Int64 |1729158678 |时间戳。 | |exceed_map |Map | |若设置了内存用量、CPU 用量、磁盘用量、上下行带宽阈值，超出阈值时回调该字段。 | |up_traffic_total |Int64 |77467641 |从开机到当前时刻的上行流量累计值，单位为字节（byte）。该值仅统计单次开机期间的流量，实例重启后该值将被清零，并重新开始累计。 | |down_traffic_total |Int64 |106002644 |从开机到当前时刻的下行流量累计值，单位为字节（byte）。该值仅统计单次开机期间的流量，实例重启后该值将被清零，并重新开始累计。 | |proxy_status |Integer |0 |是否开启代理服务。与 [setProxy](https://www.volcengine.com/docs/6394/2189020) 接口的 `ProxyStatus` 值保持对应。|\ | | | ||\ | | | |* 1：开启代理服务|\ | | | |* 0：关闭代理服务 | |proxy_config |JSON Map |{"key":"value"} |代理配置键值对。与 [setProxy](https://www.volcengine.com/docs/6394/2189020) 接口的 `ProxyConfig` 值保持对应。 | |proxy_active_statue |String |off |代理服务的状态。|\ | | | ||\ | | | |* on：已开启代理服务|\ | | | |* off：已关闭代理服务|\ | | | |* netError：已开启代理服务，但无法连通代理服务器（网络异常） | **回调内容示例**： ```JSON { "pod_id": "7426677458793xxxxxx", "dc_id": "boe-zjwz-ctcucm-02-xxxxxx", "cpu_usage": 2.21, "cpu_alloc": 2, "cpu_max": 2, "mem_total": 3766484992, "mem_alloc": 3766484992, "mem_usage": 566505472, "disk_total": 18889785344, "disk_usage": 1113899008, "up_bandwidth": 0, "down_bandwidth": 0, "time_stamp": 1729158678, "up_traffic_total": 77467641, "down_traffic_total": 106002644, "proxy_status": 0, "proxy_config": {"key":"value"}, "proxy_active_status": "off"， "exceed_map":{ "cpu_usage":0.4, "mem_usage":0.30, "disk_usage":0.30, "up_bandwidth": 20, "down_bandwidth": 20 } } ``` ## 实例操控相关 ### 截图结果回调 **event_type**：`screen_shot` **事件详情**：通过服务端截图（[ScreenShot](https://www.volcengine.com/docs/6394/1262354)）、批量截图（[BatchScreenShot](https://www.volcengine.com/docs/6394/1262214)）、实例开始截图（[StartScreenShot](https://www.volcengine.com/docs/6394/1753267)）或实例停止截图（[StopScreenShot](https://www.volcengine.com/docs/6394/1753268)）接口发起云手机画面截图请求后，截图成功的结果回调。 **event_data**： |参数名 |参数类型 |示例值 |参数说明 | |---|---|---|---| |pod_id |String |7433781681230xxxxxx |实例 ID。 | |round_id |String |1696347522856xxxxxx_1730979xxxxxx |调用服务端接口发起截图请求时指定的请求唯一标识。 | |save_path |String |/sdcard/Pictures/openApi_screenshot_1696347522856xxxxxx_1730979xxxxxx.jpg |在云手机实例中保存截图文件的路径，例如：`/sdcard/Pictures/openApi_screenshot_[时间戳].jpg`。 | |download_url |String |https://example\-bucket.tos\-example.com/photos/picture.jpg?X\-Amz\-Algorithm=AWS4\-HMAC\-SHA256&X\-Amz\-Credential=AKIDEXAMPLE%2F20230101%2Fus\-east\-1%2Ftos%2Faws4_request&X\-Amz\-Date=20230101T120000Z&X\-Amz\-Expires=3600&X\-Amz\-SignedHeaders=host&X\-Amz\-Signature=abcdef1234567890 |截图成功时返回截图文件的下载链接，链接有效期 2.5 小时。|\ | | | |:::warning|\ | | | |**StartScreenShot** 和 **StopScreenShot** 通过接口同步返回截图文件下载链接，因此回调结果中的 `download_url` 参数为空字符串。|\ | | | ||\ | | | |:::| |err_code |Int32 |0 |错误码，对应的说明信息为：|\ | | | ||\ | | | |* `0`：截图成功，上传截图文件到对象存储成功，返回截图文件保存路径；|\ | | | |* `-1`：存储空间不足，截图失败；|\ | | | |* `-2`：未知原因，截图失败；|\ | | | |* `-3`：截图失败，可能原因为实例离线或当前页面受安全保护不允许截图，可尝试修改 AOSP 的 `persist.sys.allow_capture_secure` 属性值为 `true` 后重试；|\ | | | |* `-4`：实例不存在或不属于对应业务。 | |msg |String |截图成功 |说明信息。|\ | | | ||\ | | | |* err_code 取值 `0`、msg 取值 `onCaptureStart` 时，表示调用 **StartScreenShot** 接口产生的回调。|\ | | | |* err_code 取值 `100`、msg 取值 `onCaptureFinish:true` 时，表示主动调用 **StopScreenShot** 接口产生的回调。|\ | | | |* err_code 取值 `100`、msg 取值 `onCaptureStart` 时，表示录屏时长参数（`DurationLimit`）到期之后产生的回调。 | |rotation |Int32 |0 |截图画面旋转处理结果：|\ | | | ||\ | | | |* `0`：截图方向不做处理；|\ | | | |* `1`：截图画面旋转为竖屏：|\ | | | | * 手机竖屏的截图，不做处理；|\ | | | | * 手机横屏的截图，截图顺时针旋转 90 度。 | |screen_shot_type |int32 |1 |截图回调类型：|\ | | | ||\ | | | |* 0：表示 **ScreenShot** 或 **BatchScreenShot** 接口触发的回调。|\ | | | |* 1：表示 **StartScreenShot** 或 **StopScreenShot** 接口触发的回调。 | |width |int32 |1080 |截图画面宽度。 | |height |int32 |1920 |截图画面高度。 | **回调内容示例**： ```JSON { "pod_id": "7433781681230xxxxxx", "round_id": "1696347522856xxxxxx_1730979xxxxxx", "save_path": "/sdcard/Pictures/openApi_screenshot_1696347522856xxxxxx_1730979xxxxxx.jpg", "download_url": "https://example-bucket.tos-example.com/photos/picture.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIDEXAMPLE%2F20230101%2Fus-east-1%2Ftos%2Faws4_request&X-Amz-Date=20230101T120000Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=abcdef1234567890", "err_code": 0, "msg": "截图成功", "rotation": 0, "screen_shot_type": 1, "width": 1080, "height": 1920 } ``` ### 录屏结果回调 **event_type**：`recording` **事件详情**：通过服务端录屏（[StartRecording](https://www.volcengine.com/docs/6394/658995)）接口发起云手机画面录屏请求后，录屏成功的结果回调。 **event_data**： |参数名 |参数类型 |示例值 |参数说明 | |---|---|---|---| |pod_id |String |7382889532800xxxxxx |实例 ID。 | |round_id |String |13 |调用服务端接口发起录屏请求时指定的请求唯一标识。 | |save_path |String |/sdcard/Pictures/Recordings/record_20240101_1729134xxxxxx.mp4 |在云手机实例中保存录屏文件的路径，例如：`/sdcard/Pictures/Recordings/recording_yymmdd_[秒级时间戳].mp4`。 | |download_url |String |https://example\-bucket.tos\-example.com/videos/recording.jpg?X\-Amz\-Algorithm=AWS4\-HMAC\-SHA256&X\-Amz\-Credential=AKIDEXAMPLE%2F20230101%2Fus\-east\-1%2Ftos%2Faws4_request&X\-Amz\-Date=20240101T120000Z&X\-Amz\-Expires=3600&X\-Amz\-SignedHeaders=host&X\-Amz\-Signature=abcdef1234567890 |录屏文件的下载链接。 | |err_code |Int32 |0 |错误码，对应的状态和说明如下：|\ | | | ||\ | | | |* `0`：录制成功，正常结束，上传录屏文件到对象存储成功，返回录像文件保存路径；|\ | | | |* `1`：录制成功，正常结束；|\ | | | |* `2`：开始录制成功；|\ | | | |* `3`：开始录制失败，正在录制中时调用了开始录制；|\ | | | |* `4`：结束录制失败，没有录制中的任务；|\ | | | |* `5`：录制失败，云手机存储空间不足，已占用存储空间总量的 80%；|\ | | | |* `6`：录制结束，达到录制时限，返回录像文件保存路径；|\ | | | |* `7`：开始录制失败，录制时长超过上限。 | |msg |String |录制成功 |说明信息。 | **回调内容示例**： ```json { "pod_id": "7433781681230xxxxxx", "round_id": "13", "save_path": "/sdcard/Pictures/Recordings/record_20240101_1729134xxxxxx.mp4", "download_url": "https://example-bucket.tos-example.com/videos/recording.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIDEXAMPLE%2F20230101%2Fus-east-1%2Ftos%2Faws4_request&X-Amz-Date=20240101T120000Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=abcdef1234567890", "err_code": 0, "msg": "录制成功" } ``` ## 任务相关 ### 任务执行回调 **event_type**：`task` **事件详情**：对一个或多个实例执行任务的结果回调。 **event_data**： |参数名 |参数类型 |示例值 |参数说明 | |---|---|---|---| |task_id |String |7438366328992xxxxxx |任务 ID，由异步任务创建时返回。 | |task_action |String |ResetPod |任务类型。|\ | | | ||\ | | | |* `CreatePod`：创建实例并部署应用；|\ | | | |* `UploadApp`：上传应用；|\ | | | |* `PushFile`：推送文件；|\ | | | |* `PullFile`：下载文件；|\ | | | |* `DistributeFile`：文件分发；|\ | | | |* `InstallApp`：安装应用/应用自动下载安装；|\ | | | |* `UninstallApp`：应用卸载；|\ | | | | :::warning|\ | | | | 仅调用服务端 OpenAPI 卸载应用时会触发该回调。如果您希望在云手机内手动卸载应用时触发回调，需要订阅[手动卸载应用回调](https://www.volcengine.com/docs/6394/1386614#qtpGoyPV)。|\ | | | | :::|\ | | | |* `ResetPod`：实例重置；|\ | | | |* `BackupPod`：实例备份；|\ | | | |* `RestorePod`：实例还原；|\ | | | |* `RebootHost`：重启云机；|\ | | | |* `ResetHost`：重置云机；|\ | | | |* `RunCommand`：执行命令；|\ | | | |* `PodDataTransfer`：实例数据复制迁移；|\ | | | |* `SetProxy`：设置代理；|\ | | | |* `BackupData`：备份数据；|\ | | | |* `RestoreData`：恢复数据。 | |task_result |Int32 |\-1 |任务执行进度。|\ | | | ||\ | | | |* `0`：未开始；|\ | | | |* `10`：执行中；|\ | | | |* `100`：执行完成；|\ | | | |* `-1`：执行失败；|\ | | | |* `-2`：部分执行失败。 | |task_detail |String |\- |任务详情。 | |err_code |Int32 |0 |错误码。 | |msg |String |\- |错误信息。 | |extra |Object |[extra 数据结构](https://www.volcengine.com/docs/6394/1386614#dprJhZfg) |补充说明信息，任务执行操作的详细结果。|\ | | | |:::tip|\ | | | |目前仅 PodDataTransfer、ResetPod、PushFile、PullFile、RebootHost 任务类型会返回该参数值。|\ | | | ||\ | | | |:::| **回调内容示例**： ```json { "task_id": "7438366328992xxxxxx", "task_action": "ResetPod", "task_result": -1, "task_detail": "", "err_code": 0, "msg": "", "extra":{ "total":1, "succeed":0, "failed":1, "in_progress": 0, "details":{ "7431784499430xxxxxx":-4 } } } ``` #### extra 数据结构 |参数名 |参数类型 |示例值 |参数说明 | |---|---|---|---| |total |Int |1 |任务执行的实例总数。 | |succeed |Int |0 |任务执行成功的实例数量。 | |failed |Int |1 |任务执行失败的实例数量。 | |in_progress |Int |0 |任务执行中的实例数量。 | |details |Object | |实例 ID 及其任务执行状态码，各任务类型包含的专属状态码及含义参考下文[任务状态码说明](https://www.volcengine.com/docs/6394/1386614#GfAiJKJJ)。 | ### 子任务执行回调 **event_type**：`job` **事件详情**：对多个实例进行批量任务执行的结果回调。 **event_data**： |参数名 |参数类型 |示例值 |参数说明 | |---|---|---|---| |task_id |String |7439326384935xxxxxx |任务 ID，由异步任务创建时返回。 | |task_action |String |InstallApp |任务类型。|\ | | | ||\ | | | |* `ResetPod`：重置实例；|\ | | | |* `BackupPod`：实例备份；|\ | | | |* `RestorePod`：实例还原；|\ | | | |* `PodDataDelete`：实例数据删除|\ | | | |* `PodDataTransfer`：实例数据复制迁移；|\ | | | |* `InstallApp`：安装应用/应用自动下载安装；|\ | | | |* `UninstallApp`：卸载应用；|\ | | | | :::warning|\ | | | | 仅调用服务端 OpenAPI 卸载应用时会触发该回调。如果您希望在云手机内手动卸载应用时触发回调，需要订阅[手动卸载应用回调](https://www.volcengine.com/docs/6394/1386614#qtpGoyPV)。|\ | | | | :::|\ | | | |* `LaunchApp`：启动应用；|\ | | | |* `CloseApp`：关闭应用；|\ | | | |* `SetProxy`：设置代理；|\ | | | |* `BackupData`：备份数据；|\ | | | |* `RestoreData`：恢复数据。 | |job_id |String |job\-7439326384935xxxxxx\-7439291511545xxxxxx |子任务 ID。 | |pod_id |String |7439291511545xxxxxx |子任务对应的实例 ID。 | |job_result |Int32 |100 |任务执行结果。通用执行结果如下：|\ | | | ||\ | | | |* `0`：未开始；|\ | | | |* `10`：执行中；|\ | | | |* `100`：执行成功；|\ | | | |* `-1`：执行失败。|\ | | | ||\ | | | |各任务类型专属执行结果状态码参考下文[任务状态码说明](https://www.volcengine.com/docs/6394/1386614#GfAiJKJJ)。 | |err_code |Int32 |0 |错误码。|\ | | | |各任务类型专属错误码参考下文[任务错误码说明](https://www.volcengine.com/docs/6394/1386614#iH6SxbUk)。 | |msg |String |\- |子任务执行结果，包含成功和错误的信息。 | |extra |Object |extra 数据格式 |补充说明信息，包含任务执行操作的详细信息。 | |timestamp_ms |Int64 |1732104448273 |应用安装（`InstallApp`）、应用卸载（`UninstallApp`）任务时间戳，单位为毫秒。 | **回调内容示例**： ```JSON { "task_id": "7439326384935xxxxxx", "task_action": "InstallApp", "job_id": "job-7439326384935xxxxxx-7439291511545xxxxxx", "pod_id": "7439291511545xxxxxx", "job_result": 100, "err_code": 0, "msg": "", "extra":{ "app_id":"7298992190708xxxxxx", "version_id":0, "package_name":"com.tencent.android.qqdownloader", "status": 528 }, "timestamp_ms":1732104448273 } ``` ## 应用相关 ### 应用运行回调 **event_type**：`manage_app` **事件详情**：通过服务端启动应用（[LaunchApp](https://www.volcengine.com/docs/6394/1262211)）或关闭应用（[CloseApp](https://www.volcengine.com/docs/6394/1262212)）接口发起启动或关闭应用请求后，应用运行结果的回调。 **event_data**： |参数名 |参数类型 |示例值 |参数说明 | |---|---|---|---| |product_id |String |1696347522856xxxxxx |业务 ID。 | |pod_id |String |7393271371394xxxxxx |实例 ID。 | |manage_type |String |LaunchApp |应用运行操作类型：|\ | | | ||\ | | | |* `LaunchApp`：启动应用；|\ | | | |* `CloseApp`：关闭应用。 | |package_name |String |com.baidu.searchbox |应用的包名。 | |success |Boolean |true |应用运行操作是否成功：|\ | | | ||\ | | | |* `true`：成功；|\ | | | |* `false`：失败。 | |err_msg |String |\- |错误信息。 | **回调内容示例**： ```json { "product_id": "1696347522856xxxxxx", "pod_id": "7393271371394xxxxxx", "manage_type": "LaunchApp", "package_name": "com.baidu.searchbox", "success": true } ``` ### 应用崩溃回调 **event_type**：`app_monitor` **事件详情**：应用程序发生异常并终止运行时触发的回调。 **event_data**： |参数名 |参数类型 |示例值 |参数说明 | |---|---|---|---| |pod_id |String |7423671098241xxxxxx |实例 ID。 | |start_time |Int64 |1730721265393 |崩溃开始时间。 | |end_time |Int64 |1730721385462 |崩溃结束时间。 | |list |Array of list |[list 数据结构](https://www.volcengine.com/docs/6394/1386614#ZDn1NtqX) |应用崩溃列表，参考 [list 数据结构](https://www.volcengine.com/docs/6394/1386614#ZDn1NtqX)。 | **回调内容示例**： ```json { "pod_id": "1696347522856xxxxxx", "start_time": "7393271371394xxxxxx", "end_time": "LaunchApp", "list":{ "package_name":"com.ss.android.ugc.aweme", "process_name":"com.ss.android.ugc.aweme", "total_anr":0, "total_crash":0, "total_lmk":1 } } ``` #### list 数据结构 |参数名 |参数类型 |示例值 |参数说明 | |---|---|---|---| |package_name |String |com.ss.android.ugc.aweme |应用包名。 | |process_name |String |com.ss.android.ugc.aweme |应用操作名称。 | |total_anr |Int32 |0 |应用程序无响应次数。 | |total_crash |Int32 |0 |应用程序崩溃次数。 | |total_lmk |Int32 |1 |低内存查杀次数。 | |msg |String |\- |其他信息。 | ### 手动卸载应用回调 :::warning * 仅在云手机内手动卸载应用时触发的回调，且必须在云手机控制台相应业务的**功能配置**中，添加**手动卸载应用回调**。具体操作参考 [开通服务](/docs/6394/138583#%E5%BC%80%E9%80%9A%E6%9C%8D%E5%8A%A1)。 * 如果您希望在调用服务端 OpenAPI 卸载应用时会触发回调，请添加 [任务相关](https://www.volcengine.com/docs/6394/1386614#rj64o4Yo) 回调。 ::: 该回调包含在 [任务相关](https://www.volcengine.com/docs/6394/1386614#rj64o4Yo) 回调内，因此触发时将会接收到两个回调： * 任务执行回调，**event_type** 为`task`，对应的 **task_action** 为 `UninstallApp`，且回调详情不在 **extra** 参数展示。 * 子任务执行回调，**event_type** 为`job`，对应的 **task_action** 为 `UninstallApp`，回调详情在 **extra** 参数展示。 **事件详情**：云手机实例内的应用被手动卸载时触发的回调。 **event_data**：任务相关回调的 **event_data** 参数说明请参考 [子任务执行回调](https://www.volcengine.com/docs/6394/1386614#aYUIYV4x)，其中 **extra** 参数将包含**手动卸载应用回调**的数据，参数说明如下表。 |参数名 |参数类型 |示例值 |参数说明 | |---|---|---|---| |app_id |String |fakeAppId |应用 ID。 | |version_id |Int |0 |应用版本 ID。 | |package_name |String |com.autonavi.minimap |应用包名。 | |status |Int |1281 |应用状态，取值 `1281` 表示应用已卸载。|\ | | | |应用完整状态码说明：|\ | | | ||\ | | | |* 513(0x201) =\> 正在安装|\ | | | |* 516(0x204) =\> 正在下载|\ | | | |* 528(0x210) =\> 安装完成|\ | | | |* 1024(0x400) =\> 安装失败|\ | | | |* 1280(0x500) =\> 卸载中|\ | | | |* 1281(0x501) =\> 已卸载 | **回调内容示例**： ```JSON { "task_id": "743932638493xxxx", "task_action": "UninstallApp", "job_id": "job-7439326384935xxxx-7439291511545xxxx", "pod_id": "7561736803775xxxx", "job_result": 100, "err_code": 0, "msg": "Uninstall successfully.", "extra": { "app_id": "xxxxAppId", "version_id": 0, "package_name": "com.xxxx.minimap", "status": 1281 } } ``` ## 机房相关 ### 带宽包限速告警回调 :::tip 此处带宽包不同于业务带宽，如需了解及添加带宽包，请联系云手机技术支持。 ::: **event_type**：`bandwidth_package_monitor` **事件详情**：当机房带宽到达预设的上行或下行阈值时触发的回调。 **event_data**： |参数名 |参数类型 |示例值 |参数说明 | |---|---|---|---| |product_id |String |1805858488711xxxx |业务 ID。 | |bandwidth_package_id |String |76616489186858907xxxx |带宽包 ID。 | |dc |String |tjtj\-ctcucm\-xxxx |机房 ID。 | |bandwidth |Integer |200 |带宽包大小。 | |bandwidth_package_usage_up |Double |0.4991992 |带宽包上行带宽（出向），单位 Mbps。 | |bandwidth_package_usage_down |Double |20.74508 |带宽包下行带宽（入向），单位 Mbps。 | |bandwidth_package_usage_up_rate |Double |0.2495995999999999998 |带宽包上行带宽使用率（百分比）。 | |bandwidth_package_usage_down_rate |Double |10.37254 |带宽包下行带宽使用率（百分比）。 | |time_stamp |Int64 |1758012480 |Unix 秒时间戳。 | **回调内容示例**： ```JSON { "product_id": "1805858488711xxxxxx", "bandwidth_package_id": "bwp-76616489186858907xx", "dc": "tjtj-ctcucm-xxx", "bandwidth": 200, "bandwidth_package_usage_up": 0.4991992, "bandwidth_package_usage_down": 20.74508, "bandwidth_package_usage_up_rate": 0.2495995999999999998, "bandwidth_package_usage_down_rate": 10.37254, "time_stamp": 1758012480, } ``` ## 测试相关 ### 测试回调 **event_type**：`verify` **事件详情**：云手机控制台回调功能配置验证回调。 **event_data**： |参数名 |参数类型 |示例值 |参数说明 | |---|---|---|---| |err_code |Int32 |0 |错误码。 | |msg |String |\- |错误信息说明。 | **回调内容示例**： ```JSON { "err_code": 0, "msg": "Valid callback test. productId:1844638665263812608" } ``` ## 附录 ### 任务状态码说明 #### 任务类型：PushFile/PullFile/DistributeFile |**状态码** |**说明** | |---|---| |100 |任务执行成功。 | |10 |任务执行中。 | |0 |任务未开始。 | |\-1 |任务执行失败。 | |\-2 |实例 ID 不存在。 | |\-3 |目标路径非法或不存在。 | |\-4 |火山引擎对象存储信息不正确。 | |\-5 |火山引擎对象存连接断开。 | |\-6 |文件压缩出错。 | |\-7 |文件解压出错。 | |\-8 |当前有正在执行的任务。 | |\-9 |其他错误。 | #### 任务类型：ResetPod |**状态码** |**说明** | |---|---| |100 |任务执行成功。 | |40 |已更新属性。 | |30 |实例数据已删除。 | |20 |实例已经关机。 | |10 |任务执行中。 | |0 |任务未开始。 | |\-1 |任务执行失败。 | |\-2 |部分执行失败。 | |\-4 |实例不存在。 | |\-5 |实例与指定业务不匹配。 | |\-6 |实例状态不允许执行当前操作（实例正处在创建中、删除中、或数据迁移中等）。 | #### 任务类型：PodDataTransfer |**状态码** |**说明** | |---|---| |100 |任务执行成功。 | |50 |数据迁移完成。 | |45 |数据正在迁移。 | |40 |已获取到限流配额。 | |35 |数据已经复制。 | |30 |旧数据已经删除。 | |20 |实例已经关机。 | |15 |子任务预检条件通过。 | |10 |子任务开始。 | |0 |任务未开始。 | |\-1 |任务执行失败。 | |\-2 |实例关机失败。 | |\-3 |实例开机失败。 | |\-4 |实例不存在。 | |\-5 |实例与指定业务不匹配。 | |\-6 |实例状态不允许执行当前操作（实例正处在创建中、删除中、或重置中等）。 | |\-7 |目标实例的存储容量不符合要求。 | |\-8 |实例数据迁移时，目标实例与源实例不在同一机房。 | |\-9 |实例数据迁移时，目标实例与源实例不在同一区域。 | |\-10 |实例数据迁移时，目标实例与源实例安卓系统版本不一致。 | |\-11 |实例数据迁移时，目标实例与源实例数据类型不一致。内部错误，请联系技术支持。 | #### 任务类型：PodDataDelete |**状态码** |**说明** | |---|---| |101 |部分执行成功。发生以下两种情况时返回该状态码：|\ | ||\ | |* 存在非法路径/包名，合法路径/包名文件已删除；|\ | |* 部分文件无操作权限。 | |100 |任务执行成功。 | |10 |任务执行中。 | |0 |任务未开始。 | |\-1 |任务执行失败。 | |\-2 |实例不存在。 | |\-3 |包名/文件路径列表为空。 | |\-4 |包名/文件路径不允许删除。 | #### 任务类型：ResetPod |**状态码** |**说明** | |---|---| |100 |任务执行成功。 | |40 |已更新属性。 | |30 |数据已删除。 | |20 |实例已关机。 | |10 |执行中 | |0 |任务未开始。 | |\-1 |通用失败，需根据接口返回参数 JobMessage 确认失败原因。 | |\-2 |实例关机失败。 | |\-3 |实例开机失败。 | |\-4 |实例不存在。 | |\-5 |实例与指定业务不匹配。 | |\-6 |实例状态不允许执行当前操作（实例正处在创建中、删除中、或数据迁移中等）。 | #### 任务类型：BackupPod |**状态码** |**说明** | |---|---| |100 |任务执行成功。 | |99 |取消实例备份。 | |50 |实例备份完成。 | |45 |正在备份中。 | |10 |已获取到配额。 | |5 |备份排队中。 | |0 |任务未开始。 | |\-1 |通用失败。 | |\-2 |当前机房不可用。 | |\-3 |当前机房不支持备份还原功能。 | #### 任务类型：RestorePod |**状态码** |**说明** | |---|---| |100 |任务执行成功。 | |99 |取消实例还原。 | |50 |实例还原完成。 | |45 |正在还原中。 | |10 |已获取到配额。 | |5 |还原排队中。 | |0 |任务未开始。 | |\-1 |通用失败。 | |\-2 |当前机房不可用。 | |\-3 |当前机房不支持备份还原功能。 | |\-5 |还原时目标云机不存在。 | |\-6 |还原时实例与云机规格不匹配。 | |\-7 |还原时没有可用云机。 | |\-8 |还原时目标云机已无空闲算力。 | |\-9 |指定还原的云机状态未就绪。 | #### 任务类型：BackupData |**状态码** |**说明** | |---|---| |100 |任务执行完成，最终状态。 | |53 |任务因执行超时而终止。 | |52 |任务因执行失败而终止。 | |50 |任务执行完成，后续状态码将更新为 100。 | |45 |任务正在执行。 | |40 |任务已准备好。 | |30 |对实例进行关机操作。 | |20 |任务准备中。 | |15 |任务获取到配额，该状态码仅 Ceph 存储方案使用。 | |10 |任务预检通过。 | |5 |任务初始化。 | |0 |任务未开始。 | |\-1 |通用失败。 | |\-2 |任务执行失败，包含重试操作。 | |\-3 |任务执行超时。 | |\-4 |机房当前不可用。 | |\-5 |机房不支持数据备份恢复功能。 | |\-6 |安卓系统版本不一致。 | #### 任务类型：RestoreData |**状态码** |**说明** | |---|---| |100 |任务执行完成，最终状态。 | |53 |任务因执行超时而终止。 | |52 |任务因执行失败而终止。 | |50 |任务执行完成，后续状态码将更新为 100。 | |45 |任务正在执行。 | |40 |任务已准备好。 | |30 |对实例进行关机操作。 | |20 |任务准备中。 | |15 |任务获取到配额，该状态码仅 Ceph 存储方案使用。 | |10 |任务预检通过。 | |5 |任务初始化。 | |0 |任务未开始。 | |\-1 |通用失败。 | |\-2 |任务执行失败，包含重试操作。 | |\-3 |任务执行超时。 | |\-4 |机房当前不可用。 | |\-5 |机房不支持数据备份恢复功能。 | |\-6 |安卓系统版本不一致。 | ### 任务错误码说明 #### 任务类型：InstallApp/UninstallApp |错误码 |**说明** | |---|---| |0 |应用安装或卸载成功。 | |\-1 |应用安装包下载失败。 | |\-2 |应用安装失败，对应的子错误码说明如下：|\ | ||\ | |* 1：通用错误；|\ | |* 2：应用安装操作被设备限制或应用安装需要系统权限；|\ | |* 3：用户主动取消应用安装；|\ | |* 4：应用安装文件存在各种问题；|\ | |* 5：应用安装包下载 URL 错误；|\ | |* 6：云手机实例存储不足；|\ | |* 7：应用与设备不匹配。 | |\-3 |sdcard 未挂载。 | |\-4 |校验失败。 | |\-5 |应用 apk 文件不存在（指定 path 安装）。 | |\-6 |应用包名异常。 | |\-7 |apk 不允许安装。 | |\-8 |应用卸载失败。 |