获取注册邀请

使用 `agent.deploy` 权限读取安装邀请、尝试和任务摘要。不返回安装代码、会话或凭据。

GET/api/v1/lifecycle/managed-agent/enrollment-invitations/{id}

操作 ID

GetEnrollmentInvitation

起始版本

1.3.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

路径参数

id
String必填
注册邀请的唯一标识。

响应状态

200 OK

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

invitationId
String
资源。
示例： value
state
String
当前状态。
示例： value
expiresAt
String
过期时间。
示例： 2026-01-15T08:00:00Z
agentId
String
代理ID。
示例： value
enrollmentAttempt
Object
资源。
- attemptId
  String
  资源。
  示例： value
- state
  String
  当前状态。
  示例： value
- expiresAt
  String
  过期时间。
  示例： 2026-01-15T08:00:00Z
- firstConnectedAt
  String
  首次已连接时间。
  示例： 2026-01-15T08:00:00Z
- completedAt
  String
  完成时间。
  示例： 2026-01-15T08:00:00Z
- errorReason
  String
  资源。
  示例： value
deployTask
Object
资源。
- taskId
  String
  任务ID。
  示例： value
- type
  String
  已持久化的注册任务类型：`deploy` 表示安装 `Agent`，`enable_capability` 表示首次启用能力。
  示例： value
- state
  String
  当前状态。
  示例： value
- capabilityId
  String
  资源。
  示例： value
- errorCode
  String
  LDAP错误分类编码。
  示例： value
- errorReason
  String
  资源。
  示例： value
- errorMessage
  String
  错误返回消息。
  示例： value
- traceId
  String
  链路追踪ID。
  示例： value
- startedAt
  String
  开始时间。
  示例： 2026-01-15T08:00:00Z
- completedAt
  String
  完成时间。
  示例： 2026-01-15T08:00:00Z
- errorDetails
  Object
  存在保存10012部署错误。
  deployment_phase
  String
  资源。
  示例： value
  invitation_consumed
  Boolean
  资源。
  示例： true
  registered_agent_id
  Object
  已注册代理ID。
  recovery_action
  String
  资源。
  示例： value
initialCapabilityTask
Object
资源。
- taskId
  String
  任务ID。
  示例： value
- type
  String
  已持久化的注册任务类型：`deploy` 表示安装 `Agent`，`enable_capability` 表示首次启用能力。
  示例： value
- state
  String
  当前状态。
  示例： value
- capabilityId
  String
  资源。
  示例： value
- errorCode
  String
  LDAP错误分类编码。
  示例： value
- errorReason
  String
  资源。
  示例： value
- errorMessage
  String
  错误返回消息。
  示例： value
- traceId
  String
  链路追踪ID。
  示例： value
- startedAt
  String
  开始时间。
  示例： 2026-01-15T08:00:00Z
- completedAt
  String
  完成时间。
  示例： 2026-01-15T08:00:00Z
- errorDetails
  Object
  存在保存10012部署错误。
  deployment_phase
  String
  资源。
  示例： value
  invitation_consumed
  Boolean
  资源。
  示例： true
  registered_agent_id
  Object
  已注册代理ID。
  recovery_action
  String
  资源。
  示例： value
displayName
String
显示名称。用于界面展示。
示例： value
scope
Object
作用范围。
- platformUuid
  String
  平台UUID。
  示例： value
- regionUuid
  String
  资源。
  示例： value
install
Object
安装。
- scriptUrl
  String
  HTTPS 下载地址模板为 `/install/{os}/{arch}?invitationId=`。模板中的占位符使用目标机器的 `uname` 值填充。
  示例： https://example.com/callback
- sha256
  String
  数据完整性校验值（SHA-256）。
  示例： value
initialCapabilityId
String
初始能力ID。
示例： value

请求示例

curl -X GET '{host}/api/v1/lifecycle/managed-agent/enrollment-invitations/{id}' \
  -H 'Authorization: Bearer {token}'

响应示例

{
  "invitationId": "value",
  "state": "value",
  "expiresAt": "2026-01-15T08:00:00Z",
  "agentId": "value",
  "enrollmentAttempt": {
    "attemptId": "value",
    "state": "value",
    "expiresAt": "2026-01-15T08:00:00Z",
    "firstConnectedAt": "2026-01-15T08:00:00Z",
    "completedAt": "2026-01-15T08:00:00Z",
    "errorReason": "value"
  },
  "deployTask": {
    "taskId": "value",
    "type": "value",
    "state": "value",
    "capabilityId": "value",
    "errorCode": "value",
    "errorReason": "value",
    "errorMessage": "value",
    "traceId": "value"
  },
  "initialCapabilityTask": {
    "taskId": "value",
    "type": "value",
    "state": "value",
    "capabilityId": "value",
    "errorCode": "value",
    "errorReason": "value",
    "errorMessage": "value",
    "traceId": "value"
  },
  "displayName": "value"
}

变更历史

查看全部变更历史

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

变更时间
2026-09-22
新增响应字段 initialCapabilityId
查看 API

资产

采集任务

基础设施综合

安装器

生命周期

OTA 升级计划

OTA 版本与策略

联邦与 SSO

变更管理

生命周期升级

告警规则

告警模板

告警通道与集成

告警事件

告警路由与策略

安全

ZMetis 审计

平台管理

平台联邦

平台健康

平台综合

ZMetis 任务

获取注册邀请

认证信息

请求参数

路径参数

响应状态

变更历史