文档首页/ 密码安全中心 DEW/ API参考（吉隆坡区域）/ API说明/ 禁用密钥
更新时间：2022-08-23 GMT+08:00
查看PDF
分享

禁用密钥

功能介绍

禁用密钥，密钥禁用后不可以使用。

密钥为启用状态才能禁用密钥。

URI

  • URI格式

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

  • 参数说明
    表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

sequence

否

String

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

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

响应消息

表3 响应参数

参数

是否必选

参数类型

描述

key_info

是

Array of objects

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

参数

是否必选

参数类型

描述

key_id

是

String

密钥ID。

key_state

是

String

密钥状态：

  • 2为启用状态
  • 3为禁用状态
  • 4为计划删除状态

示例

如下以禁用密钥ID为“0d0466b0-e727-4d9c-b35d-f84bb474a37f”的密钥为例。

  • 请求样例 
    {
    "key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f"
}
  • 响应样例 
    {
    "key_info": {
        "key_id": "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
        "key_state": "3"
    }
}

    或

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

状态码

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

状态码

编码

状态说明

200

OK

请求已成功。

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

父主题： API说明