SignByAsymmetricKey

Last updated: 2021-01-28 20:02:02

1. API Description

Domain name for API request: kms.tencentcloudapi.com.

This API is used to generate a signature with an asymmetric key.
Note: only the keys with KeyUsage= ASYMMETRIC_SIGN_VERIFY_SM2 can be used for signature generation.

A maximum of 100 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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 parameter. The value used for this API: SignByAsymmetricKey.
Version Yes String Common parameter. The value used for this API: 2019-01-18.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
Algorithm Yes String Signature algorithm. Supported algorithm: SM2DSA.
Message Yes String The original message or message abstract. For an original message, the length before Base64 encoding can contain up to 4,096 bytes. For a message abstract, the SM2 signature algorithm only supports 32-byte (before Base64 encoding) message abstracts.
KeyId Yes String Unique ID of a key
MessageType No String Message type. Valid values: RAW (indicating an original message; used by default if the parameter is not passed in) and DIGEST.

3. Output Parameters

Parameter Name Type Description
Signature String Base64-encoded signature
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Generating a signature with an asymmetric key

Input Example

https://kms.tencentcloudapi.com/?Action=SignByAsymmetricKey
&Algorithm=SM2DSA
&Message=Zsfw9GLu7dnR8tRr3BDk4kFnxIdc8veiKX2gK49LqOA%3D
&KeyId=6cdf26d1-44ff-11eb-841c-5254006d0810
&MessageType=DIGEST
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "e86d6131-2830-4e1c-9d03-d421affd646c",
    "Signature": "MEUCICr/JCV52BqGvI0iYxdZ1eL8zzJjx39mWNv2ZWdLOMvRAiEApO6os3Wj0Tg302fbTBr02IxHO1aCr0Zr41t4hi6yTG8="
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure CAM signature/authentication error
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue.InvalidKeyId Invalid KeyId.
ResourceUnavailable.CmkNotFound The CMK does not exist.
ResourceUnavailable.CmkStateNotSupport This operation cannot be performed under the current CMK status.