文档首页/ 数据加密服务 DEW/ API参考（吉隆坡区域）/ API说明/ 创建密钥
更新时间：2022-08-23 GMT+08:00
查看PDF
分享

创建密钥

功能介绍

创建用户主密钥，可用来加密数据密钥。

别名“/default”为服务默认主密钥的后缀名，由服务自动创建。因此用户创建的主密钥别名不能与服务默认主密钥的别名相同，即后缀名不能为“/default”。

URI

  • URI格式

    POST /v1.0/{project_id}/kms/create-key

  • 参数说明
    表1 参数说明

    参数

    是否必选

    参数类型

    描述

    project_id

    是

    String

    项目ID。

请求消息

表2 请求参数

参数

是否必选

参数类型

描述

key_alias

是

String

非默认主密钥别名，取值范围为1到255个字符，满足正则匹配“^[a-zA-Z0-9:/_-]{1,255}$”，且不与系统服务创建的默认主密钥别名重名。

key_description

否

String

密钥描述，取值0到255字符。

sequence

否

String

请求消息序列号，36字节序列号。

例如：919c82d4-8046-4722-9094-35c3c6524cff

响应消息

表3 响应参数

参数

是否必选

参数类型

描述

key_info

是

Array of objects

密钥信息，详情请参见表4。
表4 key_info字段结构说明

参数

是否必选

参数类型

描述

key_id

是

String

密钥ID。

domain_id

是

String

用户域ID。

示例

如下以创建别名为“test”的密钥为例。

  • 请求样例 
    {
    "key_alias": "test"
}
  • 响应样例 
    {
    "key_info": {
        "key_id": "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
        "domain_id": "b168fe00ff56492495a7d22974df2d0b"
    }
}

    或

    {
    "error": {
        "error_code": "KMS.XXXX",
        "error_msg": "XXX"
    }
}

状态码

表5描述的是API返回的正常状态码。
表5 状态码

状态码

编码

状态说明

200

OK

请求已成功。

异常状态码，请参见状态码。

父主题： API说明