删除主密钥

功能说明

提供主密钥删除功能。

URL

DELETE https://ip:port/AIVAULT/v1/deleteMK/{MKName}

请求Header

表1 请求Header

参数名

类型

说明

DomainID

uint

密钥作用域ID,可以表示一个组织、一个应用或者一个模型的域。取值范围为[1, 500]。

  1. 该请求Header中的参数由用户自行填写。
  2. DomainID用于区分不同的应用或者模型,最多支持500个域。
  3. 删除主密钥属于高危操作,在执行前,调用方需要对用户进行二次身份认证和“防呆设计”:提示用户删除主密钥的风险。
  4. 删除主密钥前,需要提前删除与该主密钥相关联的其他密钥和数据。

请求参数

表2 请求参数

参数名

必选

类型

说明

MKName

必选

string

不允许批量删除,从而避免用户误删除主密钥,仅支持删除单条记录。长度为[1, 128],仅支持数字、字母、下划线和“-”字符

请求示例

https://ip:port/AIVAULT/v1/deleteMK/test

响应说明

表3 响应说明

一级参数名

类型

说明

status

string

错误码

msg

string

错误信息

data

object

返回报文列表

响应示例

{
    "status": "00000000",
    "msg": "ok",
    "data": null
}

错误码见错误码说明

状态码见状态码说明