跳转到主要内容
ZStack
近期删除/近期删除

创建注册邀请

使用 `agent.deploy` 权限创建安装邀请。仅首次成功创建时返回注册代码。初始选择 `host_metrics` 还需要 `agent.config.write` 权限。

POST/api/v1/lifecycle/managed-agent/enrollment-invitations

操作 ID

CreateEnrollmentInvitation

起始版本

1.3.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • requestId
    String

    资源。

    示例： value

  • scope
    Object

    作用范围。

    • platformUuid
      String

      平台UUID。

      示例： value

    • regionUuid
      String

      资源。

      示例： value

  • displayName
    String

    显示名称。用于界面展示。

    示例： value

  • initialCapabilityId
    String

    初始能力ID。

    示例： value

响应状态

200 OK
200 OK

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

  • invitationId
    String

    资源。

    示例： value

  • taskId
    String

    任务ID。

    示例： value

  • enrollmentCode
    String

    敏感信息，仅首次创建时返回；不得记录响应体。

    示例： value

  • expiresAt
    String

    过期时间。

    示例： 2026-01-15T08:00:00Z

  • install
    Object

    资源。

    • scriptUrl
      String

      HTTPS 下载地址模板为 `/install/{os}/{arch}?invitationId=`。模板中的占位符使用目标机器的 `uname` 值填充。

      示例： https://example.com/callback

    • sha256
      String

      数据完整性校验值（SHA-256）。

      示例： value