取消凭据的定时删除任务 功能介绍 取消凭据的定时删除任务,凭据对象恢复可使用状态。 接口约束 处于“定时删除”状态的凭据,才能执行本接口。 调用方法 请参见如何调用API。 URI POST /v1/{project_id}/secrets/{secret_name}/scheduled-deleted-tasks
查询已触发的事件通知记录 功能介绍 查询三个月内所有已触发的事件通知记录。 接口约束 仅保存三个月以内的事件通知记录。 调用方法 请参见如何调用API。 URI GET /v1/{project_id}/csms/notification-records 表1 路径参数 参数 是否必选
创建密钥 功能介绍 创建用户主密钥,用户主密钥可以为对称密钥或非对称密钥。 对称密钥为长度为256位AES密钥或者128位SM4密钥,可用于小量数据的加密或者用于加密数据密钥。 非对称密钥可以为RSA密钥对或者ECC密钥对(包含SM2密钥对),可用于加解密数据、数字签名及验签。 接口约束
批量添加或删除凭据标签 功能介绍 功能介绍:批量添加或删除凭据标签。 调用方法 请参见如何调用API。 URI POST /v1/{project_id}/csms/{secret_id}/tags/action 表1 路径参数 参数 是否必选 参数类型 描述 project_id
导入密钥材料 功能介绍 功能介绍:导入密钥材料。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/kms/import-key-material 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID
修改密钥描述 功能介绍 功能介绍:修改用户主密钥描述信息。 说明: 服务默认主密钥(密钥别名后缀为“/default”)不可以修改。 密钥处于“计划删除”状态,密钥描述不可以修改。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/kms/update-key-description
批量添加删除密钥标签 功能介绍 功能介绍:批量添加删除密钥标签。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/kms/{key_id}/tags/action 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
查询凭据列表 功能介绍 查询当前用户在本项目下创建的所有凭据。 接口约束 此接口返回的信息为凭据的元数据信息,不包含凭据值。 调用方法 请参见如何调用API。 URI GET /v1/{project_id}/secrets 表1 路径参数 参数 是否必选 参数类型 描述 project_id
更新事件 功能介绍 更新指定事件的元数据信息。支持更新的元数据包含事件启用状态、基础类型列表、通知主题。 接口约束 此接口仅能修改凭据事件通知的元数据信息。 调用方法 请参见如何调用API。 URI PUT /v1/{project_id}/csms/events/{event_name
创建专属密钥库 功能介绍 "创建租户专属密钥库,专属密钥库使用DHSM实例作为密钥的存储" 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/keystores 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
修改密钥所属的主区域 功能介绍 修改密钥所属的主区域。修改后当前区域会变为副本区域。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/kms/keys/{key_id}/update-primary-region 表1 路径参数 参数 是否必选
创建数据密钥 功能介绍 功能介绍:创建数据密钥,返回结果包含明文和密文。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/kms/create-datakey 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
退役授权 功能介绍 功能介绍:退役授权,表示被授权用户不再具有授权密钥的操作权。 须知: 创建授权的用户; 授权中retiring_principal指向的用户; 当授权的操作列表中包含retire-grant时,grantee_principal指向的用户。 例如:用户A授权用户
解密数据密钥 功能介绍 功能介绍:解密数据密钥,用指定的主密钥解密数据密钥。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/kms/decrypt-datakey 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是
查询密钥信息 功能介绍 功能介绍:查询密钥详细信息。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/kms/describe-key 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 请求参数
加密数据 功能介绍 功能介绍:加密数据,用指定的用户主密钥加密数据。 接口约束 使用非对称密钥加密数据时,请记录选择的密钥ID和加密算法。解密数据时,您将需要提供相同的密钥ID和加密算法。如果指定的密钥和加密算法与用于加密数据的值不匹配,解密操作将失败。 使用对称密钥解密时,不需要提供密钥
查询可退役授权列表 功能介绍 功能介绍:查询用户可以退役的授权列表。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/kms/list-retirable-grants 表1 路径参数 参数 是否必选 参数类型 描述 project_id
创建不含明文数据密钥 功能介绍 功能介绍:创建数据密钥,返回结果只包含密文。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/kms/create-datakey-without-plaintext 表1 路径参数 参数 是否必选 参数类型
撤销授权 功能介绍 功能介绍:撤销授权,授权用户撤销被授权用户操作密钥的权限。 说明: 创建密钥的用户才能撤销该密钥授权。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/kms/revoke-grant 表1 路径参数 参数 是否必选 参数类型
复制密钥到指定区域 功能介绍 将本区域的密钥复制到指定区域。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/kms/keys/{key_id}/replicate 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String