API概览

本产品(加密服务/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配置集群白名单修改集群可访问的白名单列表。

实例

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

其他

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