KMS提供的API接口列表及相关描述_密钥管理服务(KMS)-阿里云帮助中心

本文列出了KMS提供的API接口列表及相关描述。

服务管理

API	描述
DescribeRegions	查询当前阿里云账号的可用地域列表。
OpenKmsService	为当前阿里云账号开通密钥管理服务。
DescribeAccountKmsStatus	查询当前阿里云账号的密钥管理服务状态。

实例管理

API	描述
ConnectKmsInstance	启用一个KMS实例。
GetKmsInstance	查询一个KMS实例的详情。
ListKmsInstances	查询KMS实例列表。
UpdateKmsInstanceBindVpc	更新KMS实例配置的VPC。

密钥管理

密钥管理接口用于密钥、别名的创建、删除等管理操作。

API	描述
CreateKey	创建密钥。用户可以选择由KMS生成密钥材料，也可以选择自己上传密钥材料（即BYOK方式）。
GetParametersForImport	用于在创建外部密钥（BYOK）时，获取将密钥材料导入密钥时所需的参数。
ImportKeyMaterial	用于在创建外部密钥（BYOK）时，将密钥材料导入密钥。
EnableKey	修改密钥的状态为启用。
DisableKey	修改密钥的状态为禁用。
DescribeKey	查询指定密钥的信息。
ListKeys	查询阿里云账号在调用地域的所有密钥。
UpdateKeyDescription	更新密钥的描述信息。
CreateAlias	创建一个别名，并且将别名与一个密钥绑定。
UpdateAlias	更新已存在的别名所代表的密钥ID。
DeleteAlias	删除别名。
ListAliases	查询阿里云账号在调用地域的所有别名。
ListAliasesByKeyId	查询与指定密钥绑定的别名。
SetDeletionProtection	为密钥开启或关闭删除保护。
ScheduleKeyDeletion	计划删除密钥。将密钥的状态设置为待删除状态，处于待删除状态的密钥，会在计划日期到期后删除。
CancelKeyDeletion	取消计划删除。处于待删除状态的密钥，在计划的日期到期之前，可以取消删除的计划，重新设置密钥状态为启用。
DeleteKeyMaterial	删除密钥材料。重要仅支持删除默认密钥（主密钥）中的外部密钥材料。
CreateKeyVersion	为密钥创建新的密钥版本。仅软件密钥管理实例中的对称密钥支持。说明如果您的密钥不是在KMS实例中创建的密钥，则该操作仅非对称密钥支持。
DescribeKeyVersion	查询指定密钥版本信息。
ListKeyVersions	查询密钥的所有密钥版本。
UpdateRotationPolicy	更新密钥的轮转策略。如果配置密钥自动轮转，KMS将周期性自动生成新的密钥版本。

密码运算

密码运算接口用于对数据进行密码运算，例如使用KMS中的密钥对数据进行加密、生成数据密钥、解密、计算数字签名。

重要

使用KMS密钥管理实例中的密钥进行密码运算，请使用KMS实例API。具体信息，请参见KMS实例API概览。

凭据管理

凭据管理

KMS提供凭据的托管、保护、分发和轮转能力。

API	描述
CreateSecret	创建凭据，并存入凭据的初始版本。
ListSecrets	查询当前阿里云账号在调用地域的所有凭据。
DescribeSecret	获取凭据的元数据信息。
UpdateSecret	更新凭据的元数据。
PutSecretValue	为凭据存入一个新版本的凭据值。说明仅通用凭据支持。
UpdateSecretVersionStage	更新凭据的版本状态。说明仅通用凭据支持。
DeleteSecret	计划删除或直接删除凭据。
RestoreSecret	恢复计划删除中的凭据。
ListSecretVersionIds	查询凭据的所有版本信息。
GetRandomPassword	获得一个随机密码串。
RotateSecret	手动轮转凭据。
UpdateSecretRotationPolicy	更新凭据轮转策略。

获取凭据值
GetSecretValue：获取凭据值。
重要
KMS实例API中也提供获取凭据值接口（GetSecretValue），具体调用的哪个API依赖于您使用的SDK。关于如何选择SDK，请参见SDK使用指引。

标签管理

您可以为密钥或凭据添加多个标签，每一个标签为一组标签键（TagKey）和标签值（TagValue）。

说明

TagResource、UntagResource、ListResourceTags仅支持对单个资源进行操作，TagResources、UntagResources、ListTagResources支持对多个资源进行批操作。

API	描述
TagResource	为单个密钥或者单个凭据绑定标签。
UntagResource	删除单个密钥或者单个凭据的指定标签。
ListResourceTags	查询单个密钥的所有标签。
TagResources	批量为密钥或凭据绑定标签。
UntagResources	批量删除密钥或者凭据的指定标签。
ListTagResources	批量查询密钥或凭据的所有标签或指定标签。

应用管理

API	描述
CreateNetworkRule	创建一条网络控制规则，设置允许访问KMS的私网IP或私网网段。
DeleteNetworkRule	删除一条网络控制规则。
DescribeNetworkRule	查询一个网络控制规则的详情。
ListNetworkRules	查询网络控制规则列表。
UpdateNetworkRule	更新一个网络控制规则。
CreatePolicy	创建一个权限策略，设置允许应用访问的密钥和凭据。
DeletePolicy	删除一个权限策略。
DescribePolicy	查询一个权限策略的详情。
UpdatePolicy	更新一个权限策略。
ListPolicies	查询权限策略列表。
CreateApplicationAccessPoint	创建一个应用接入点。
DeleteApplicationAccessPoint	删除一个应用接入点。
DescribeApplicationAccessPoint	查询一个应用接入点的详情。
ListApplicationAccessPoints	查询应用接入点列表。
UpdateApplicationAccessPoint	更新一个应用接入点信息。
CreateClientKey	创建一个应用身份凭证（ClientKey）。
DeleteClientKey	删除一个应用身份凭证（ClientKey）。
ListClientKeys	查询应用身份凭证（ClientKey）列表。
GetClientKey	获取一个应用身份凭证（ClientKey）信息。