获取云手机实例当前任务列表。云手机很多(创建、开关机等)的操作都是异步进行,系统将产生一个任务ID供用户查询操作进度及结果。用户可通过调用该接口查询所有任务清单及执行情况。
接口说明
可以通过 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代码示例。

授权信息
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
InvokeId |
string |
否 |
命令执行 ID,可以填写上一次操作返回的 requestId。 |
B8ED2BA9-0C6A-5643-818F-B5D60A64**** |
ResourceIds |
array |
否 |
资源 ID 列表。 |
|
string |
否 |
资源 ID,如果是查询云手机开机、关机、重启和重置的任务状态,资源 ID 填实例 ID 即可。 |
acp-25nt4kk9whhok**** |
|
TaskIds |
array |
否 |
任务 ID 列表。 |
|
string |
否 |
任务 ID。 |
t-bp67acfmxazb4p**** |
|
ParentTaskId |
string |
否 |
父任务 ID。 |
t-iaej5dkbnmivx**** |
TaskType |
string |
否 |
任务类型。 |
StartInstance |
TaskTypes |
array |
否 |
任务类型列表。 |
|
string |
否 |
任务类型。 |
StartInstance |
|
TaskStatus |
string |
否 |
任务状态。 |
Processing |
TaskStatuses |
array |
否 |
任务状态列表。 |
|
string |
否 |
任务状态。 |
Finished |
|
Level |
integer |
否 |
任务级别,1 表示批量任务;2 表示实例级任务。 |
1 |
InstanceId |
string |
否 |
实例 ID。 |
acp-2zecay9ponatdc4m**** |
InstanceName |
string |
否 |
实例名称。 |
defaultInstanceName |
Param |
string |
否 |
扩展字段。 |
param |
MaxResults |
integer |
否 |
分页查询时每页的最大条目数。取值范围 1~100,默认值为 10。 |
10 |
NextToken |
string |
否 |
用来表示当前开始读取的位置。置空表示从头开始。 |
FFbc8N4E1iOlcSxC+8boa0HHH2LKWbggYUinyrZWvtS1oTrMYCg1HuMLGuftj0**** |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
返回参数。 |
||
NextToken |
string |
用来表示当前开始读取的位置。置空表示从头开始。 |
AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc**** |
Data |
array<object> |
返回结果对象列表。 |
|
object |
返回结果对象。 |
||
TaskId |
string |
任务 ID。 |
t-bp67acfmxazb4p**** |
InvokeId |
string |
命令执行 ID。 |
B8ED2BA9-0C6A-5643-818F-B5D60A64**** |
RegionId |
string |
地域 ID。 |
cn-hangzhou |
ResourceId |
string |
资源 ID。 |
acp-25nt4kk9whhok**** |
TaskType |
string |
任务类型。 |
StartInstance |
TaskStatus |
string |
任务状态。 |
Processing |
StartTime |
string |
任务开始时间。 |
2022-10-11T08:53:32Z |
FinishTime |
string |
任务结束时间。 |
2022-10-11T08:53:32Z |
Param |
string |
任务参数。 |
param |
Result |
string |
任务执行结果。 |
{'Success': True} |
ErrorCode |
string |
错误码。 |
SendFileFailed |
ErrorMsg |
string |
错误信息。 |
connect error. |
Level |
integer |
任务级别。 |
1 |
FailedChildCount |
integer |
执行失败的子任务总数。 |
2 |
SuccessChildCount |
integer |
执行成功的子任务总数。 |
98 |
RunningChildCount |
integer |
运行中的子任务总数。 |
0 |
TotalChildCount |
integer |
当前批量任务的子任务总数。 |
100 |
InstanceId |
string |
实例 ID。 |
acp-uto81vfd8t8z**** |
InstanceName |
string |
实例名称 |
defaultInstanceName |
InstanceStatus |
string |
实例状态。 |
RUNNING |
Operator |
string |
操作者。 |
test |
ParentTaskId |
string |
父任务 ID。 |
t-41oan3tza16vs**** |
TotalCount |
integer |
总条目数。 |
10 |
RequestId |
string |
请求 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****"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。