View a markdown version of this page

ListJobs - Amazon Location Service

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

ListJobs

ListJobs操作检索具有可选筛选功能的分页作业列表。您可以按任务状态进行筛选并控制返回的结果数量。该操作支持通过 next token 进行分页,从而使您可以高效地检索大型任务列表。

有关更多信息,请参阅ListJobs亚马逊定位服务 API 参考》。

有关此 API 的请求、响应和 CLI 命令示例,请参阅如何列出任务

使用案例

  • 任务清单管理:检索所有任务以审计处理历史记录并跟踪整个验证操作的资源利用率。

  • 基于状态的监控:按状态筛选作业,以识别需要关注的正在运行的作业或已完成的准备检索结果的作业。

  • 运营报告:为业务分析生成有关任务执行模式、成功率和处理量的报告。

  • 故障排除和调试:列出失败的作业以识别处理错误的模式并诊断系统性问题。

了解请求

ListJobs请求接受用于筛选和分页的可选参数。在没有任何参数的情况下,该操作将返回所有采用默认分页的作业。

该请求包含以下可选参数:

筛选选项

用于缩小返回任务列表范围的可选参数。

  • Filter:包含筛选条件的对象。

    • JobStatus:按任务的当前状态筛选作业。有效值:PendingRunningCompletedFailedCancelling、或Cancelled

分页控件

用于控制结果分页的可选参数。

  • MaxResults:在单个响应中返回的最大任务数。使用它来控制大型结果集的页面大小。

  • NextToken: 来自先前ListJobs响应的分页标记。添加此令牌可检索下一页的结果。

了解响应

ListJobs响应提供分页的作业摘要列表,其中包含每个作业的配置和状态信息。当有更多结果可用时,使用下一个标记来检索其他页面。

响应包括以下字段:

Job 清单

符合筛选条件的职位摘要数组。

  • Entries: 一系列工作摘要,包括:

    • Action:任务执行的操作。

    • CreatedAt: ISO 8601 格式的 Job 创建时间戳。

    • EndedAt: 采用 ISO 8601 格式的 Job 完成时间戳。仅适用于处于终端状态(已完成、失败或已取消)的作业。

    • ExecutionRoleArn: 用于执行的 IAM 角色。

    • InputOptions: 输入配置对象。

    • JobArn:任务的亚马逊资源名称 (ARN)。

    • JobId:唯一的作业标识符。

    • Name: Job 名称(如果在创建过程中提供)。

    • OutputOptions: 输出配置对象。

    • Status:当前的工作状态。

    • UpdatedAt: 上次更新时间戳采用 ISO 8601 格式。

    • ActionOptions:要求的其他功能(如果有)。

分页标记

用于检索其他结果的令牌。

  • NextToken: 要包含在下一个ListJobs请求中以检索下一页结果的令牌。只有在有更多结果可用时,才会显示此字段。缺少此字段表示您已检索到最后一页。

注意

结果在各页之间保持一致的顺序。在后续请求NextToken中使用每个响应中的来遍历结果的所有页面。