Method: tasks.list

列出与指定过滤条件匹配的任务。

HTTP 请求

GET https://ces.googleapis.com/tasks

网址采用 gRPC 转码语法。

查询参数

参数
tenant

string

可选。不透明的路由标识符。如果设置了该字段，则必须与代理卡片中所选 AgentInterface 的 tenant 值一致。
contextId

string

按上下文 ID 过滤任务，以获取特定对话或会话中的任务。
status

enum (TaskState)

按任务的当前状态过滤任务。
pageToken

string

从之前的 tasks.list 调用接收的页面令牌。ListTasksResponse.next_page_token。利用其进行后续页面检索。
statusTimestampAfter

string (Timestamp format)

过滤状态更新时间晚于指定时间戳（采用 ISO 8601 格式，例如“2023-10-27T10:00:00Z”）的任务。系统将仅返回状态时间戳时间大于或等于此值的任务。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
pageSize

integer

要返回的任务数量上限。服务返回的值可能小于此值。如果未指定，则最多返回 50 个任务。最小值为 1。最大值为 100。
historyLength

integer

每个任务的历史记录中包含的消息数量上限。
includeArtifacts

boolean

是否在返回的任务中包含制品。默认值为 false，以减小载荷大小。

请求正文

请求正文必须为空。

响应正文

tasks.list 方法的结果对象，包含任务数组和分页信息。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "tasks": [
    {
      object (Task)
    }
  ],
  "nextPageToken": string,
  "pageSize": integer,
  "totalSize": integer
}
字段
tasks[]

object (Task)

必需。与指定条件匹配的任务数组。
nextPageToken

string

必需。用于检索下一页结果的令牌。如果列表中没有更多结果，则为空。
pageSize

integer

必需。相应回答所用的页面大小。
totalSize

integer

必需。可用的任务总数（分页前）。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

如需了解详情，请参阅 Authentication Overview。