密钥管理服务不仅提供可视化操作控制台,还提供OpenAPI在线调试、阿里云SDK、Terraform等调用方式,帮助您更高效地进行开发与部署。
OpenAPI介绍
为了让开发者能够快速高效地学习和使用云产品OpenAPI,阿里云为用户提供OpenAPI网站。它是一款集OpenAPI智能搜索、文档、在线调试、SDK获取、CodeSample、调用出错诊断、调用统计为一体的产品。您可以在OpenAPI门户中调用阿里云各云产品开放的OpenAPI,查看OpenAPI请求和返回结果。此外,OpenAPI门户会自动生成相应的SDK调用示例,帮助您快速使用阿里云产品。更多信息,请参见什么是OpenAPI。
版本说明
在线调试2016-01-20
版本的API列表,2016-01-20
代表的是API版本号而非时间概念,所展示的都是最新的API公开数据,并非自2016-01-20
之后就未更新。如何查看API版本,请参见查看API版本。
版本号 | 说明 |
推荐使用 |
在线调试
密钥管理服务支持在阿里云OpenAPI门户进行API调试,在调试之前,您需要提前了解API版本、接入点说明、API参数等信息。
调试API入口为:https://next.api.aliyun.com/api/Kms/2016-01-20
接入点说明
根据相关资源所在地域,选择对应的服务接入点地址,以获得最低延迟。例如华东1(杭州)的密钥管理服务公网接入地址为kms.cn-hangzhou.aliyuncs.com
,VPC接入地址为kms-vpc.cn-hangzhou.aliyuncs.com
。
公网接入地址在全球都可访问。
VPC接入地址只有在阿里云对应的地域内,且是VPC网络类型才可访问。VPC地址的优势:
高安全性:VPC服务地址只能在VPC内部访问,提供更高的安全性和隐私性。
更快的响应速度:由于VPC服务地址在VPC内部网络中运行,其响应速度通常比公网服务更快,且可以避免公网延迟和带宽限制等问题。
更低的成本:VPC服务地址可以使用内部网络通信。
更多信息,请参见接入点说明。
支持的调用身份
您阿里云账号登录OpenAPI网站后,OpenAPI默认使用您的阿里云账号进行在线OpenAPI调试。阿里云账号拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。请根据业务的实际情况按需分配权限后进行接口调用。RAM用户需具备操作权限,详情请参见使用RAM进行访问控制。
用户身份 | 支持情况 |
支持 | |
RAM用户(推荐) | 支持 |
RAM角色(推荐) | 支持 |
更多信息
集成方式
SDK是最易于集成,且支持度最好的OpenAPI调用方式,推荐您选择使用SDK。
调用方式 | 支持情况 |
支持 | |
支持 | |
不支持 | |
部分接口支持 | |
支持 |
阿里云SDK
阿里云CLI
资源编排ROS
资源编排服务ROS(Resource Orchestration Service)是阿里云提供的一项简化云计算资源管理的服务。开发者和管理员可以编写模板,在模板中定义所需的阿里云资源(例如:ECS 实例、RDS 数据库实例)、资源间的依赖关系等。ROS 的编排引擎将根据模板自动完成所有资源的创建和配置,实现自动化部署及运维。更多详情请参见什么是资源编排服务。
暂不支持使用资源编排调用密钥管理服务。
Terraform
Terraform 是一种开源工具,用于安全高效地预览,配置和管理云基础架构和资源。它与阿里云的资源编排服务的运行机制类似,通过将模板转化为内部数据后完成 OpenAPI 调用。更多详情,请参见什么是Terraform。
支持Terraform编排和使用密钥管理服务,支持部分普通资源和数据资源清单,请参见密钥管理服务Terraform资源和数据源。
快速使用Terraform编排密钥管理服务,请参见Terraform概述。
自定义封装API调用
原生HTTP调用需要您自己实现签名算法,并构建自定义请求,发起HTTP调用。有关签名机制的更多详细信息,请参见密钥管理服务API概览和V3版本请求体&签名机制。
注意事项
单个阿里云账号调用不同API的每秒请求数(QPS)不同,详情请参见各API文档的QPS限制。
说明单个阿里云账号下的所有RAM用户共享该阿里云账号的QPS配额。
如果调用API后报错,您可以根据返回的错误码信息,提示检查传入的请求参数及其取值是否正确,更多信息请参见公共错误码。
您可以记录下调用返回的RequestID或SDK报错信息,通过阿里云OpenAPI诊断平台进行自助诊断。