首页 弹性云手机 API参考指南 API目录 任务 ListTasks - 获取云手机实例任务列表

ListTasks - 获取云手机实例任务列表

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

接口说明

  • 此接口只支持NextToken查询方式
  • 返回结果按照任务创建时间顺序正序返回
  • 通过NextToken设置查询凭证(Token),其取值是上一次调用ListTasks返回的NextToken参数值,再通过MaxResults设置单页查询的最大条目数。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用加粗字体表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cloudphone:ListTasksRead
  • ECP
    acs:cloudphone:{#regionId}:{#accountId}:instance/*

请求参数

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

查询地域

cn-hangzhou
TaskIdarray

任务ID列表。N的取值范围:1~100

t-bp67acfmxazb4p****
string
RegionIdstring

查询地域

cn-hangzhou
TaskStatusstring

任务状态。取值范围:

  • Finished:已完成
  • Processing:运行中
  • Failed:失败

默认值:无 说明 只支持查询状态为Finished、Processing和Failed的任务,填入其他取值将不会生效。

Finished
TaskTypestring

任务操作的接口名称。取值范围:

  • Shell:运行shell命令
  • InstallApplication:安装应用
  • UninstallApplication:卸载应用
  • SendFile:上传文件
  • ImportImage:导入镜像
Shell
InstanceIdstring

实例ID。

cp-acfmxazb4p***
NextTokenstring

查询凭证(Token),取值为上一次API调用返回的NextToken参数值,初次调用无需配置。

55C15B1C-D507-45F0-B490-69D6E0F113C6
MaxResultsinteger

返回的最大数。取值范围:1~100 默认值:50。

50

返回参数

名称类型描述示例值
object
NextTokenstring

返回下一页查询凭证(Token)。

ADBAAdDWBF2****
RequestIdstring

请求ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCountinteger

任务总数量。

1
MaxResultsinteger

返回的最大数。取值范围:1~200 默认值:50。

50
RegionIdstring

查询地域。

cn-hangzhou
Tasksarray

任务列表。

object
TaskTypestring

任务类型。

Shell
Progressstring

任务执行进度

100%
TaskStatusstring

任务状态。

Finished
ExecuteMsgstring

任务执行返回内容,最长1024字节

file1 file2
CreateTimestring

任务创建时间

2021-04-15 10:10:00
FinishedTimestring

结束时间

2021-04-15 10:10:01
InstanceIdstring

实例ID

cp-acfmxazb4p***
TaskIdstring

任务唯一标识

t-bp67acfmxazb4p****

示例

请求示例

http(s)://[Endpoint]/?Action=ListTasks
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

JSON格式

{
  "NextToken": "ADBAAdDWBF2****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "MaxResults": 50,
  "RegionId": "cn-hangzhou",
  "Tasks": [
    {
      "TaskType": "Shell",
      "Progress": "100%",
      "TaskStatus": "Finished",
      "ExecuteMsg": "file1 file2",
      "CreateTime": "2021-04-15 10:10:00",
      "FinishedTime": "2021-04-15 10:10:01",
      "InstanceId": "cp-acfmxazb4p***",
      "TaskId": "t-bp67acfmxazb4p****"
    }
  ]
}

错误码

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

阿里云首页 弹性云手机 相关技术圈