文档首页 > > API参考> API说明> 管理加密密钥> 修改密钥别名

修改密钥别名

分享
更新时间: 2019/10/26 GMT+08:00

功能介绍

修改用户主密钥别名。

  • 服务默认主密钥(密钥别名后缀为“/default”)不可以修改。
  • 密钥处于“计划删除”状态,密钥别名不可以修改。

URI

  • URI格式

    POST /v1.0/{project_id}/kms/update-key-alias

  • 参数说明
    表1 参数说明

    参数

    是否必选

    参数类型

    描述

    project_id

    String

    项目ID。

请求消息

表2 请求参数

参数

是否必选

参数类型

描述

key_id

String

密钥ID,36字节,满足正则匹配“^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$”。

例如:0d0466b0-e727-4d9c-b35d-f84bb474a37f

key_alias

String

非默认主密钥别名,取值1到255字符,满足正则匹配“^[a-zA-Z0-9:/_-]{1,255}$”且后缀不可以为“/default”。

sequence

String

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

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

响应消息

表3 响应参数

参数

是否必选

参数类型

描述

key_id

String

密钥ID。

key_alias

String

密钥别名。

示例

如下以修改别名为“test”,密钥ID为“bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e”的密钥为例。

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

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

状态码

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

状态码

编码

状态说明

200

OK

请求已成功。

异常状态码,请参见状态码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

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

跳转到云社区