获取受管代理任务

使用 `agent.read` 权限读取作用域内的 `Agent` 任务进度。重试可用性还需要 `agent.config.write` 权限。成功撤销访问后，可能返回可信软件包的本地卸载命令；不执行远程卸载。

GET/api/v1/lifecycle/managed-agent/tasks/{id}

操作 ID

GetManagedAgentTask

起始版本

1.3.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

路径参数

id
String必填
资源ID。

响应状态

200 OK

该 API 成功时返回以下响应结构。

taskId
String
任务ID。
示例： value
type
String
类型。
示例： enable_capability
state
String
当前状态。
示例： value
agentId
String
代理ID。
示例： value
invitationId
String
资源。
示例： value
bindingId
String
资源。
示例： value
requestId
String
资源。
示例： value
createdBy
String
创建该记录的用户UUID。
示例： value
availableActions
List
资源。
示例： item1,item2
waitingReason
String
资源。
示例： value
plannedImpact
Object
已规划影响。
- platformAccessRevoked
  Boolean
  资源。
  示例： true
- localBacklogMayNotUpload
  Boolean
  该资源的本地积压数据可能无法上传。
  示例： true
- localAgentUninstalled
  Boolean
  资源。
  示例： true
- metricsContinuity
  String
  `buffered`、`unprotected` 或 `unknown`；重启时报告 `unknown`。撤销访问时为空。
  示例： value
- resumeCollection
  Boolean
  资源。
  示例： true
- drainMode
  String
  仅用于禁用：`wait` 或 `discard`。
  示例： value
- drainWaitSeconds
  Integer
  `wait` 时固定为 1800；`discard` 时不提供。
  示例： 10
- cancelledEnableTaskId
  String
  资源。
  示例： value
- queueFacts
  Object
  资源。
  queueSize
  Long
  资源。
  示例： 0
  queueCapacity
  Long
  资源。
  示例： 0
  enqueueFailedMetricPoints
  Long
  资源。
  示例： 0
  sendFailedMetricPoints
  Long
  资源。
  示例： 0
  sentMetricPoints
  Long
  资源。
  示例： 0
  serviceInstanceId
  String
  资源。
  示例： value
  observedAt
  String
  已观察时间。
  示例： 2026-01-15T08:00:00Z
- collectorRestart
  Boolean
  收集器重启。
  示例： true
- agentRestart
  Boolean
  代理重启。
  示例： true
- previousAgentVersion
  String
  资源。
  示例： value
- targetAgentVersion
  String
  资源。
  示例： value
- previousAgentRelease
  String
  该资源此前的 `Agent` 发布版本。
  示例： 10
- targetAgentRelease
  String
  该资源的目标 `Agent` 发布版本。
  示例： 10
actualImpact
Object
资源。
- platformAccessRevoked
  Boolean
  资源。
  示例： true
- localBacklogMayNotUpload
  Boolean
  该资源的本地积压数据可能无法上传。
  示例： true
- localAgentUninstalled
  Boolean
  资源。
  示例： true
- metricsContinuity
  String
  `buffered`、`unprotected` 或 `unknown`；重启时报告 `unknown`。撤销访问时为空。
  示例： value
- resumeCollection
  Boolean
  资源。
  示例： true
- drainMode
  String
  仅用于禁用：`wait` 或 `discard`。
  示例： value
- drainWaitSeconds
  Integer
  `wait` 时固定为 1800；`discard` 时不提供。
  示例： 10
- cancelledEnableTaskId
  String
  资源。
  示例： value
- queueFacts
  Object
  资源。
  queueSize
  Long
  资源。
  示例： 0
  queueCapacity
  Long
  资源。
  示例： 0
  enqueueFailedMetricPoints
  Long
  资源。
  示例： 0
  sendFailedMetricPoints
  Long
  资源。
  示例： 0
  sentMetricPoints
  Long
  资源。
  示例： 0
  serviceInstanceId
  String
  资源。
  示例： value
  observedAt
  String
  已观察时间。
  示例： 2026-01-15T08:00:00Z
