使用指定金鑰校驗特定訊息的 HMAC 訊息認證碼。
介面說明
RAM 使用者或 RAM 角色呼叫該 OpenAPI 需要被授予的權限策略詳情，請參見存取控制。
本介面可以透過共享閘道或專屬閘道呼叫。詳細介紹，請參見阿里雲 SDK。
共享閘道：透過公網、VPC 網域名稱存取 KMS，該方式需要開啟公網開關。具體操作，請參見透過公網存取 KMS 執行個體中的金鑰。
專屬閘道：透過 KMS 私網地址（<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com）存取 KMS。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求文法
POST HTTP/1.1請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| KeyId |
string |
是 |
金鑰的 ID，也可以指定為金鑰別名或金鑰資源名稱（ARN）。關於別名的詳細介紹，請參見管理金鑰別名。 說明
存取其他阿里雲帳號下的金鑰時，必須輸入金鑰 ARN。金鑰 ARN 的格式為 |
key-hzz630494463ejqjx**** |
| Mac |
string |
是 |
base64 編碼的待校驗訊息驗證碼。 |
vz1Snp+jGJbgydCFRWVWxAwIMdyfKCSp+jnMWQ== |
| Message |
string |
是 |
原始訊息資料。 使用 Base64 編碼。例如：待產生訊息驗證碼的十六進位內容為 |
VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wcyBvdmVyIHRoZSBsYXp5IGRvZy4= |
| Algorithm |
string |
是 |
產生訊息驗證碼的演算法。依據使用的金鑰規格不同，可取值包括：
|
HMAC_SHA_256 |
| DryRun |
string |
否 |
是否開啟 DryRun 模式。true：開啟 false（預設值）：關閉 DryRun 模式用於測試 API 呼叫，驗證您是否具有相應資源的權限，以及請求參數是否配置正確。DryRun 模式開啟後，KMS 會始終回傳失敗並提示失敗原因。失敗原因包含如下：DryRunOperationError：不配置 DryRun 參數時，請求會成功。ValidationError：請求中指定的參數有誤。AccessDeniedError：您無權在 KMS 資源上執行該操作。 |
false |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| RequestId |
string |
本次呼叫請求的 ID，是由阿里雲為該請求產生的唯一識別碼，可用於排查和定位問題。 |
f94ec9d3-2d10-4922-9a5c-5dcd5ebcb5e8 |
| KeyId |
string |
主金鑰的全域唯一識別碼。 說明
如果請求中的 KeyId 參數使用的是主金鑰的別名，在回應中會回傳別名對應的主金鑰識別碼。 |
key-hzz62f1cb66fa42qo*** |
| Algorithm |
string |
產生訊息驗證碼的演算法。依據使用的金鑰規格不同，可取值包括：
|
HMAC_SHA_256 |
| Value |
boolean |
訊息認證碼校驗是否成功。 |
true |
樣本
正常返回樣本
JSON格式
{
"RequestId": "f94ec9d3-2d10-4922-9a5c-5dcd5ebcb5e8",
"KeyId": "key-hzz62f1cb66fa42qo***",
"Algorithm": "HMAC_SHA_256",
"Value": true
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。