华为云用户手册

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 key_id String 密钥ID key_state String 密钥状态： 2为启用状态 3为禁用状态 4为计划删除状态 5为等待导入状态 7为冻结状态 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表6 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表8 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表10 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 404 表11 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表12 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 500 表13 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表14 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 502 表15 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表16 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 504 表17 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表18 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 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

响应示例 状态码： 200 请求已成功 { "event" : { "name" : "event-test", "event_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e", "state" : "ENABLED", "event_types" : [ "SECRET_VERSION_EXPIRED" ], "create_time" : 1581507580000, "update_time" : 1581507580000, "notification" : { "target_type" : " SMN ", "target_id" : "urn:smn:cn-north-4:SecertExpirationTest", "target_name" : "SecertExpirationNotificationTest" } } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 event Event object 事件通知对象。 表4 Event 参数 参数类型 描述 name String 事件通知名称。 event_id String 事件通知的资源标识符。 event_types Array of strings 设置事件的基础事件类型列表,。 约束：数组大小：最小1，最大12。 state String 事件通知状态，取值如下。 ENABLED：表示启用状态 DISABLED：表示禁用状态 create_time Long 事件通知创建时间，时间戳，即从1970年1月1日至该时间的总秒数。 update_time Long 事件通知上次更新时间，时间戳，即从1970年1月1日至该时间的总秒数。 notification Notification object 通知主题对象。 表5 Notification 参数 参数类型 描述 target_type String 事件通知的对象类型。 target_id String 事件通知的对象ID。 target_name String 事件通知的对象名称。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表7 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表9 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 403 表10 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表11 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 404 表12 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表13 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 500 表14 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表15 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 502 表16 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表17 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 504 表18 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表19 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 502 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 504 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表4 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表6 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表8 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表10 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表12 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 502 表13 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表14 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 504 表15 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表16 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息

加密密钥管理 权限 对应API接口 授权项（Action） 依赖的授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 创建密钥 POST /v1.0/{project_id}/kms/create-key kms:cmk:create - √ √ 启用密钥 POST /v1.0/{project_id}/kms/enable-key kms:cmk:enable - √ √ 禁用密钥 POST /v1.0/{project_id}/kms/disable-key kms:cmk:disable - √ √ 计划删除密钥 POST /v1.0/{project_id}/kms/schedule-key-deletion kms:cmk:update - √ √ 取消计划删除密钥 POST /v1.0/{project_id}/kms/cancel-key-deletion kms:cmk:update - √ √ 查询密钥列表 POST /v1.0/{project_id}/kms/list-keys kms:cmk:list - √ √ 查询密钥信息 POST /v1.0/{project_id}/kms/describe-key kms:cmk:get - √ √ 创建随机数 POST /v1.0/{project_id}/kms/gen-random kms:cmk:generate - √ × 创建数据密钥 POST /v1.0/{project_id}/kms/create-datakey kms:dek:create - √ √ 创建不含明文数据密钥 POST /v1.0/{project_id}/kms/create-datakey-without-plaintext kms:dek:create - √ √ 加密数据密钥 POST /v1.0/{project_id}/kms/encrypt-datakey kms:dek:crypto - √ √ 解密数据密钥 POST /v1.0/{project_id}/kms/decrypt-datakey kms:dek:crypto - √ √ 查询实例数 GET /v1.0/{project_id}/kms/user-instances kms:cmk:getInstance - √ × 查询配额 GET /v1.0/{project_id}/kms/user-quotas kms:cmk:getQuota - √ × 修改密钥别名 POST /v1.0/{project_id}/kms/update-key-alias kms:cmk:update - √ √ 修改密钥描述 POST /v1.0/{project_id}/kms/update-key-description kms:cmk:update - √ √ 创建授权 POST /v1.0/{project_id}/kms/create-grant kms:grant:create - √ √ 撤销授权 POST /v1.0/{project_id}/kms/revoke-grant kms:grant:revoke - √ √ 退役授权 POST /v1.0/{project_id}/kms/retire-grant kms:grant:retire - √ √ 查询授权列表 POST /v1.0/{project_id}/kms/list-grants kms:grant:list - √ × 查询可退役授权列表 POST /v1.0/{project_id}/kms/list-retirable-grants kms:grant:list - √ × 加密数据 POST /v1.0/{project_id}/kms/encrypt-data kms:cmk:crypto - √ √ 解密数据 POST /v1.0/{project_id}/kms/decrypt-data kms:cmk:crypto - √ √ 获取密钥导入参数 POST /v1.0/{project_id}/kms/get-parameters-for-import kms:cmk:getMaterial - √ √ 导入密钥材料 POST /v1.0/{project_id}/kms/import-key-material kms:cmk:importMaterial - √ √ 删除密钥材料 POST /v1.0/{project_id}/kms/delete-imported-key-material kms:cmk:deleteMaterial - √ √ 开启密钥轮换 POST /v1.0/{project_id}/kms/enable-key-rotation kms:cmk:enableRotation - √ √ 修改密钥轮换周期 POST /v1.0/{project_id}/kms/update-key-rotation-interval kms:cmk:updateRotation - √ √ 关闭密钥轮换 POST /v1.0/{project_id}/kms/disable-key-rotation kms:cmk:disableRotation - √ √ 查询密钥轮换状态 POST /v1.0/{project_id}/kms/get-key-rotation-status kms:cmk:getRotation - √ √ 查询密钥实例 POST /v1.0/{project_id}/kms/resource_instances/action kms:cmkTag:listInstance - √ √ 查询密钥标签 GET /v1.0/{project_id}/kms/{key_id}/tags kms:cmkTag:list - √ √ 查询项目标签 GET /v1.0/{project_id}/kms/tags kms:cmkTag:list - √ × 批量添加删除密钥标签 POST /v1.0/{project_id}/kms/{key_id}/tags/action kms:cmkTag:batch - √ √ 添加密钥标签 POST /v1.0/{project_id}/kms/{key_id}/tags kms:cmkTag:create - √ √ 删除密钥标签 POST /v1.0/{project_id}/kms/{key_id}/tags/{key} kms:cmkTag:delete - √ √ 创建专属密钥库 /v1.0/{project_id}/keystores/ kms:keystore:create - √ × 删除专属密钥库 /v1.0/{project_id}/keystores/{keystore_id} kms:keystore:delete - √ × 启用专属密钥库 /v1.0/{project_id}/keystores/{keystore_id}/enable kms:keystore:enable - √ × 禁用专属密钥库 /v1.0/{project_id}/keystores/{keystore_id}/disable kms:keystore:disable - √ × 查询专属密钥库列表 /v1.0/{project_id}/keystores/ kms:keystore:list - √ × 获取专属密钥库 /v1.0/{project_id}/keystores/{keystore_id} kms:keystore:get - √ × 父主题： 权限和授权项

示例 请求样例 无 响应样例 { "keypair": { "created_at": "2014-05-07T12:06:13.681238", "deleted": false, "deleted_at": null, "fingerprint": "9d:00:f4:d7:26:6e:52:06:4c:c1:d3:1d:fd:06:66:01", "id": 1, "name": "keypair-3582d8b7-e588-4aad-b7f7-f4e76f0e4314", "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDYJrTVpcMwFqQy/oMvtUSRofZdSRHEwrsX8AYkRvn2ZnCXM+b6+GZ2NQuuWj+ocznlnwiGFQDsL/yeE+/kurqcPJFKKp60mToXIMyzioFxW88fJtwEWawHKAclbHWpR1t4fQ4DS+/sIbX/Yd9btlVQ2tpQjodGDbM9Tr9/+/3i6rcR+EoLqmbgCgAiGiVV6VbM2Zx79yUwd+GnQejHX8BlYZoOjCnt3NREsITcmWE9FVFy6TnLmahs3FkEO/QGgWGkaohAJlsgaVvSWGgDn2AujKYwyDokK3dXyeX3m2Vmc3ejiqPa/C4nRrCOlko5nSgV/9IXRx1ERImsqZnE9usB Generated-by-Nova\n", "updated_at": null, "user_id": "fake", "is_key_protection": true, "description": "keypair test" } } 或 { "error_code": "KPS.XXXX", "error_msg": "XXXX" }

响应消息 表2 响应参数 参数 是否必选 参数类型 描述 keypair 是 Object SSH密钥对信息，详情请参见表3。 表3 keypair字段数据结构说明 参数 是否必选 参数类型 描述 public_key 是 String SSH密钥对对应的publicKey信息。 name 是 String SSH密钥对的名称。 fingerprint 是 String SSH密钥对对应的指纹信息。 created_at 是 String SSH密钥对创建的时间。时间戳，即从1970年1月1日至该时间的总秒数。 deleted 是 Boolean SSH密钥对删除的标记。 deleted_at 是 String SSH密钥对删除的时间。时间戳，即从1970年1月1日至该时间的总秒数。 id 是 String SSH密钥对的ID。 updated_at 是 String SSH密钥对的更新时间。时间戳，即从1970年1月1日至该时间的总秒数。 user_id 是 String SSH密钥对所属的用户信息。 is_key_protection 是 Boolean SSH密钥对是否私钥托管与保护。 description 是 String SSH密钥对的描述信息

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 key_id String 密钥ID key_state String 密钥状态： 2为启用状态 3为禁用状态 4为计划删除状态 5为等待导入状态 7为冻结状态 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表6 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表8 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表10 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 404 表11 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表12 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 500 表13 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表14 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 502 表15 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表16 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 504 表17 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表18 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 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。 pending_days 是 String 计划多少天后删除密钥，取值为7到1096。 sequence 否 String 请求消息序列号，36字节序列号。 例如：919c82d4-8046-4722-9094-35c3c6524cff

历史全局 全局分类 说明 管理SSH密钥对(V2.1) 查询SSH密钥对列表。 查询SSH密钥对详细信息。 创建SSH密钥对和导入SSH密钥对，同时可选择对私钥进行托管。 根据SSH密钥对的名称，删除指定SSH密钥对。 根据SSH密钥对的名称，修改指定SSH密钥对的描述信息。 管理SSH密钥对(V2.0) 查询SSH密钥对信息列表。 根据SSH密钥对的名称查询指定SSH密钥对。 创建SSH密钥对，或把公钥导入华为云中，生成SSH密钥对。 创建SSH密钥对成功后，请把响应数据中的私钥内容保存到本地文件，单用户使用该私钥登录云服务器。为保证云服务器安全，私钥数据只能下载一次，请妥善保管。 根据SSH密钥对的名称，删除指定SSH密钥对。 在同一个租户下可能包含多个单用户账号，将同一租户下目标单用户账号下的密钥对复制到当前单用户账号下。

管理SSH密钥对 类型 名称 说明 配额 密钥对管理 创建和导入SSH密钥对 创建和导入SSH密钥对。 单用户300次/分钟 全局4800次/分钟 清除私钥 清除SSH密钥对私钥。 查询SSH密钥对列表 查询SSH密钥对列表。 基础流控： 单用户160次/秒 全局 200次/秒 应用160次/秒 IP 160次/秒 查询SSH密钥对详细信息 查询SSH密钥对详细信息。 删除SSH密钥对 删除SSH密钥对。 单用户300次/分钟 全局4800次/分钟 更新SSH密钥对描述 更新SSH密钥对描述。 导入私钥 导入私钥到指定密钥对。 导出私钥 导出指定密钥对的私钥。 密钥对任务管理 绑定SSH密钥对 给指定的虚拟机绑定（替换或重置，替换需提供虚拟机已配置的SSH密钥对私钥；重置不需要提供虚拟机的SSH密钥对私钥）新的SSH密钥对。 单用户300次/分钟 全局4800次/分钟 解绑SSH密钥对 给指定的虚拟机解除绑定SSH密钥对并恢复SSH密码登录。 批量绑定SSH密钥对 给指定的虚拟机批量绑定新的SSH密钥对。 基础流控： 单用户10次/分钟 全局 20次/分钟 应用10次/分钟 IP 10次/分钟 查询任务信息 根据SSH密钥对接口返回的task_id，查询SSH密钥对当前任务的执行状态。 单用户300次/分钟 全局4800次/分钟 查询正在处理的任务信息 查询正在处理的任务信息。 查询失败的任务信息 查询绑定、解绑等操作失败的任务信息。 删除所有失败的任务 删除操作失败的任务信息。 删除失败的任务 删除失败的任务。

凭据管理服务 类型 名称 说明 配额 生命周期管理 创建凭据 创建新的凭据，并将凭据值存入凭据的初始版本。 单用户300次/分钟 全局4800次/分钟 查询凭据列表 查询当前用户在本项目下创建的所有凭据。 单用户100次/秒 全局 200次/秒 查询凭据 查询指定凭据的信息。 单用户1200次/分钟 全局 4800次/分钟 更新凭据 更新指定凭据的元数据信息。 单用户300次/分钟 全局4800次/分钟 立即删除凭据 立即删除指定的凭据，且无法恢复。 恢复凭据对象 通过上传凭据备份文件，恢复凭据对象。 下载凭据备份 下载指定凭据的备份文件。 创建凭据的定时删除任务 指定延迟删除时间，创建删除凭据的定时任务，可设置7~30天的的延迟删除时间。 取消凭据的定时删除任务 取消凭据的定时删除任务，凭据对象恢复可使用状态。 轮转凭据 立即执行轮转凭据。在指定的凭据中，创建一个新的凭据版本，用于加密存储后台随机产生的凭据值。同时将新创建的凭据版本标记为SYSCURRENT状态。 凭据版本管理 创建凭据版本 在指定的凭据中，创建一个新的凭据版本，用于加密保管新的凭据值。默认情况下，新创建的凭据版本被标记为SYSCURRENT状态，而SYSCURRENT标记的前一个凭据版本被标记为SYSPREVIOUS状态。您可以通过指定VersionStage参数来覆盖默认行为。 基础流控： 单用户80次/秒 全局 200次/秒 应用80次/秒 IP 80次/秒 查询凭据的版本列表 查询指定凭据下的版本列表信息。 单用户300次/分钟 全局4800次/分钟 更新凭据版本 当前支持更新指定凭据版本的有效期，只能更新ENABLED状态的凭据。在关联订阅的事件包含“版本过期”基础事件类型时，每次更新版本有效期后仅会触发一次事件通知。 查询凭据的版本与凭据值 查询指定凭据版本的信息和版本中的明文凭据值，只能查询ENABLED状态的凭据。 通过/v1/{project_id}/secrets/{secret_name}/versions/latest （即将当前接口URL中的{version_id}赋值为latest）可访问凭据最新版本的凭据值。 基础流控： 单用户160次/秒 全局 200次/秒 应用160次/秒 IP 160次/秒 凭据版本状态管理 更新凭据的版本状态 更新凭据的版本状态。 单用户300次/分钟 全局4800次/分钟 查询凭据的版本状态 查询指定凭据版本状态标记的版本信息。 删除凭据的版本状态 删除指定的凭据版本状态。 凭据标签管理 查询凭据实例 查询凭据实例。通过标签过滤，筛选用户凭据，返回凭据列表。 单用户300次/分钟 全局4800次/分钟 批量添加或删除凭据标签 批量添加或删除凭据标签。 查询凭据标签 查询凭据标签。 添加凭据标签 添加凭据标签。 删除凭据标签 删除凭据标签。 查询项目标签 查询用户在指定项目下的所有凭据标签集合。 事件管理 创建事件 创建事件，事件可配置在一个或多个凭据对象上。当事件为启用状态且包含的基础事件类型在凭据对象上触发时，云服务会将对应的事件通知发送至事件指定的通知主题上。 单用户300次/分钟 全局4800次/分钟 查询事件 查询指定事件的信息。 查询事件列表 查询当前用户在本项目下创建的所有事件。 更新事件 更新指定事件的元数据信息。支持更新的元数据包含事件启用状态、基础类型列表、通知主题。 立即删除事件 立即删除指定的事件，且无法恢复。如事件存在凭据引用，则无法删除，请先解除关联。 查询已触发的事件通知记录 查询三个月内所有已触发的事件通知记录。

管理加密密钥 类型 名称 说明 性能参数 查询全局版本信息 查询版本信息列表 查询API版本信息列表。 - 查询指定版本信息 查指定API版本信息。 生命周期管理 创建密钥 创建用户主密钥，用户主密钥可以为对称密钥或非对称密钥。 单用户20次/秒 全局100次/秒 启用密钥 启用密钥，密钥启用后才可以使用。 禁用密钥 禁用密钥，密钥禁用后不可以使用。 计划删除密钥 计划删除一个指定密钥，可设置7天～1096天内删除密钥。密钥将被彻底删除后，使用该密钥加密的数据将无法解密。 取消计划删除密钥 取消计划删除密钥，取消后，用户可以正常使用该密钥。 修改密钥别名 修改用户主密钥别名。 修改密钥描述 修改用户主密钥描述信息。 数据密钥管理 创建随机数 生成8~8192bit范围内的随机数。 单用户800次/秒 全局1000次/秒 创建数据密钥 创建数据密钥，返回结果包含明文和密文。 创建不含明文数据密钥 创建数据密钥，返回结果只包含密文。 加密数据密钥 使用指定的用户主密钥加密数据密钥。 加密数据密钥 使用指定的用户主密钥解密数据密钥。 导入密钥管理 获取密钥导入参数 获取导入密钥的必要参数，包括密钥导入令牌和密钥加密公钥。 单用户20次/秒 全局100次/秒 导入密钥材料 导入指定密钥的密钥材料。 删除密钥材料 删除指定密钥的密钥材料。 授权管理 创建授权 被授权用户可以对授权密钥进行操作。 单用户20次/秒 全局100次/秒 撤销授权 授权用户撤销被授权用户操作密钥的权限。 退役授权 被授权用户不再具有授权密钥的操作权。 查询授权列表 查询密钥的授权列表。 查询可退役授权列表 查询用户可以退役的授权列表。 小数据加解密 加密数据 使用指定的用户主密钥加密数据。 单用户20次/秒 全局100次/秒 解密数据 解密数据。 签名验签 签名数据 使用非对称密钥的私钥对消息或消息摘要进行数字签名。 单用户300次/秒 全局500次/秒 验证签名 使用非对称密钥的公钥对消息或消息摘要进行签名验证。 轮换管理 开启密钥轮换 开启用户主密钥轮换，默认主密钥及外部导入密钥不支持轮换操作。 单用户20次/秒 全局100次/秒 关闭密钥轮换 关闭用户主密钥轮换。 修改密钥轮换周期 修改用户主密钥轮换周期。 查询密钥轮换状态 查询用户主密钥轮换状态。 标签管理 查询密钥实例 通过标签过滤，查询指定用户主密钥的详细信息。 单用户20次/秒 全局100次/秒 查询密钥标签 查询指定密钥的标签信息。 查询项目标签 查询用户在指定项目下的所有标签集合。 批量添加删除密钥标签 批量添加或删除密钥标签。 添加密钥标签 添加密钥标签。 删除密钥标签 删除密钥标签。 查询接口 查询密钥列表 查询用户所有密钥列表。 单用户160次/秒 全局200次/秒 查询密钥信息 查询指定密钥的详细信息。 查询实例数 获取用户已经创建的用户主密钥数量，不包含默认主密钥。 单用户80次/秒 全局200次/秒 查询配额 查询用户可以创建的用户主密钥配额总数及当前使用量信息，不包含默认主密钥。 专属密钥库管理 创建专属密钥库 创建租户专属密钥库，专属密钥库使用DHSM实例作为密钥的存储。 单用户20次/秒 全局100次/秒 查询专属密钥库列表 查询租户专属密钥库列表。 获取专属密钥库 获取租户专属密钥库。 删除专属密钥库 删除租户专属密钥库。 启用专属密钥库 启用租户专属密钥库。 禁用专属密钥库 禁用租户专属密钥库。

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表4 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表6 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表8 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表10 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表12 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 502 表13 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表14 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 504 表15 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表16 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息

响应示例 状态码： 200 查指定API版本信息 { "version" : { "min_version" : "", "links" : [ { "rel" : "self", "href" : "https://kms.region_id.domain.com/v1.0/" } ], "id" : "v1.0", "version" : "", "updated" : "2016-10-29T02:00:00Z", "status" : "CURRENT" } }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 version Object 描述version 对象的列表，详情请参见 ApiVersionDetail字段数据结构说明。 表3 ApiVersionDetail 参数 参数类型 描述 id String 版本ID（版本号），如“v1.0”。 links Array of ApiLink objects JSON对象，详情请参见links字段数据结构说明。 version String 若该版本API支持微版本，则填支持的最大微版本号，如果不支持微版本，则返回空字符串。 status String 版本状态，包含如下3种： CURRENT：表示该版本为主推版本。 SUPPORTED：表示为老版本，但是现在还继续支持。 DEPRECATED：表示为废弃版本，存在后续删除的可能。 updated String 版本发布时间，要求用UTC时间表示。如v1.发布的时间2014-06-28T12:20:21Z。 min_version String 若该版本API 支持微版本，则填支持的最小微版本号，如果不支持微版本，则返回空字符串。 表4 ApiLink 参数 参数类型 描述 href String API的URL地址。 rel String 默认值self。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表6 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 502 表7 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表8 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 504 表9 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表10 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 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_description 是 String 密钥描述，取值0到255字符。 sequence 否 String 请求消息序列号，36字节序列号。 例如：919c82d4-8046-4722-9094-35c3c6524cff

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 key_info KeyDescriptionInfo object 密钥描述信息。 表5 KeyDescriptionInfo 参数 参数类型 描述 key_id String 密钥ID。 key_description String 密钥描述。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表7 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表9 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 403 表10 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表11 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 404 表12 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表13 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 500 表14 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表15 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 502 表16 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表17 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 504 表18 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表19 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息

响应参数 状态码： 202 表6 响应Body参数 参数 参数类型 描述 task_id String 任务下发成功返回的ID。 server_id String 绑定的虚拟机id。 status String 任务下发的状态。SUC CES S或FAILED。 error_code String 任务下发失败返回的错误码。 error_msg String 任务下发失败返回的错误信息。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求示例 { "keypair_name" : "newkeypair1", "server" : { "id" : "d76baba7-ef09-40a2-87ff-3eafec0696e7", "auth" : { "type" : "keypair", "key" : "-----BEGINRSAPRIVATEKEY-----M..." } } } { "keypair_name" : "newkeypair2", "server" : { "id" : "d76baba7-ef09-40a2-87ff-3eafec0696e7" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 keypair_name 是 String SSH密钥对的名称 server 是 EcsServerInfo object 需要绑定密钥对的虚拟机信息。 表4 EcsServerInfo 参数 是否必选 参数类型 描述 id 是 String 需要绑定(替换或重置)SSH密钥对的虚拟机id auth 否 Auth object 可选字段，鉴权认证类型。替换时需要该参数，重置时不需要该参数。 disable_password 否 Boolean true：禁用虚拟机的ssh登录。 false：不禁用虚拟机的ssh登录。 port 否 Long SSH监听端口。 表5 Auth 参数 是否必选 参数类型 描述 type 否 String 取值为枚举类型。password或keypair。 key 否 String type为枚举值password时，key表示密码； type为枚举值keypair时，key表示私钥；

响应示例 状态码： 200 请求已成功 { "grants" : [ { "operations" : [ "create-datakey", "describe-key" ], "issuing_principal" : "8b961fb414344d59825ba0c8c008c815", "key_id" : "737fd52b-36c4-4c91-972e-f6e202de9f6e", "grant_id" : "dd3f03e9229a5e47a41be6c27a630e60d5cbdbad2be89465d63109ad034db7d8", "grantee_principal" : "13gg44z4g2sglzk0egw0u726zoyzvrs8", "name" : "13gg44z4g2sglzk0egw0u726zoyzvrs8", "creation_date" : "1597062260000", "grantee_principal_type" : "user" } ], "next_marker" : "", "total" : 1, "truncated" : "false" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 limit 否 String 指定查询可退役授权返回记录条数，如果查询记录条数小于存在的条数，响应参数“truncated”将返回“true”，表示存在分页。 取值在授权最大个数范围以内。例如：100 marker 否 String 分页查询起始位置标识。 分页查询收到的响应参数“truncated”为“true”时，可以发送连续的请求获取更多的记录条数，“marker”设置为响应的“next_marker”的值。例如：10。 sequence 否 String 请求消息序列号，36字节序列号。 例如：919c82d4-8046-4722-9094-35c3c6524cff

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 grants Array of Grants objects grant列表，详情请参见grants字段数据结构说明。 next_marker String 获取下一页所需要传递的marker值。 当“truncated”为“false”时，“next_marker”为空。 total Integer 可退役授权总条数。 truncated String 是否还有下一页： “true”表示还有数据。 “false”表示已经是最后一页。 表5 Grants 参数 参数类型 描述 key_id String 密钥ID。 grant_id String 授权ID，64字节。 grantee_principal String 被授权用户ID，1~64字节，满足正则匹配“^[a-zA-Z0-9]{1，64}$”。 例如：0d0466b00d0466b00d0466b00d0466b0 grantee_principal_type String 授权类型。 有效值：“user”，“domain”。 operations Array of strings 授权允许的操作列表。 有效的值：“create-datakey”，“create-datakey-without-plaintext”，“encrypt-datakey”，“decrypt-datakey”，“describe-key”，“create-grant”，“retire-grant”，“encrypt-data”，“decrypt-data”。 有效值不能仅为“create-grant”。 “create-datakey” 创建数据密钥 “create-datakey-without-plaintext” 创建不含明文数据密钥 “encrypt-datakey” 加密数据密钥 “decrypt-datakey” 解密数据密钥 “describe-key” 查询密钥信息 “retire-grant” 退役授权 “encrypt-data” 加密数据 “decrypt-data” 解密数据 issuing_principal String 创建授权用户ID，1~64字节，满足正则匹配“^[a-zA-Z0-9]{1，64}$”。 例如：0d0466b00d0466b00d0466b00d0466b0 creation_date String 创建时间，时间戳，即从1970年1月1日至该时间的总秒数。 例如：1497341531000 name String 授权名字，取值1到255字符，满足正则匹配“^[a-zA-Z0-9:/_-]{1,255}$”。 retiring_principal String 可退役授权的用户ID，1~64字节，满足正则匹配“^[a-zA-Z0-9]{1，64}$”。 例如：0d0466b00d0466b00d0466b00d0466b0 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表7 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表9 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 403 表10 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表11 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 404 表12 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表13 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 500 表14 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表15 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 502 表16 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表17 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 504 表18 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表19 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表4 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表6 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表8 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表10 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表12 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 502 表13 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表14 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 504 表15 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表16 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息

请求示例 使用ID为“0d0466b0-e727-4d9c-b35d-f84bb474a37f”的用户主密钥加密明文数据“hello world”， 数据加密 算法为"SYMMETRIC_DEFAULT"。 { "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "plain_text" : "hello world", "encryption_algorithm" : "SYMMETRIC_DEFAULT" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 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。 plain_text 是 String 明文数据，1~4096字节，满足正则匹配“^.{1,4096}$”，且转化为byte数组后长度取值范围为1~4096字节。 encryption_algorithm 否 String 数据加密算法，仅使用非对称密钥需要指定该参数，默认值为“SYMMETRIC_DEFAULT”，合法枚举值如下： SYMMETRIC_DEFAULT RSAES_OAEP_SHA_256 SM2_ENCRYPT sequence 否 String 请求消息序列号，36字节序列号。 例如：919c82d4-8046-4722-9094-35c3c6524cff

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 key_id String 密钥ID。 cipher_text String 加密后的密文，使用了Base64编码 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表6 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表8 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表10 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 404 表11 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表12 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 500 表13 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表14 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 502 表15 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表16 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 504 表17 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表18 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息