DescribeTasks - 查询任务

获取云手机实例当前任务列表。

接口说明

  • 可以通过 DescribeTasks 接口查询批量或者单台云手机实例的操作状态。
  • 目前支持开机、关机、重启、重置、备份/恢复、安装应用、远程命令等操作的任务查询。
  • Level 字段可区分任务等级。当 Level=1,任务属于批量任务;Level=2,任务属于实例级任务。

举例说明:

假设您对实例 ID 为 acp-25nt4kk9whhok****、实例 ID 为 acp-j2taq887orj8l**** 的两台云手机实例执行了重启操作,返回这次操作的 requestId 为 B8ED2BA9-0C6A-5643-818F-B5D60A64****。如果您希望知道这次批量操作的结果,可以调用 DescribeTasks 来查询,其中的 InvokeId 填写 B8ED2BA9-0C6A-5643-818F-B5D60A64****;如果您希望拿到实例 ID 为 acp-25nt4kk9whhok**** 的重启结果,入参 ParentTaskId=批量任务 ID,AndroidInstanceId=acp-25nt4kk9whhok****,可调用 DescribeTasks 即可。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InvokeIdstring

命令执行 ID,可以填写上一次操作返回的 requestId。

B8ED2BA9-0C6A-5643-818F-B5D60A64****
ResourceIdsarray

资源 ID 列表。

string

资源 ID,如果是查询云手机开机、关机、重启和重置的任务状态,资源 ID 填实例 ID 即可。

acp-25nt4kk9whhok****
TaskIdsarray

任务 ID 列表。

string

任务 ID。

t-bp67acfmxazb4p****
ParentTaskIdstring

父任务 ID。

t-iaej5dkbnmivx****
TaskTypestring

任务类型。

枚举值:
  • BackupFile数据备份
  • StopInstance实例关机
  • RebootInstance实例重启
  • StartApp启动应用
  • SendFile上传文件
  • RunCommand远程命令
  • RestartApp重启应用
  • ResetInstance实例重置
  • RecoverFile数据恢复
  • UninstallApp卸载应用
  • StopApp停止应用
  • Screenshot截屏
  • InstallApp安装应用
  • FetchFile下载文件
  • UpdateGroupImage更换镜像
  • StartInstance实例开机
StartInstance
TaskTypesarray

任务类型列表。

string

任务类型。

StartInstance
TaskStatusstring

任务状态。

枚举值:
  • PartFinished部分成功
  • Finished已完成
  • Failed任务失败
  • Skipped跳过
  • Processing运行中
  • Waiting等待
Processing
TaskStatusesarray

任务状态列表。

string

任务状态。

Finished
Levelinteger

任务级别,1 表示批量任务;2 表示实例级任务。

1
InstanceIdstring

实例 ID。

acp-2zecay9ponatdc4m****
InstanceNamestring

实例名称。

defaultInstanceName
Paramstring

扩展字段。

param
MaxResultsinteger

分页查询时每页的最大条目数。取值范围 1~100,默认值为 10。

10
NextTokenstring

用来表示当前开始读取的位置。置空表示从头开始。

FFbc8N4E1iOlcSxC+8boa0HHH2LKWbggYUinyrZWvtS1oTrMYCg1HuMLGuftj0****

返回参数

名称类型描述示例值
object

返回参数。

NextTokenstring

用来表示当前开始读取的位置。置空表示从头开始。

AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****
Dataarray<object>

返回结果对象列表。

dataobject

返回结果对象。

TaskIdstring

任务 ID。

t-bp67acfmxazb4p****
InvokeIdstring

命令执行 ID。

B8ED2BA9-0C6A-5643-818F-B5D60A64****
RegionIdstring

地域 ID。

cn-hangzhou
ResourceIdstring

资源 ID。

acp-25nt4kk9whhok****
TaskTypestring

任务类型。

StartInstance
TaskStatusstring

任务状态。

Processing
StartTimestring

任务开始时间。

2022-10-11T08:53:32Z
FinishTimestring

任务结束时间。

2022-10-11T08:53:32Z
Paramstring

任务参数。

param
Resultstring

任务执行结果。

{'Success': True}
ErrorCodestring

错误码。

SendFileFailed
ErrorMsgstring

错误信息。

connect error.
Levelinteger

任务级别。

1
FailedChildCountinteger

执行失败的子任务总数。

2
SuccessChildCountinteger

执行成功的子任务总数。

98
RunningChildCountinteger

运行中的子任务总数。

0
TotalChildCountinteger

当前批量任务的子任务总数。

100
InstanceIdstring

实例 ID。

acp-uto81vfd8t8z****
InstanceNamestring

实例名称

defaultInstanceName
InstanceStatusstring

实例状态。

RUNNING
Operatorstring

操作者。

test
ParentTaskIdstring

父任务 ID。

t-41oan3tza16vs****
TotalCountinteger

总条目数。

10
RequestIdstring

请求 ID。

B8ED2BA9-0C6A-5643-818F-B5D60A64****

示例

正常返回示例

JSON格式

{
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****",
  "Data": [
    {
      "TaskId": "t-bp67acfmxazb4p****",
      "InvokeId": "B8ED2BA9-0C6A-5643-818F-B5D60A64****",
      "RegionId": "cn-hangzhou",
      "ResourceId": "acp-25nt4kk9whhok****",
      "TaskType": "StartInstance",
      "TaskStatus": "Processing",
      "StartTime": "2022-10-11T08:53:32Z",
      "FinishTime": "2022-10-11T08:53:32Z",
      "Param": "param",
      "Result": "{'Success': True}",
      "ErrorCode": "SendFileFailed",
      "ErrorMsg": "connect error.",
      "Level": 1,
      "FailedChildCount": 2,
      "SuccessChildCount": 98,
      "RunningChildCount": 0,
      "TotalChildCount": 100,
      "InstanceId": "acp-uto81vfd8t8z****",
      "InstanceName": "defaultInstanceName",
      "InstanceStatus": "RUNNING",
      "Operator": "test",
      "ParentTaskId": "t-41oan3tza16vs****"
    }
  ],
  "TotalCount": 10,
  "RequestId": "B8ED2BA9-0C6A-5643-818F-B5D60A64****"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-11-14OpenAPI 返回结构发生变更查看变更详情
2024-08-21OpenAPI 返回结构发生变更查看变更详情