我的书签
添加书签
移除书签节点预配
下载注册信息
基本信息
Path： /v1/register/:batchName/download
Method： GET
接口描述：
用于下载一个产品批次下所有的注册记录
正常时返回二进制数据，错误返回如下结构错误信息:
{
“code”: “ResourceNotFound”,
“message”: “The (batch) resource (0513021) is not found.”,
“request-id”: “a14fd53d-f3ea-4edb-bef2-b183b9ed0b87”
}
请求参数
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| batchName | r0 | 产品批次名称 |
返回数据
{"type":"object","title":"title","properties":{}}
回调创建
基本信息
Path： /v1/callback
Method： POST
接口描述：
创建一个回调，可以在激活成功后由系统自动调用
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| name | string | 必须 | 回调名称 | ||
| namespace | string | 非必须 | 用户空间 | ||
| method | string | 必须 | Post/Get/Delete/Put/Patch/Trace等 | ||
| url | string | 必须 | |||
| header | object | 非必须 | header参数 | ||
| params | object | 非必须 | 路径参数 | ||
| body | object | 非必须 | body参数 | ||
| description | string | 非必须 | 描述信息 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| name | string | 非必须 | |||
| namespace | string | 非必须 | |||
| method | string | 非必须 | |||
| url | string | 非必须 | |||
| params | object | 非必须 | |||
| header | object | 非必须 | |||
| body | object | 非必须 | |||
| description | string | 非必须 | |||
| createTime | string | 非必须 | |||
| updateTime | string | 非必须 |
回调删除
基本信息
Path： /v1/callback/:name
Method： DELETE
接口描述：
删除回调记录，若在被使用中则无法删除，即被至少一个产品批次所关联
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| name | 回调名称 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| success | boolean | 非必须 |
回调更新
基本信息
Path： /v1/callback/:name
Method： PUT
接口描述：
更新一个指定name回调的部分信息
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| name | 回调名称 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| method | string | 非必须 | Post/Get/Delete/Put/Patch/Trace等 | ||
| url | string | 非必须 | |||
| header | object | 非必须 | header参数 | ||
| params | object | 非必须 | 路径参数 | ||
| body | object | 非必须 | body参数 | ||
| description | string | 非必须 | 描述信息 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| name | string | 非必须 | |||
| namespace | string | 非必须 | |||
| method | string | 非必须 | |||
| url | string | 非必须 | |||
| params | object | 非必须 | |||
| header | object | 非必须 | |||
| body | object | 非必须 | |||
| description | string | 非必须 | |||
| createTime | string | 非必须 | |||
| updateTime | string | 非必须 |
回调获取
基本信息
Path： /v1/callback/:name
Method： GET
接口描述：
获取一个指定名称的回调的详细信息
请求参数
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| name | c0 | 回调名称 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| name | string | 非必须 | |||
| namespace | string | 非必须 | |||
| method | string | 非必须 | |||
| url | string | 非必须 | |||
| params | object | 非必须 | |||
| header | object | 非必须 | |||
| body | object | 非必须 | |||
| description | string | 非必须 | |||
| createTime | string | 非必须 | |||
| updateTime | string | 非必须 |
创建产品/批次
基本信息
Path： /v1/register
Method： POST
接口描述：
创建一个产品/批次，可以用于批量的设备注册管理，提供多种激活方式
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| name | string | 非必须 | 名称 | ||
| securityType | string | 非必须 | 校验方式，None/Token，默认Token | ||
| fingerprint | object | 非必须 | 激活方式信息 | ||
| ├─ type | integer | 非必须 | 激活方式，sn=1,input=2,hostname=4,bootid=8,systemuuid=16,machineid=32 | ||
| ├─ snPath | string | 非必须 | 选用sn时，激活文件的路径及名称，默认 /var/lib/baetyl/sn/fingerprint.txt 注意需要使用绝对路径 | ||
| ├─ inputField | string | 非必须 | 选用input时，获取的字段名称，默认为sn | ||
| description | string | 非必须 | 描述信息 | ||
| enableWhitelist | integer | 非必须 | 是否开启预注册，默认开启：1 | ||
| quotaNum | integer | 非必须 | 数量，默认200 | ||
| securityKey | string | 非必须 | 对应于验证方式的key，如用户自定义的token，为空则由系统生成 | ||
| callbackName | string | 非必须 | 回调名称 | ||
| labels | object | 非必须 | 标签对，激活后设置到对应node上 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| name | string | 必须 | |||
| quotaNum | integer | 必须 | |||
| enableWhitelist | integer | 必须 | |||
| securityType | string | 必须 | |||
| securityKey | string | 非必须 | |||
| callbackName | string | 非必须 | |||
| labels | object | 必须 | |||
| fingerprint | object | 必须 | |||
| ├─ type | integer | 必须 | |||
| ├─ snPath | string | 非必须 | |||
| ├─ inputField | string | 非必须 | |||
| description | string | 非必须 | |||
| createTime | string | 必须 | |||
| updateTime | string | 必须 |
罗列产品
基本信息
Path： /v1/register
Method： GET
接口描述：
获取已经创建的产品的列表，支持分页查询和按名称过滤查询
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| pageNo | 是 | ||
| pageSize | 是 | ||
| name | 是 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| total | number | 非必须 | |||
| pageNo | number | 必须 | |||
| pageSize | number | 必须 | |||
| items | object [] | 非必须 | item 类型: object | ||
| ├─ name | string | 非必须 | |||
| ├─ createTime | string | 非必须 | |||
| ├─ updateTime | string | 非必须 | |||
| ├─ quotaNum | number | 非必须 | |||
| ├─ securityType | string | 非必须 | |||
| ├─ callbackName | string | 非必须 | |||
| ├─ description | string | 非必须 |
查询产品
基本信息
Path： /v1/register/:batch
Method： GET
接口描述：
获取一个产品的详细信息
请求参数
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| batch | product001 | 批次名称 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| name | string | 必须 | |||
| quotaNum | number | 必须 | |||
| enableWhitelist | number | 必须 | |||
| securityType | string | 必须 | |||
| labels | object | 必须 | |||
| fingerprint | object | 非必须 | |||
| ├─ type | number | 必须 | |||
| ├─ snPath | string | 非必须 | |||
| ├─ inputField | string | 非必须 | |||
| createTime | string | 必须 | |||
| updateTime | string | 必须 | |||
| securityKey | string | 非必须 | |||
| callbackName | string | 非必须 | |||
| description | string | 非必须 |
删除产品
基本信息
Path： /v1/register/:batch
Method： DELETE
接口描述：
删除一个指定的产品，如果有注册记录（无论是否激活）则不能删除
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| batch | product001 | 批次名称 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|
更新产品
基本信息
Path： /v1/register/:batch
Method： PUT
接口描述：
更新一个指定产品的部分信息
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| batch |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| quotaNum | number | 非必须 | |||
| labels | object | 非必须 | |||
| fingerprint | object | 非必须 | |||
| ├─ snPath | string | 非必须 | |||
| ├─ type | integer | 非必须 | |||
| ├─ inputField | string | 非必须 | |||
| callbackName | string | 非必须 | |||
| description | string | 非必须 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| name | string | 非必须 | |||
| quotaNum | number | 非必须 | |||
| enableWhitelist | number | 非必须 | |||
| securityType | string | 非必须 | |||
| labels | object | 非必须 | |||
| fingerprint | object | 非必须 | |||
| ├─ type | number | 非必须 | |||
| ├─ snPath | string | 非必须 | |||
| ├─ inputField | string | 非必须 | |||
| createTime | string | 非必须 | |||
| updateTime | string | 非必须 | |||
| securityKey | string | 非必须 | |||
| callbackName | string | 非必须 | |||
| description | string | 非必须 |
获取安装方式
基本信息
Path： /v1/register/:batch/init
Method： GET
接口描述：
生成在线安装命令，复制在线命令后在端侧控制台执行即可安装
请求参数
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| batch |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| cmd | string | 必须 |
添加注册记录
基本信息
Path： /v1/register/:batchName/record
Method： POST
接口描述：
添加一条注册记录
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| batchName |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| name | string | 非必须 | |||
| fingerprintValue | string | 非必须 | 指纹信息，激活时比对用 | ||
| nodeName | string | 非必须 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| name | string | 必须 | |||
| batchName | string | 必须 | |||
| namespace | string | 必须 | |||
| fingerprintValue | string | 必须 | |||
| active | integer | 必须 | 是否已经激活 | ||
| nodeName | string | 必须 | |||
| activeIp | string | 必须 | |||
| createTime | string | 必须 | |||
| updateTime | string | 必须 |
自动生成注册记录
基本信息
Path： /v1/register/:batchName/generate
Method： POST
接口描述：
自动生成并插入num条注册记录
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| batchName |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| num | number | 必须 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| items | string [] | 非必须 | item 类型: string | ||
| ├─ | 非必须 | ||||
| total | number | 非必须 |
罗列注册记录
基本信息
Path： /v1/register/:batchName/record
Method： GET
接口描述：
获取注册记录的列表，可以分页查询和过滤查询
请求参数
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| batchName |
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| pageNo | 是 | ||
| pageSize | 是 | ||
| name | 是 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| total | number | 非必须 | |||
| pageNo | number | 必须 | |||
| pageSize | string | 必须 | |||
| items | object [] | 非必须 | item 类型: object | ||
| ├─ name | string | 非必须 | |||
| ├─ batchName | string | 非必须 | |||
| ├─ namespace | string | 非必须 | |||
| ├─ fingerprintValue | string | 非必须 | |||
| ├─ active | number | 非必须 | |||
| ├─ nodeName | string | 非必须 | |||
| ├─ activeIp | string | 非必须 | |||
| ├─ createTime | string | 非必须 | |||
| ├─ updateTime | string | 非必须 |
查询注册记录
基本信息
Path： /v1/register/:batchName/record/:recordName
Method： GET
接口描述：
获取一条指定的注册记录的数据
请求参数
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| batchName | ||
| recordName |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| name | string | 必须 | |||
| batchName | string | 必须 | |||
| namespace | string | 必须 | |||
| fingerprintValue | string | 必须 | |||
| active | number | 必须 | |||
| nodeName | string | 必须 | |||
| activeIp | string | 必须 | |||
| createTime | string | 必须 | |||
| updateTime | string | 必须 |
更新注册记录
基本信息
Path： /v1/register/:batchName/record/:recordName
Method： PUT
接口描述：
更新一条指定的注册记录的信息
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| batchName | ||
| recordName |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| nodeName | string | 非必须 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| name | string | 非必须 | |||
| batchName | string | 非必须 | |||
| namespace | string | 非必须 | |||
| fingerprintValue | string | 非必须 | |||
| active | number | 非必须 | |||
| nodeName | string | 非必须 | |||
| activeIp | string | 非必须 | |||
| createTime | string | 非必须 | |||
| updateTime | string | 非必须 |
删除注册记录
基本信息
Path： /v1/register/:batchName/record/:recordName
Method： DELETE
接口描述：
删除一条指定的注册记录
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| batchName | ||
| recordName |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|
