更新时间:2026-09-02 GMT+08:00
分享

CLI命令参考

密钥生命周期管理

API名称

命令

描述

操作

创建密钥

hcloud KMS CreateKey

创建用户主密钥,用户主密钥可以为对称密钥或非对称密钥。

去调试

启用密钥

hcloud KMS EnableKey

  • 功能介绍:启用密钥,密钥启用后才可以使用。

去调试

禁用密钥

hcloud KMS DisableKey

  • 功能介绍:禁用密钥,密钥禁用后不可以使用。

去调试

计划删除密钥

hcloud KMS DeleteKey

  • 功能介绍:计划多少天后删除密钥,可设置7天~1096天内删除密钥。

去调试

取消计划删除密钥

hcloud KMS CancelKeyDeletion

  • 功能介绍:取消计划删除密钥。

去调试

修改密钥别名

hcloud KMS UpdateKeyAlias

  • 功能介绍:修改用户主密钥别名。

去调试

修改密钥描述

hcloud KMS UpdateKeyDescription

  • 功能介绍:修改用户主密钥描述信息。

去调试

数据密钥管理

API名称

命令

描述

操作

创建随机数

hcloud KMS CreateRandom

  • 功能介绍:

去调试

创建数据密钥

hcloud KMS CreateDatakey

  • 功能介绍:创建数据密钥,返回结果包含明文和密文。

去调试

创建不含明文数据密钥

hcloud KMS CreateDatakeyWithoutPlaintext

  • 功能介绍:创建数据密钥,返回结果只包含密文。

去调试

创建RSA数据密钥对

hcloud KMS CreateRsaDatakeyPair

  • 功能介绍:创建rsa数据密钥对,返回结果包含明文公钥和密文私钥,根据参数决定是否返回明文私钥。

去调试

创建EC数据密钥对

hcloud KMS CreateEcDatakeyPair

  • 功能介绍:创建EC数据密钥对,返回结果包含明文公钥和密文私钥,根据参数决定是否返回明文私钥。

去调试

创建PIN码

hcloud KMS CreatePin

  • 功能介绍:创建pin码。

去调试

加密数据密钥

hcloud KMS EncryptDatakey

  • 功能介绍:加密数据密钥,用指定的主密钥加密数据密钥。

去调试

解密数据密钥

hcloud KMS DecryptDatakey

  • 功能介绍:解密数据密钥,用指定的主密钥解密数据密钥。

去调试

导入密钥管理

API名称

命令

描述

操作

获取密钥导入参数

hcloud KMS CreateParametersForImport

  • 功能介绍:获取导入密钥的必要参数,包括密钥导入令牌和密钥加密公钥。

去调试

导入密钥材料

hcloud KMS ImportKeyMaterial

  • 功能介绍:导入密钥材料。

去调试

删除密钥材料

hcloud KMS DeleteImportedKeyMaterial

  • 功能介绍:删除密钥材料信息。

去调试

按需轮转密钥

hcloud KMS RotateOnDemand

用于外部密钥的密钥材料,需要用户提前导入密钥材料后才能执行轮转

去调试

密钥授权管理

API名称

命令

描述

操作

创建授权

hcloud KMS CreateGrant

  • 功能介绍:创建授权,被授权用户可以对授权密钥进行操作。

去调试

撤销授权

hcloud KMS CancelGrant

  • 功能介绍:撤销授权,授权用户撤销被授权用户操作密钥的权限。

去调试

退役授权

hcloud KMS CancelSelfGrant

  • 功能介绍:退役授权,表示被授权用户不再具有授权密钥的操作权。

去调试

查询授权列表

hcloud KMS ListGrants

  • 功能介绍:查询密钥的授权列表。

去调试

查询可退役授权列表

hcloud KMS ListRetirableGrants

  • 功能介绍:查询用户可以退役的授权列表。

去调试

小数据加解密

API名称

命令

描述

操作

加密数据

hcloud KMS EncryptData

  • 功能介绍:加密数据,用指定的用户主密钥加密数据。

去调试

解密数据

hcloud KMS DecryptData

  • 功能介绍:解密数据。

去调试

重加密

hcloud KMS ReEncrypt

将密文使用源密钥解密后,再使用指定的新密钥加密。

去调试

签名验签

API名称

命令

描述

操作

签名数据

hcloud KMS Sign

  • 功能介绍:使用非对称密钥的私钥对消息或消息摘要进行数字签名。

去调试

验证签名

hcloud KMS ValidateSignature

  • 功能介绍:使用非对称密钥的私钥对消息或消息摘要进行签名验证。

去调试

密钥协商

API名称

命令

描述

操作

派生共享密钥

hcloud KMS DeriveSharedSecret

功能介绍:派生共享密钥

去调试

密钥轮换管理

API名称

命令

描述

操作

开启密钥轮换

hcloud KMS EnableKeyRotation

  • 功能介绍:开启用户主密钥轮换。

去调试

关闭密钥轮换

hcloud KMS DisableKeyRotation

  • 功能介绍:关闭用户主密钥轮换。

去调试

修改密钥轮换周期

hcloud KMS UpdateKeyRotationInterval

  • 功能介绍:修改用户主密钥轮换周期。

去调试

