ListServiceTask - 查询服务任务列表

更新时间:
复制 MD 格式

列举ServiceTask

接口说明

按任务类型列举应用下的服务任务。

  • type=heapdump:返回堆转储任务列表

  • type=pprof:返回 pprof dump 列表(需配合 searchCondition)

  • type=live_debug_*:返回对应 LiveDebug 任务列表

支持 nextToken / maxResults 分页,以及 searchCondition 过滤。

调试

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

调试

授权信息

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

请求语法

GET /serviceTask/{workspace}/{serviceId}/tasks HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

workspace

string

是

工作空间名称。例如 default-cms--。

default-cms-1672753017899339-cn-hangzhou

serviceId

string

是

应用/服务 ID(pid)。

ggxw4lnjuz@f2fd3a6265a254a052afb

请求参数

名称

类型

必填

描述

示例值

type

string

否

任务类型。支持:heapdump(堆转储);LiveDebug Probe:live_debug_log_probe、live_debug_snapshot_probe、live_debug_metric_probe、live_debug_span_probe、live_debug_span_tag_probe;LiveDebug Command:live_debug_inspect_object、live_debug_search_type、live_debug_search_method、live_debug_decompile、live_debug_get_thread_info、live_debug_get_runtime_info、live_debug_get_memory_info、live_debug_evaluate_expression、live_debug_modify_logger_level;LiveDebug 代码热替换:live_debug_code_replace。列表接口额外支持 pprof。

live_debug_log_probe

nextToken

string

否

分页标记。取上一页响应中的 nextToken 原样传入,首次查询可不传。服务端返回的是加密后的十六进制字符串(内部格式为 {md5}#{dbId}),长度不超过 128。

d23d8f3f0f0cd1984566b1986c9343122fa0385a05c09694c17fe87709f3eb56d1a7ead56b4a2536

maxResults

integer

否

单页返回的最大条数,取值范围 0~100,默认 100。

20

searchCondition

string

否

搜索条件,JSON 字符串,长度不超过 1024。heapdump 可用于按 IP 等条件过滤;pprof 示例:{"ip":"10.0.0.1","start":1711843200000,"end":1711846800000,"profileType":1}。

{"ip":"10.0.0.1"}

路径参数 workspace、serviceId;query 参数 type 必填,其余可选。

返回参数

名称

类型

描述

示例值

object

列举成功响应

requestId

string

请求 ID

A1B2C3D4-E5F6-7890-ABCD-EF1234567890

nextToken

string

下一页标记。有下一页时返回加密后的十六进制字符串,为空或不返回表示没有更多数据。下一页请求时将该值原样作为 nextToken 传入。

d23d8f3f0f0cd1984566b1986c9343122fa0385a05c09694c17fe87709f3eb56d1a7ead56b4a2536

maxResults

integer

本次请求的 maxResults

20

totalCount

integer

符合条件的总条数

2

serviceTasks

array<object>

任务列表

[{"taskId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","taskType":"live_debug_log_probe"}]

object

单个任务对象,字段随 type 变化

返回分页列表 serviceTasks,以及 nextToken、maxResults、totalCount。

示例

正常返回示例

JSON格式

{
  "requestId": "A1B2C3D4-E5F6-7890-ABCD-EF1234567890",
  "nextToken": "d23d8f3f0f0cd1984566b1986c9343122fa0385a05c09694c17fe87709f3eb56d1a7ead56b4a2536",
  "maxResults": 20,
  "totalCount": 2,
  "serviceTasks": [
    {
      "test": "test",
      "test2": 1
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情。