功能说明

查询用户预共享密钥，仅支持查询预共享密钥的状态，备注等信息字段。预共享密钥仅在第一次创建时返回给用户，无其他接口可获取，请用户妥善保管创建时获取到的预共享密钥文件。

URL

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

请求Header

表1 请求Header
参数名	类型	说明
DomainID	uint	密钥作用域ID，可以表示一个组织、一个应用或者一个模型的域。取值范围为[1, 500]。

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

请求参数

表2 请求参数
参数名	是否必选	类型	说明
PSKName	可选	string	请求中不携带PSKName，则查询所有的PSK，长度为[1, 128]，仅支持数字、字母、下划线和“-”字符
SortBy	可选	string	可选CreateTime和PSKName
SortMode	可选	string	可选asc和desc，默认desc（默认按照时间降序排列）
BindMKName	可选	string	绑定主密钥名称，长度为[1, 128]，仅支持数字、字母、下划线和“-”字符

请求示例

https://ip:port/AIVAULT/v1/queryPSK?PSKName=test

响应说明

表3 响应说明
一级参数名	二级参数名	类型	说明
status	\	string	错误码
msg	\	string	错误信息
data	\	object	返回报文列表，可能包含多条记录。
\	PSKName	string	预共享密钥名称，名称必须唯一不可重复
\	PSKBindMKName	string	预共享密钥绑定的主密钥名称。
\	PSKCreateTime	string	预共享密钥创建时间。
\	PSKRemarks	string	备注

响应示例

{
    "status": "00000000",
    "msg": "ok",
    "data": [
        {
            "PSKName": "test",
            "PSKRemarks": "test",
            "PSKCreateTime": "2022-06-15T14:40:22.753669124+08:00",
            "PSKBindMKName": "test"
        }
    ]
}

错误码见错误码说明。

状态码见状态码说明。