使用指定密钥校验特定消息的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
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。