Domain name for API request: kms.tencentcloudapi.com.
This API is used to verify a signature with an asymmetric key.
A maximum of 100 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: VerifyByAsymmetricKey. |
Version | Yes | String | Common Params. The value used for this API: 2019-01-18. |
Region | No | String | Common Params. This parameter is not required for this API. |
KeyId | Yes | String | Unique ID of a key |
SignatureValue | Yes | String | Signature value, which is generated by calling the KMS signature API. |
Message | Yes | String | Full message or message abstract. Before Base64 encoding, an original message can contain up to 4,096 bytes while a message abstract must be 32 bytes. |
Algorithm | Yes | String | Signature algorithm. The valid values include SM2DSA , ECC_P256_R1 , RSA_PSS_SHA_256 , and RSA_PKCS1_SHA_256 , etc. You can get a full list of supported algorithms using the ListAlgorithms API. |
MessageType | No | String | Message type. Valid values: RAW (indicating an original message; used by default if the parameter is not passed in) and DIGEST . |
Parameter Name | Type | Description |
---|---|---|
SignatureValid | Boolean | Whether the signature is valid. true : the signature is valid; false : the signature is invalid. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://kms.tencentcloudapi.com/?Action=VerifyByAsymmetricKey
&Algorithm=SM2DSA
&Message=Zsfw9GLu7dnR8tRr3BDk4kFnxIdc8veiKX2gK49LqOA%3D
&KeyId=6cdf26d1-44ff-11eb-841c-5254006d0810
&MessageType=DIGEST
&SignatureValue=MEUCIQDeO1wB%2F5dEfprulvh9Zw06UJylDt9R8MQY5qRMjzhXJgIgPKO2kKicFKemwOft8SgniUA692ORrqVEabS3kcbPL8U%3D
&<Common request parameters>
{
"Response": {
"RequestId": "3e634985-c311-4790-953a-44990f7bec6b",
"SignatureValid": true
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
InternalError | Internal error. |
InvalidParameter | Invalid parameter. |
InvalidParameterValue | Incorrect parameter value. |
InvalidParameterValue.InvalidKeyId | Invalid KeyId . |
ResourceUnavailable.CmkNotFound | The CMK does not exist. |
ResourceUnavailable.CmkStateNotSupport | This operation cannot be performed under the current CMK status. |
Was this page helpful?