API概览

本产品(hsm/2023-11-13)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

审计日志

API

标题

API概述

ConfigAuditLog 配置审计日志 开通或关闭审计日志、配置审计日志投递Bucket。
GetAuditLogStatus 查询审计日志开通状态 查询当前地域下审计日志开通状态。
InitializeAuditLog 初始化审计日志 授权加密服务投递日志。

镜像

API

标题

API概述

GetImage 查询镜像 查询指定镜像信息。
ListImages 查询镜像列表 查询符合条件的镜像集合。
ConfigImageRemark 配置镜像备注 修改镜像备注信息。
CopyImage 复制镜像 复制镜像到其他地域。
ExportImage 导出镜像 导出指定密码机的镜像。

备份

API

标题

API概述

EnableBackup 启用备份 将备份与指定实例绑定。
GetBackup 查询备份 查询指定备份信息。
ListBackups 查询备份列表 获取符合查询条件的备份集合。
ConfigBackupTask 配置备份任务 修改备份任务执行模式。
ResetBackup 重置备份 将备份与当前实例解绑。
ConfigBackupRemark 配置备份备注信息 配置备份的名称及备注信息。

集群

API

标题

API概述

DeleteCluster 删除集群 删除指定集群。
JoinCluster 加入集群 将集群外的一台密码机加入当前集群。
ConfigClusterSubnet 配置集群交换机 修改集群绑定的交换机列表。
SyncCluster 同步集群 同步集群内实例数据。
InitializeCluster 初始化集群 初始化集群。
SwitchClusterMaster 切换集群主密码机 将集群内一台子密码机切换为主密码机。中国内地手动同步集群不支持此接口。
ConfigClusterName 配置集群名称 修改集群名称。
LeaveCluster 移出集群 将集群内的一台密码机移出当前集群。
CreateCluster 创建集群 选择一台密码机作为主密码机创建集群。
ListClusters 查询集群列表 获取符合查询条件的集群集合。
ConfigClusterCertificate 配置集群证书 为非中国内地密码机集群配置证书。
GetCluster 查询集群 查询指定集群信息。
ConfigClusterWhitelist 配置集群白名单 修改集群可访问的白名单列表。
QuickDeployCluster 快速部署集群 快速部署集群。
RotateClusterManagedCert 轮转集群托管证书 轮转集群托管证书。
DownloadClusterManagedCert 下载集群托管证书 下载集群托管证书。

实例

API

标题

API概述

ConfigInstanceIpAddress 配置实例VPC网络地址 修改实例VPC网络地址。
RestoreInstance 恢复实例数据 使用镜像恢复实例数据。
ResetInstance 重置实例 重置实例数据。
QuickInitInstance 快速初始化实例 快速初始化实例。
ConfigInstanceWhitelist 配置实例白名单 修改实例白名单。
ResumeInstance 恢复实例 恢复停用的实例。
GetInstance 查询实例 查询指定实例信息。
PauseInstance 停用实例 停用实例。
ListInstances 查询实例列表 获取符合查询条件的实例集合。
ConfigInstanceRemark 配置实例备注 修改实例备注。

其他

API

标题

API概述

GetJob 获取异步任务 获取异步任务的详细信息。
MoveResourceGroup 移动资源所在的资源组 移动资源所在的资源组。
DescribeRegions 查询支持加密服务的区域列表 查询支持加密服务的地域。