更新时间:2023-04-24 GMT+08:00
分享

创建密钥

功能介绍

创建密钥,如果通过在应用部署中配置密钥,容器下发到设备之后,在容器上看到的密钥是解密的

URI

POST /v3/{project_id}/ai-mgr/secrets

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取方法请参见获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

provider

String

服务名称,hilens或者ief,默认hilens

缺省值:hilens

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

租户Token。获取方法请参见获取Token

表4 请求Body参数

参数

是否必选

参数类型

描述

workspace_id

String

工作空间ID。默认为default。

secret

SecretObjectInSecretRequestBody object

密钥信息

表5 SecretObjectInSecretRequestBody

参数

是否必选

参数类型

描述

name

String

密钥名称,以小写英文字母开头,4-64位,可以使用小写英文、数字、中划线(-),不能以中划线结尾。

description

String

密钥描述,最大长度255,不允许^ ~ # $ % & * < > ( ) [ ] { } ' " \。

secrets

Array of Secret objects

secrets是一个列表,由多个字典组成,数量上限为100个。字典的key和value均为字符串。key由大小写字母,中划线(-)开头,由数字、大小写字母、点号(.)、中划线(-)、下划线(_)组成,最小长度为1,最大长度63个字符, value不能含有字符不允许^ ~ # $ |% & < > ( ) [ ] { } '' " \,最大长度20480个字符。

tags

Array of Tag objects

tags是一个列表,由多个字典组成,数量上限为20个。字典的key和value均为字符串。key由数字、大小写字母、点号(.)、中划线(-)、下划线(_)组成,最小长度为1,最大长度36个字符, value由数字、大小写字母、点号(.)、中划线(-)、下划线(_), 斜线(\)组成,最小长度为1,最大长度43个字符。

表6 Secret

参数

是否必选

参数类型

描述

key

String

密钥key,最大长度63个字符。不能为空,只能包含大小写字母,数字,中划线“-”,下划线“_”

value

String

密钥value,每个值最大长度10000个字符,删除时如果value有值按照key/value删除,如果value没值,则按照key删除。不能为空,只能包含大小写字母,数字,中划线“-”,下划线“_”

表7 Tag

参数

是否必选

参数类型

描述

key

String

标签key,最大长度36个字符。不能为空,只能包含大小写字母,数字,中划线“-”,下划线“_”

value

String

标签value,每个值最大长度43个字符,删除时如果value有值按照key/value删除,如果value没值,则按照key删除。不能为空,只能包含大小写字母,数字,中划线“-”,下划线“_”

响应参数

状态码: 200

表8 响应Body参数

参数

参数类型

描述

workspace_id

String

工作空间ID

secret

secret object

密钥

表9 secret

参数

参数类型

描述

id

String

密钥ID

name

String

密钥名称

description

String

密钥描述

project_id

String

项目ID

created_at

String

密钥创建时间

updated_at

String

密钥更新时间

secrets

Array of Secret objects

密钥列表

tags

Array of Tag objects

标签列表

表10 Secret

参数

参数类型

描述

key

String

密钥key,最大长度63个字符。不能为空,只能包含大小写字母,数字,中划线“-”,下划线“_”

value

String

密钥value,每个值最大长度10000个字符,删除时如果value有值按照key/value删除,如果value没值,则按照key删除。不能为空,只能包含大小写字母,数字,中划线“-”,下划线“_”

表11 Tag

参数

参数类型

描述

key

String

标签key,最大长度36个字符。不能为空,只能包含大小写字母,数字,中划线“-”,下划线“_”

value

String

标签value,每个值最大长度43个字符,删除时如果value有值按照key/value删除,如果value没值,则按照key删除。不能为空,只能包含大小写字母,数字,中划线“-”,下划线“_”

请求示例

创建新的密钥

POST https://{endpoint}/v3/{project_id}/ai-mgr/secrets

{
  "workspace_id" : "string",
  "secret" : {
    "name" : "string",
    "description" : "string",
    "secrets" : [ {
      "key" : "string",
      "value" : "string"
    } ],
    "tags" : [ {
      "key" : "string",
      "value" : "string"
    } ]
  }
}

响应示例

状态码: 200

请求成功

{
  "workspace_id" : "string",
  "secret" : {
    "id" : "string",
    "name" : "string",
    "description" : "string",
    "project_id" : "string",
    "created_at" : "string",
    "updated_at" : "string",
    "secrets" : [ {
      "key" : "string",
      "value" : "string"
    } ],
    "tags" : [ {
      "key" : "string",
      "value" : "string"
    } ]
  }
}

状态码

状态码

描述

200

请求成功

401

认证不通过

403

拒绝执行请求

404

请求的资源不存在

500

服务器内部错误

错误码

请参见错误码

相关文档