API概览_密钥管理服务(KMS)-阿里云帮助中心

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

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

服务管理

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

实例管理

API	标题	API概述
ListKmsInstances	获取实例列表	查询 KMS 实例列表。
ConnectKmsInstance	连接实例并配置网络	启用一个KMS实例。
GetKmsInstance	获取实例	查询一个KMS实例的详情。
UpdateKmsInstanceBindVpc	更新实例分享VPC	更新KMS实例配置的VPC。
ReleaseKmsInstance	释放KMS按量付费实例	释放KMS按量付费实例。
GetDefaultKmsInstance	获取默认KMS实例	获取默认KMS实例。

密钥管理

API	标题	API概述
CreateKey	创建一个主密钥	创建一个主密钥。
ListKeys	查询调用者在调用地域的所有主密钥ID	查询调用者在调用地域的所有主密钥ID。
DescribeKey	返回指定主密钥（CMK）的相关信息	查询用户主密钥（CMK）详情。
UpdateKeyDescription	更新主密钥描述信息	更新主密钥的描述信息。
EnableKey	启用指定的主密钥进行加解密	启用指定的主密钥进行加解密。
DisableKey	禁用指定的主密钥（CMK）进行加解密	禁用指定的主密钥（CMK）进行加解密。
GetPublicKey	获取非对称密钥公钥	获取非对称密钥的公钥。可以在本地使用公钥进行加密、验签。
CreateAlias	给主密钥（CMK）创建一个别名	为主密钥（CMK）创建一个别名。
ListAliases	查询当前用户在当前地域的所有别名	查询当前用户在当前地域的所有别名。
ListAliasesByKeyId	查询主密钥（CMK）所有别名	查询与指定主密钥（CMK）对应的所有别名。
DeleteAlias	删除别名	删除别名。
UpdateAlias	更新主密钥（CMK）ID	更新已存在的别名所代表的主密钥（CMK）ID。
GetParametersForImport	获取导入主密钥（CMK）材料的参数	获取导入主密钥材料的参数。
ImportKeyMaterial	导入密钥材料	导入密钥材料。
DeleteKeyMaterial	删除已导入的密钥材料	删除已导入的密钥材料。
ScheduleKeyDeletion	申请删除一个指定的主密钥（CMK)	申请删除一个指定的主密钥（CMK)。
CancelKeyDeletion	撤销密钥删除	撤销密钥删除。
SetDeletionProtection	设置删除保护	为用户主密钥（CMK）开启或关闭删除保护。
UpdateRotationPolicy	更新密钥轮转策略	更新密钥的周期性自动轮转策略。
DescribeKeyVersion	查询指定密钥版本信息	查询指定密钥版本信息。
CreateKeyVersion	为主密钥创建一个新的密钥版本	为用户主密钥（CMK）创建密钥版本。
ListKeyVersions	列出主密钥的所有密钥版本	列出主密钥的所有密钥版本。
SetKeyPolicy	设置密钥策略	为KMS实例中的密钥设置密钥策略。
GetKeyPolicy	查询密钥策略	查询指定密钥的密钥策略。

密码运算

API	标题	API概述
GenerateDataKey	生成一个数据密钥	生成一个随机的数据密钥，用于本地数据加密。
GenerateAndExportDataKey	生成一个数据密钥并加密导出	随机生成一个数据密钥，通过您指定的主密钥（CMK）和公钥加密后，返回CMK加密数据密钥的密文和公钥加密数据密钥的密文。
Encrypt	使用对称主密钥加密明文	使用对称密钥将明文加密为密文。
Decrypt	解密密文	解密密文。
ReEncrypt	对密文进行转加密	对密文进行转加密。即先将密文解密，然后将解密得到的数据或者数据密钥使用新的主密钥再次进行加密，返回加密结果。
ExportDataKey	使用传入的公钥加密导出数据密钥	使用传入的公钥加密导出数据密钥。
GenerateDataKeyWithoutPlaintext	生成一个数据密钥，不需返回数据密钥明文内容。	生成一个随机的数据密钥。可以用数据密钥进行本地数据的加密。
AsymmetricSign	使用非对称密钥进行签名	使用非对称密钥进行签名。
AsymmetricVerify	使用非对称密钥进行验签	使用非对称密钥进行验签。
AsymmetricEncrypt	使用非对称密钥进行加密	使用非对称密钥进行加密。
AsymmetricDecrypt	使用非对称密钥进行解密	使用非对称密钥进行解密。

凭据管理

API	标题	API概述
CreateSecret	创建凭据	创建凭据并存入凭据的初始版本。
DeleteSecret	删除凭据对象	删除凭据对象。
UpdateSecret	更新凭据的元数据	更新凭据的元数据。
UpdateSecretVersionStage	更新凭据的版本状态	更新凭据的版本状态。
UpdateSecretRotationPolicy	更新动态凭据的轮转策略	更新凭据轮转策略。
ListSecrets	查询当前用户在当前地域创建的所有凭据	查询当前用户在当前地域创建的所有凭据。
DescribeSecret	查询凭据的元数据信息	查询凭据的元数据信息。
GetSecretValue	获取凭据值	获取凭据值。
ListSecretVersionIds	查询凭据的所有版本信息	查询凭据的所有版本信息。
GetRandomPassword	获得一个随机口令字符串	获得一个随机口令字符串。
PutSecretValue	为凭据存入一个新版本的凭据值	为通用凭据存入一个新版本的凭据值。
RestoreSecret	恢复被删除的凭据	恢复被删除的凭据。
RotateSecret	主动轮转动态凭据	立即轮转凭据。
SetSecretPolicy	设置凭据策略	为KMS实例中的凭据钥设置凭据策略。
GetSecretPolicy	查询凭据策略	查询指定凭据的凭据策略。

证书管理

API	标题	API概述
CreateCertificate	创建证书	创建证书。
DeleteCertificate	删除证书	删除证书及其对应的私钥和证书链。
UpdateCertificateStatus	更新证书状态	更新证书状态。
DescribeCertificate	查询证书信息	查询证书信息。
GetCertificate	获取证书	查询证书管家托管的证书。
UploadCertificate	更新证书	将CA机构颁发的证书和证书链导入证书管家。
CertificatePrivateKeySign	使用X.509数字证书私钥为消息签名	使用指定证书生成数字签名。
CertificatePublicKeyEncrypt	使用X.509数字证书公钥对明文加密	使用指定证书加密数据。
CertificatePrivateKeyDecrypt	使用X.509数字证书私钥解密密文	使用指定证书解密数据。
CertificatePublicKeyVerify	使用X.509数字证书公钥验证消息	使用指定证书验证数字签名。

标签管理

API	标题	API概述
UntagResources	解绑标签	为密钥或凭据解绑标签。
ListTagResources	查询标签列表	查询密钥或凭据的标签。
TagResources	绑定标签	为密钥或凭据绑定标签。
ListResourceTags	获取用户主密钥的标签	获取用户主密钥的标签。
TagResource	为主密钥或凭据设置标签	为主密钥、凭据或证书绑定标签。
UntagResource	删除用户主密钥或凭据的指定标签	为主密钥、凭据或证书解绑标签。

应用管理

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