本文為您介紹KMS執行個體API的公用要求標頭參數列表和樣本。
參數列表
KMS執行個體API是基於HTTP協議的Protocol Buffers風格介面。它支援一組可以在所有API請求中使用的公用要求標頭(Header),如下表所示。
| 要求標頭名稱 | 類型 | 是否必須 | 描述 |
| Accept | 字串 | 否 | 用戶端希望服務端返回的類型,目前支援application/x-protobuf。 |
| Authorization | 字串 | 是 | 簽名內容。簽名格式為:TOKEN {Signature}。更多資訊,請參見請求籤名。 |
| Content-Length | 數值 | 否 | RFC 2616中定義的HTTP請求Body長度。如果請求無Body部分,則不需要提供該要求標頭。 |
| Content-SHA256 | 字串 | 否 | 請求Body經過SHA256計算後的Hex編碼大寫字串。如果沒有Body部分,則不需要提供該要求標頭。 |
| Content-Type | 字串 | 否 | RFC 2616中定義的HTTP請求Body類型。目前API請求只支援application/x-protobuf類型。如果沒有Body部分,則不需要提供該要求標頭。具體取值以各個介面定義為準。 |
| Date | 字串 | 是 | 當前發送時刻的時間,參數目前只支援RFC 1123格式,使用GMT標準時間 (例如:Mon, 3 Jan 2010 08:33:47 GMT)。 |
| x-kms-apiversion | 字串 | 是 | API的版本號碼,目前的版本為dkms-gcs-0.2。 |
| x-kms-apiname | 字串 | 是 | 當前調用的API的名稱。取值: |
| x-kms-signaturemethod | 字串 | 是 | 簽名計算方式,目前僅支援RSA_PKCS1_SHA_256。 |
| x-kms-acccesskeyid | 字串 | 是 | 存取金鑰ID,目前僅支援應用存取點AAP的ClientKey。 |
樣本
POST / HTTP/1.1
Accept: application/x-protobuf
user-agent: AlibabaCloud (Linux; amd64) Java/1.8.0_302-b08 tea-util/0.2.6 TeaDSL/1
Authorization: TOKEN <Signature>
Content-Length: 40
content-sha256: AE71057543002AD513AB88D78509A1214192C09F20302C4BF8F59B7EB565****
Content-Type: application/x-protobuf
Date: Mon, 27 Sep 2021 11:47:26 GMT
x-kms-apiversion: dkms-gcs-0.2
x-kms-apiname: Encrypt
x-kms-signaturemethod: RSA_PKCS1_SHA_256
x-kms-acccesskeyid: KAAP.9c84ad54-a55d-75bd-235d-7c26d509****
host: kst-****.cryptoservice.kms.aliyuncs.com