跳转到主要内容
基础设施相关接口/OTA 版本与策略

注册版本

注册新软件版本OTA版本目录。

POST/api/v1/ota/versions

操作 ID

RegisterVersion

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • version
    String必填

    版本号。

    示例: 1.3.0

  • releaseNotes
    String必填

    描述变更版本。

    示例: Bug fixes and performance improvements

  • sha256Checksum
    String必填

    SHA 256校验和。

    示例: abc123def456abc123def456abc123def456abc123def456abc123def456abc1

  • fileSize
    String必填

    文件大小。

    示例: 52428800

  • minAgentVersion
    String必填

    最小代理版本。

    示例: 1.2.0

响应状态

200 OK
200 OK

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

  • id
    String

    资源ID。

    示例: ver-a1b2c3d4-e5f6-7890-abcd-ef1234567890

  • version
    String

    版本号。

    示例: 1.3.0

  • releaseNotes
    String

    人类可读发布备注版本。

    示例: Bug fixes and performance improvements

  • sha256Checksum
    String

    OTA构件。

    示例: abc123def456abc123def456abc123def456abc123def456abc123def456abc1

  • fileSize
    String

    大小OTA构件字节。

    示例: 52428800

  • minAgentVersion
    String

    最小代理版本。

    示例: 1.2.0

  • status
    String

    状态信息。

    示例: active

  • deprecateReason
    String

    原因版本已弃用适用。

    示例: Security vulnerability in v1.3.0; upgrade to v1.3.1

  • createdAt
    String

    创建时间。

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

  • updatedAt
    String

    更新时间。

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