Key Management Service不僅提供可視化Operations 主控台,還提供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版本。
版本號碼 | 說明 |
推薦使用 |
線上調試
Key Management Service支援在阿里雲OpenAPI門戶進行API調試,在調試之前,您需要提前瞭解API版本、存取點說明、API參數等資訊。
調試API入口為:https://next.api.alibabacloud.com/api/Kms/2016-01-20

存取點說明
根據相關資源所在地區,選擇對應的服務存取點地址,以獲得最低延遲。例如華東1(杭州)的Key Management Service公網接入地址為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
Resource Orchestration Service
Resource Orchestration Service服務ROS(Resource Orchestration Service)是阿里雲提供的一項簡化雲端運算資源管理的服務。開發人員和管理員可以編寫模板,在模板中定義所需的阿里雲資源(例如:ECS 執行個體、RDS 資料庫執行個體)、資源間的依賴關係等。ROS 的編排引擎將根據模板自動完成所有資源的建立和配置,實現自動化部署及營運。更多詳情請參見什麼是Resource Orchestration Service服務。
暫不支援使用Resource Orchestration Service調用Key Management Service。
Terraform
Terraform 是一種開源工具,用於安全高效地預覽,配置和管理雲基礎架構和資源。它與阿里雲的Resource Orchestration Service服務的運行機制類似,通過將模板轉化為內部資料後完成 OpenAPI 呼叫。更多詳情,請參見Terraform產品介紹。
快速使用Terraform編排Key Management Service,請參見Terraform概述。
自訂封裝API調用
原生HTTP調用需要您自己實現簽名演算法,並構建自訂請求,發起HTTP調用。有關簽名機制的更多詳細資料,請參見Key Management ServiceAPI概覽和V3版本請求體&簽名機制。
注意事項
單個阿里雲帳號調用不同API的每秒請求數(QPS)不同,詳情請參見各API文檔的QPS限制。
說明單個阿里雲帳號下的所有RAM使用者共用該阿里雲帳號的QPS配額。
如果調用API後報錯,您可以根據返回的錯誤碼資訊,提示檢查傳入的請求參數及其取值是否正確,更多資訊請參見公用錯誤碼。
您可以記錄下調用返回的RequestID或SDK報錯資訊,通過阿里雲OpenAPI診斷平台進行自助診斷。