- collectorRestart
  Boolean
  收集器重启。
  示例： true
- agentRestart
  Boolean
  代理重启。
  示例： true
- previousAgentVersion
  String
  资源。
  示例： value
- targetAgentVersion
  String
  资源。
  示例： value
- previousAgentRelease
  String
  该资源此前的 `Agent` 发布版本。
  示例： 10
- targetAgentRelease
  String
  该资源的目标 `Agent` 发布版本。
  示例： 10
errorCode
String
LDAP错误分类编码。
示例： value
errorReason
String
资源。
示例： value
errorMessage
String
错误返回消息。
示例： value
errorDetails
Object
资源。
- deployment_phase
  String
  资源。
  示例： value
- invitation_consumed
  Boolean
  资源。
  示例： true
- registered_agent_id
  Object
  已注册代理ID。
- recovery_action
  String
  资源。
  示例： value
traceId
String
链路追踪ID。
示例： value
createdAt
String
创建时间。
示例： 2026-01-15T08:00:00Z
startedAt
String
开始时间。
示例： 2026-01-15T08:00:00Z
completedAt
String
完成时间。
示例： 2026-01-15T08:00:00Z
resultMessage
String
结果消息。
示例： value
localUninstallCommand
String
资源。
示例： value
cancelReason
String
资源。
示例： value
cancelledByTaskId
String
资源。
示例： value
hostMetricContinuitySummary
Object
仅在 `host_metrics` 能力任务中提供；不表示 `Agent` 健康状态。
- lastHostMetricAt
  String
  最近一次主机指标时间。
  示例： 2026-01-15T08:00:00Z
- collectionState
  String
  采集状态。
  示例： value
- deliveryState
  String
  投递状态。
  示例： value
- queueSize
  Long
  队列大小。
  示例： 0
- queueCapacity
  Long
  资源。
  示例： 0
- enqueueFailedMetricPoints
  Long
  资源。
  示例： 0
- sendFailedMetricPoints
  Long
  资源。
  示例： 0
- sentMetricPoints
  Long
  资源。
  示例： 0
- serviceInstanceId
  String
  资源。
  示例： value
- observedAt
  String
  已观察时间。
  示例： 2026-01-15T08:00:00Z
configRevision
String
配置修订版本。
示例： 10
observed
Object
已观察。
- drainWaitSeconds
  Integer
  资源。
  示例： 10
- drainStartedAt
  String
  排空开始时间。
  示例： 2026-01-15T08:00:00Z
- drainDeadlineAt
  String
  排空截止时间。
  示例： 2026-01-15T08:00:00Z
- queueFacts
  Object
  队列原始数据。
  queueSize
  Long
  资源。
  示例： 0
  queueCapacity
  Long
  资源。
  示例： 0
  enqueueFailedMetricPoints
  Long
  资源。
  示例： 0
  sendFailedMetricPoints
  Long
  资源。
  示例： 0
  sentMetricPoints
  Long
  资源。
  示例： 0
  serviceInstanceId
  String
  资源。
  示例： value
  observedAt
  String
  已观察时间。
  示例： 2026-01-15T08:00:00Z

变更历史

查看全部变更历史

变更时间变更内容概要操作

变更时间
2026-09-17
新增响应字段 previousAgentRelease, targetAgentRelease
查看 API

资产

采集任务

基础设施综合

安装器

生命周期

OTA 升级计划

OTA 版本与策略

联邦与 SSO

变更管理

生命周期升级

告警规则

告警模板

告警通道与集成

告警事件

告警路由与策略

安全

ZMetis 审计

平台管理

平台联邦

平台健康

平台综合

ZMetis 任务

获取受管代理任务

认证信息

请求参数

路径参数

响应状态

变更历史