使用 HMAC KMS 密钥和密钥支持的 MAC 算法为消息生成基于哈希的消息认证码 (HMAC)
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GenerateMac | 要执行的操作,取值:GenerateMac。 |
Version | String | 是 | 2021-02-18 | API的版本,取值:2021-02-18。 |
KeyringName | String | 否 | keyringName | 密钥环名称,长度为 2 - 31 个字符。合法字符:[a-zA-Z0-9-_] |
KeyName | String | 否 | keyName | 主密钥名称,长度为 2 - 31 个字符。合法字符:[a-zA-Z0-9-_] |
KeyID | String | 否 | 0324d9b3-c5d9-4b6f-94e7-884010a16fee | 主密钥ID,二选一: |
Message | String | 是 | testMessage | 签名消息。 |
MacAlgorithm | String | 是 | HMAC_SHA_256 | MacAlgorithm 算法, 只支持 HMAC_SM3|HMAC_SHA_256 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
KeyID | String | 41cb6fdba8ef249312e4ce66f7d6b5b68e565ef84d6333793b5934d6779e847c | 主密钥唯一标识符,UUID形式 |
Mac | String | 0324d9b3-c5d9-4b6f-94e7-884010a16fee | message authentication code |
POST /?Action=GenerateMac&Version=2021-02-18 HTTP/1.1 Host: kms.volcengineapi.com Content-Type: application/json; charset=UTF-8 X-Date: 20240708T151941Z X-Content-Sha256: 287e874e******d653b44d21e Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240708/cn-beijing/kms/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f { "Message": "5Lq65LmL5Yid5oCn5pys5ZaE5oCn55u46L+R5Lmg55u46L+c", "MacAlgorithm": "HMAC_SHA_256", "KeyringName": "fd65f1d1-9b0c-4254-897f-1965b2", "KeyName": "bbbb" }
{ "ResponseMetadata": { "RequestId": "02172956002604000000000000000000000ffff0a7ab9adc81d5f", "Action": "GenerateMac", "Version": "2021-02-18", "Service": "kms", "Region": "cn-north-1" }, "Result": { "KeyID": "1096b6a5-3bb5-430a-8c5b-65ae1ca73346", "Mac": "49NIoYbYAkVv8tT6hoAY+jJ0gZCRQujiv7wc0S763ao=" } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
---|---|---|
400 | MissingParameter | |
400 | InvalidParameter | |
400 | InvalidKeyStatus | |
400 | InvalidKeyUsage | |
403 | AccessDenied | |
403 | Reject.Throttling.CMK | |
404 | Not Found | |
500 | UndefinedError |