更新凭据的版本状态 功能介绍 更新凭据的版本状态。 接口约束 凭据的版本状态在同一凭据对象下仅能唯一标识一个版本,将版本状态设置到新版本上的同时,将自动从老版本上移除其对应的版本状态。没有任何版本状态标识的版本将被视为已弃用,可由凭据管理服务自动删除。 凭据管理服务的每个凭据中最多可支持
查询凭据标签 功能介绍 查询凭据标签。 调用方法 请参见如何调用API。 URI GET /v1/{project_id}/csms/{secret_id}/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID secret_id
删除密钥材料 功能介绍 功能介绍:删除密钥材料信息。 接口约束 导入的非对称密钥不支持删除密钥材料。若要删除非对称密钥,请使用计划删除密钥功能。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/kms/delete-imported-key-material
禁用密钥 功能介绍 功能介绍:禁用密钥,密钥禁用后不可以使用。 说明:密钥为启用状态才能禁用密钥。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/kms/disable-key 表1 路径参数 参数 是否必选 参数类型 描述 project_id
修改密钥轮换周期 功能介绍 功能介绍:修改用户主密钥轮换周期。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/kms/update-key-rotation-interval 表1 路径参数 参数 是否必选 参数类型 描述 project_id
启用密钥 功能介绍 功能介绍:启用密钥,密钥启用后才可以使用。 说明:密钥为禁用状态才能启用密钥。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/kms/enable-key 表1 路径参数 参数 是否必选 参数类型 描述 project_id
更新凭据版本 功能介绍 当前支持更新指定凭据版本的有效期,只能更新ENABLED状态的凭据。在关联订阅的事件包含“版本过期”基础事件类型时,每次更新版本有效期后仅会触发一次事件通知。 调用方法 请参见如何调用API。 URI PUT /v1/{project_id}/secrets
计划删除密钥 功能介绍 功能介绍:计划多少天后删除密钥,可设置7天~1096天内删除密钥。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/kms/schedule-key-deletion 表1 路径参数 参数 是否必选 参数类型 描述
查询事件 功能介绍 查询指定事件的信息。 接口约束 此接口返回的信息为凭据事件通知的元数据信息值。 调用方法 请参见如何调用API。 URI GET /v1/{project_id}/csms/events/{event_name} 表1 路径参数 参数 是否必选 参数类型 描述
取消计划删除密钥 功能介绍 功能介绍:取消计划删除密钥。 说明:密钥处于“计划删除”状态才能取消计划删除密钥。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/kms/cancel-key-deletion 表1 路径参数 参数 是否必选
关闭密钥轮换 功能介绍 功能介绍:关闭用户主密钥轮换。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/kms/disable-key-rotation 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
创建凭据版本 功能介绍 在指定的凭据中,创建一个新的凭据版本,用于加密保管新的凭据值。默认情况下,新创建的凭据版本被标记为SYSCURRENT状态,而SYSCURRENT标记的前一个凭据版本被标记为SYSPREVIOUS状态。您可以通过指定VersionStage参数来覆盖默认行为
查询事件列表 功能介绍 查询当前用户在本项目下创建的所有事件。 接口约束 此接口返回的信息为事件通知的元数据信息,不包含凭据值。 调用方法 请参见如何调用API。 URI GET /v1/{project_id}/csms/events 表1 路径参数 参数 是否必选 参数类型 描述
查询公钥信息 功能介绍 查询用户指定非对称密钥的公钥信息。 接口约束 对称密钥无法使用该操作进行查询。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/kms/get-publickey 表1 路径参数 参数 是否必选 参数类型 描述 project_id
查询凭据 功能介绍 查询指定凭据的信息。 接口约束 此接口返回的信息为凭据的元数据信息,不包含凭据值。 调用方法 请参见如何调用API。 URI GET /v1/{project_id}/secrets/{secret_name} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
创建凭据的定时删除任务 功能介绍 指定延迟删除时间,创建删除凭据的定时任务,可设置7~30天的的延迟删除时间。 接口约束 处于“定时删除”状态的凭据对象无法更新元数据信息,也无法查看凭据值。 调用方法 请参见如何调用API。 URI POST /v1/{project_id}/secrets
修改密钥别名 功能介绍 功能介绍:修改用户主密钥别名。 说明: 服务默认主密钥(密钥别名后缀为“/default”)不可以修改。 密钥处于“计划删除”状态,密钥别名不可以修改。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/kms/update-key-alias
获取密钥导入参数 功能介绍 功能介绍:获取导入密钥的必要参数,包括密钥导入令牌和密钥加密公钥。 说明:返回的公钥类型默认为RSA_2048。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/kms/get-parameters-for-import
解密数据 功能介绍 功能介绍:解密数据。 接口约束 解密非对称密钥加密的数据时,需要指定密钥ID和加密算法。如果指定的密钥和加密算法与用于加密数据的值不匹配,解密操作将失败。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/kms/decrypt-data
查询密钥轮换状态 功能介绍 功能介绍:查询用户主密钥轮换状态。 调用方法 请参见如何调用API。 URI POST /v1.0/{project_id}/kms/get-key-rotation-status 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是