查询密钥轮换状态

hcloud KMS ShowKeyRotationStatus

  • 功能介绍:查询用户主密钥轮换状态。

去调试

密钥标签管理

API名称

命令

描述

操作

查询密钥实例

hcloud KMS ListKmsByTags

  • 功能介绍:查询密钥实例。通过标签过滤,查询指定用户主密钥的详细信息。

去调试

查询密钥标签

hcloud KMS ShowKmsTags

  • 功能介绍:查询密钥标签。

去调试

添加密钥标签

hcloud KMS CreateKmsTag

  • 功能介绍:添加密钥标签。

去调试

查询项目标签

hcloud KMS ListKmsTags

  • 功能介绍:查询用户在指定项目下的所有标签集合。

去调试

批量添加删除密钥标签

hcloud KMS BatchCreateKmsTags

  • 功能介绍:批量添加删除密钥标签。

去调试

删除密钥标签

hcloud KMS DeleteTag

  • 功能介绍:删除密钥标签。

去调试

密钥查询

API名称

命令

描述

操作

查询密钥列表

hcloud KMS ListKeys

  • 功能介绍:查询用户所有密钥列表。

去调试

查询密钥信息

hcloud KMS ListKeyDetail

  • 功能介绍:查询密钥详细信息。

去调试

查询公钥信息

hcloud KMS ShowPublicKey

  • 查询用户指定非对称密钥的公钥信息。

去调试

查询实例数

hcloud KMS ShowUserInstances

  • 功能介绍:查询实例数,获取用户已经创建的用户主密钥数量。

去调试

查询配额

hcloud KMS ShowUserQuotas

  • 功能介绍:查询配额,查询用户可以创建的用户主密钥配额总数及当前使用量信息。

去调试

查询密钥API版本信息

API名称

命令

描述

操作

查询版本信息列表

hcloud KMS ShowVersions

  • 功能介绍:查询API版本信息列表。

去调试

查询指定版本信息

hcloud KMS ShowVersion

  • 功能介绍:查指定API版本信息。

去调试

专属密钥库管理

API名称

命令

描述

操作

创建专属密钥库

hcloud KMS CreateKeyStore

  • "创建租户专属密钥库,专属密钥库使用DHSM实例作为密钥的存储"

去调试

查询专属密钥库列表

hcloud KMS ListKeyStores

查询租户专属密钥库列表

去调试

获取专属密钥库

hcloud KMS ShowKeyStore

获取租户专属密钥库

去调试

删除专属密钥库

hcloud KMS DeleteKeyStore

删除租户专属密钥库

去调试

启用专属密钥库

hcloud KMS EnableKeyStore

启用租户专属密钥库

去调试

禁用专属密钥库

hcloud KMS DisableKeyStore

禁用租户专属密钥库

去调试

多区域密钥

API名称

命令

描述

操作

修改密钥所属的主区域

hcloud KMS UpdatePrimaryRegion

修改密钥所属的主区域。修改后当前区域会变为副本区域。

去调试

复制密钥到指定区域

hcloud KMS ReplicateKey

将本区域的密钥复制到指定区域。

去调试

查询跨区域密钥所支持的区域

hcloud KMS ListSupportRegions

  • 功能介绍:查询跨区域密钥所支持的区域。

去调试

消息验证码

API名称

命令

描述

操作

生成消息验证码

hcloud KMS GenerateMac

功能介绍:生成消息验证码

去调试

校验消息验证码

hcloud KMS VerifyMac

功能介绍:校验消息验证码

去调试

别名管理

API名称

命令

描述

操作

关联密钥别名

hcloud KMS AssociateAlias

关联别名。

去调试

查询密钥关联的别名

hcloud KMS ListAliases

查询一个密钥关联的所有别名

去调试

创建密钥别名

hcloud KMS CreateAlias

创建别名

去调试

删除密钥别名

hcloud KMS DeleteAlias

删除别名

去调试

密钥空间

API名称

命令

描述

操作

创建接入点

hcloud KMS CreateAccessPoint

用于创建接入点

去调试

查询接入点列表

hcloud KMS ListAccessPoint

用于查询接入点

去调试

启用接入点

hcloud KMS EnableAccessPoint

启用接入点

去调试

禁用接入点

hcloud KMS DisableAccessPoint

禁用接入点

去调试

删除接入点

hcloud KMS DeleteAccessPoint

删除接入点

去调试

下载通用接入点私钥

hcloud KMS DownloadAccessPointPrivateKey

用于下载通用接入点私钥

去调试

创建密钥策略

hcloud KMS CreateKeyPolicy

创建密钥策略

去调试

查询密钥策略列表

hcloud KMS ListKeyPolicy

查询密钥策略列表

去调试

查询密钥策略

hcloud KMS ShowKeyPolicy

查询密钥策略

去调试

删除密钥策略

hcloud KMS DeleteKeyPolicy

删除密钥策略

去调试

更新密钥策略

hcloud KMS UpdateKeyPolicy

更新密钥策略

去调试

创建密钥胶囊

hcloud KMS CreateDatakeyCapsule

创建密钥胶囊

去调试

解密密钥胶囊

hcloud KMS DecryptDatakeyCapsule

解密密钥胶囊

去调试

相关文档