密鑰管理服務不僅提供可視化操作控制臺,還提供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服務地址可以使用內部網絡通信。
詳細接入點,請參見如下信息。
中國地區
地域
地域ID
公網接入地址
VPC接入地址
華東1(杭州)
cn-hangzhou
kms.cn-hangzhou.aliyuncs.com
kms-vpc.cn-hangzhou.aliyuncs.com
華東2(上海)
cn-shanghai
kms.cn-shanghai.aliyuncs.com
kms-vpc.cn-shanghai.aliyuncs.com
華南1(深圳)
cn-shenzhen
kms.cn-shenzhen.aliyuncs.com
kms-vpc.cn-shenzhen.aliyuncs.com
華南2(河源)
cn-heyuan
kms.cn-heyuan.aliyuncs.com
kms-vpc.cn-heyuan.aliyuncs.com
華南3(廣州)
cn-guangzhou
kms.cn-guangzhou.aliyuncs.com
kms-vpc.cn-guangzhou.aliyuncs.com
華北1(青島)
cn-qingdao
kms.cn-qingdao.aliyuncs.com
kms-vpc.cn-qingdao.aliyuncs.com
華北2(北京)
cn-beijing
kms.cn-beijing.aliyuncs.com
kms-vpc.cn-beijing.aliyuncs.com
華北3(張家口)
cn-zhangjiakou
kms.cn-zhangjiakou.aliyuncs.com
kms-vpc.cn-zhangjiakou.aliyuncs.com
華北5(呼和浩特)
cn-huhehaote
kms.cn-huhehaote.aliyuncs.com
kms-vpc.cn-huhehaote.aliyuncs.com
華北6(烏蘭察布)
cn-wulanchabu
kms.cn-wulanchabu.aliyuncs.com
kms-vpc.cn-wulanchabu.aliyuncs.com
西南1(成都)
cn-chengdu
kms.cn-chengdu.aliyuncs.com
kms-vpc.cn-chengdu.aliyuncs.com
中國香港
cn-hongkong
kms.cn-hongkong.aliyuncs.com
kms-vpc.cn-hongkong.aliyuncs.com
其他國家和地區
地域
地域ID
公網接入地址
VPC接入地址
新加坡
ap-southeast-1
kms.ap-southeast-1.aliyuncs.com
kms-vpc.ap-southeast-1.aliyuncs.com
馬來西亞(吉隆坡)
ap-southeast-3
kms.ap-southeast-3.aliyuncs.com
kms-vpc.ap-southeast-3.aliyuncs.com
印度尼西亞(雅加達)
ap-southeast-5
kms.ap-southeast-5.aliyuncs.com
kms-vpc.ap-southeast-5.aliyuncs.com
菲律賓(馬尼拉)
重要該地域下僅有一個可用區,KMS在該地域不承諾SLA。
ap-southeast-6
kms.ap-southeast-6.aliyuncs.com
kms-vpc.ap-southeast-6.aliyuncs.com
泰國(曼谷)
重要該地域下僅有一個可用區,KMS在該地域不承諾SLA。
ap-southeast-7
kms.ap-southeast-7.aliyuncs.com
kms-vpc.ap-southeast-7.aliyuncs.com
日本(東京)
ap-northeast-1
kms.ap-northeast-1.aliyuncs.com
kms-vpc.ap-northeast-1.aliyuncs.com
德國(法蘭克福)
eu-central-1
kms.eu-central-1.aliyuncs.com
kms-vpc.eu-central-1.aliyuncs.com
英國(倫敦)
eu-west-1
kms.eu-west-1.aliyuncs.com
kms-vpc.eu-west-1.aliyuncs.com
美國(硅谷)
us-west-1
kms.us-west-1.aliyuncs.com
kms-vpc.us-west-1.aliyuncs.com
美國(弗吉尼亞)
us-east-1
kms.us-east-1.aliyuncs.com
kms-vpc.us-east-1.aliyuncs.com
阿聯酋(迪拜)
me-east-1
kms.me-east-1.aliyuncs.com
kms-vpc.me-east-1.aliyuncs.com
支持的調用身份
您阿里云賬號登錄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診斷平臺進行自助診斷。