Ukey
September 26, 2022About 5 min
Ukey
SDK类名：/resource/Ukey;
Ukey - 新建
SDK方法名：createUkey;
URL
/ukey
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ukey_name | String | Ukey名称 | |||
| ukey_type | String | Ukey类型 默认 - ROCKY-ARM | |||
| node_uuid | String | 否 | 节点uuid | ||
| ukey_id | String | 否 | Ukey ID | ||
| ukey_pwd | String | 口令 | |||
| comment | String | 备注 | |||
| import_pwd_switch | Number | 导入口令开关 0-不勾选 1-勾选 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功。 |
Ukey - 修改
SDK方法名：modifyUkey;
URL
/ukey/:uuid([A-F0-9-]+)
Method
PUT
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ukey_name | String | 名称 | |||
| comment | String | 备注 | |||
| ukey_pwd | String | 口令 | |||
| random_str | String |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功。 |
Ukey - 单个
SDK方法名：discribeUkey;
URL
/ukey/:uuid([A-F0-9-]+)
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0]操作成功。 | |||
| ukey | Object | ||||
| ukey_name | String | ||||
| ukey_type | String | ||||
| node_uuid | String | ||||
| ukey_id | String | ||||
| ukey_pwd | String | ****** | |||
| comment | String | ||||
| ukey_uuid | String | ||||
| user_uuid | String | ||||
| random_str | String |
Ukey - 列表
SDK方法名：listUkey;
URL
/ukey
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0]操作成功 | |||
| info_list | Array | 2 | |||
| ukey_name | String | @first | |||
| ukey_type | Number | 0 | |||
| comment | String | efadfadfadsfd | |||
| ukey_uuid | String | @pick(8264AEDC-815B-0FA1-1FEE-F8B4FD15E1F1, @uuid) | |||
| user_uuid | String | @uuid | |||
| username | String | admin | |||
| node_uuid | String | ||||
| ukey_id | String | DFKLFJLKJLSKJFASDKJFASDFDASKLFJASDLKFJ | |||
| create_time | Number | 1121323232 | |||
| total | Number | 1 |
Ukey - 删除
SDK方法名：deleteUkey;
URL
/ukey
Method
DELETE
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ukey_uuids | Array | ["81296F62-C542-5D68-3282-9B5815742290"] | |||
| force | Number | 0 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功。 |
Ukey - 操作
SDK方法名：operateUkey;
URL
/ukey/operate
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| operate | String | 【必传】操作类型： reset - 重置Ukey clone - 克隆 get_pwd - 查看密钥 bind_node - 关联节点 untie_node - 解除绑定 | |||
| ukey_uuid | String | 【查看密钥】 【重置Ukey】 【关联节点】 【取消关联节点】 ukey uuid | |||
| node_uuid | String | 【clone 取消关联节点必传】 目标ukey所在节点uuid | |||
| ukey_id | String | 【clone必传】 目标ukey ID | |||
| ukey_name | String | 【clone必传】 目标ukey 名称 | |||
| ukey_pwd | String | 【关联节点/重置UKey 必传】 口令 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功。 | |||
| credential_list | Array | 【查看密钥】返回，关联的凭据列表 | |||
| cred_uuid | String | ||||
| cred_name | String | ||||
| cred_type | Number |
Ukey - 状态
SDK方法名：listUkeyStatus;
URL
/ukey/status
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ukey_uuids | Array |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功。 | |||
| status | Array | ||||
| ukey_uuid | String | 8264AEDC-815B-0FA1-1FEE-F8B4FD15E1F1 | |||
| status | String | NOT_INIT: 未初始化 NORMAL_USE: 正常使用 | @pick(NORMAL_USE, NOT_INIT) |
Ukey - 获取关联节点
SDK方法名：listUkeyNodeList;
URL
/ukey/node_list
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ukey_uuid | String | 非必选，不传返回所有关联ukey的节点，传了返回关联指定ukey的节点 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| data | Object | ||||
| info_list | Array | ||||
| obj_name | String | @name | |||
| obj_uuid | String | @uuid | |||
| has_rules | Number | 3 | |||
| rule_list | Array | ["rep01"] | |||
| code | Number | 0 | |||
| message | String | ||||
| msg | String | ||||
| ret | Number | 200 |
Ukey - 扫描
SDK方法名：scanUkey;
URL
/ukey/scan
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| node_uuid | String | ||||
| ukey_type | String | Ukey类型 默认 - ROCKY-ARM |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | ||||
| device_id | Array | ||||
| msg | String |
Ukey - 口令导出接口
SDK方法名：exportUkeyInfo;
URL
/ukey/export_info
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| export_pwd | String | 【必传】导出前指定的密码 | |||
| ukey_uuids | Array | 【可选】不传导出所有 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Ukey - 口令导入接口
SDK方法名：importUkeyInfo;
URL
/ukey/import_info
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| export_pwd | String | 导出是输入的密码，加密后存入导出文件中 | |||
| import_pwd | String | 导入时输入的密码，用于跟export_pwd比对 | |||
| ukey_info | Array | 导出的ukey信息 | |||
| ukey_name | String | Ukey名称 | |||
| ukey_type | String | Ukey类型 | |||
| node_list | Array | Ukey关联的节点 | |||
| node_name | String | 节点名称 | |||
| config_addr | String | 节点地址 | |||
| ukey_id | String | 硬件ID | |||
| ukey_pwd | String | 口令(aes加密字符串) | |||
| Ukey_uuid | String | 预留字段，ukey的uuid |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功。 |