GetServiceTask - 查询服务任务-云监控(CMS)-阿里云帮助中心

接口说明

根据 taskId 查询单个服务任务详情。

返回内容随 type 变化：heapdump 返回堆转储任务信息；LiveDebug 返回任务记录及 taskConfig（extraInfo）等字段。

调试

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

调试

授权信息

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

请求语法

GET /serviceTask/{workspace}/{serviceId}/task/{taskId} HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
workspace	string	是	工作空间名称。例如 default-cms--。	default-cms-1672753017899339-cn-hangzhou
serviceId	string	是	应用/服务 ID（pid）。	ggxw4lnjuz@f2fd3a6265a254a052afb
taskId	string	否	任务 ID	a1b2c3d4-e5f6-7890-abcd-ef1234567890

请求参数

名称	类型	必填	描述	示例值
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。必须与创建时的 type 一致。	live_debug_log_probe

路径参数 workspace、serviceId、taskId；query 参数 type 必填。

返回参数

名称	类型	描述	示例值
	object	查询成功响应
requestId	string	请求 ID	A1B2C3D4-E5F6-7890-ABCD-EF1234567890
serviceTask	object	任务详情对象。常见字段包含 taskId、serviceId、workspace、regionId、ip、taskType、extraInfo（LiveDebug 时为 taskConfig JSON）、createTime、updateTime 等。	{"taskId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","serviceId":"ggxw4lnjuz@f2fd3a6265a254a052afb","taskType":"live_debug_log_probe","ip":"10.0.0.1","extraInfo":"{\"probeType\":\"LOG\",\"language\":\"java\"}"}

返回 requestId 与 serviceTask 对象。

示例

正常返回示例

JSON格式

{
  "requestId": "A1B2C3D4-E5F6-7890-ABCD-EF1234567890",
  "serviceTask": {
    "taskId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "serviceId": "ggxw4lnjuz@f2fd3a6265a254a052afb",
    "taskType": "live_debug_log_probe",
    "ip": "10.0.0.1",
    "extraInfo": "{\"probeType\":\"LOG\",\"language\":\"java\"}"
  }
}

错误码

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

变更历史

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