本文导读

展开导读

文档首页/ 华为HiLens/ API参考/ API（专业版控制台）/ 密钥管理/ 创建密钥

创建密钥

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

查看PDF

功能介绍

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

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	服务器内部错误

错误码

请参见错误码。

父主题： 密钥管理

上一篇：查询密钥列表

下一篇：查询密钥详情

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

创建密钥

功能介绍

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线

文档反馈