查询主密钥

功能说明

查询主密钥,仅支持查询主密钥的用途,创建时间,备注等字段。

URL

GET https://ip:port/AIVAULT/v1/queryMK

请求Header

表1 请求Header

参数名

类型

说明

DomainID

uint

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

  1. 该请求Header中的参数由用户自行填写。
  2. DomainID用于区分不同的应用或者模型,最多支持500个域。

请求参数

表2 请求参数

参数名

是否必选

类型

说明

MKName

可选

string

请求中不携带MKName,则按下面过滤参数条件查询MK,长度为[1, 128],仅支持数字、字母、下划线和“-”字符

SortBy

可选

string

可选CreateTime和MKName(默认安装时间降序排列)

SortMode

可选

string

可选asc和desc,默认desc。asc为升序排序,desc为降序排序

请求示例

https://ip:port/AIVAULT/v1/queryMK?MKName=test

响应说明

表3 响应说明

一级参数名

二级参数名

类型

说明

status

\

string

错误码

msg

\

string

错误信息

data

\

object

返回报文列表,可能包含多条记录。

\

CreateType

string

创建类型

\

MkID

int

主密钥ID

\

MKName

string

主密钥名称,名称必须唯一不可重复

\

MKUsage

string

主密钥的用途,用于用户对主密钥的控制

\

MKRemarks

string

备注

\

CreatedAt

string

创建时间

响应示例

{
    "status": "00000000",
    "msg": "ok",
    "data": [
        {
            "MkID": 9,
            "MKName": "test",
            "CreateType": "AIVAULT",
            "MKUsage": "TEST",
            "MKRemarks": "test create",
            "CreatedAt": "2022-06-15T11:02:28.464218214+08:00"
          }
        ]
}

错误码见错误码说明

状态码见状态码说明