Domain name for API request: kms.intl.tencentcloudapi.com.
This API is used to generate a signature with an asymmetric key.
Note that only when KeyUsage is ASYMMETRIC_SIGN_VERIFY_${ALGORITHM} (e.g., ASYMMETRIC_SIGN_VERIFY_SM2 and ASYMMETRIC_SIGN_VERIFY_ECC), the key can be used for signing.
A maximum of 200 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: SignByAsymmetricKey. |
| Version | Yes | String | Common Params. The value used for this API: 2019-01-18. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Algorithm | Yes | String | Signature algorithm. Supported algorithms: SM2DSA, ECC_P256_R1, ECDSA384_SHA384, RSA_PSS_SHA_256, RSA_PKCS1_SHA_256, RSA_PSS_SHA_384, RSA_PKCS1_SHA_384, RSA_PSS_SHA_512, RSA_PKCS1_SHA_512, etc. For more supported algorithms, query them through the ListAlgorithms API. |
| Message | Yes | String | Message original text or message digest. If the message original text is provided, its length (before Base64 encoding) cannot exceed 4096 bytes. If the message digest is provided, its length (before Base64 encoding) must be 32 bytes. |
| KeyId | Yes | String | Unique identifier of the key |
| MessageType | No | String | Message type: RAW or DIGEST. If not specified, RAW is used by default, indicating the message original text. |
| Parameter Name | Type | Description |
|---|---|---|
| Signature | String | Signature, Base64-encoded. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: kms.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SignByAsymmetricKey
<Common request parameters>
{
"Algorithm": "SM2DSA",
"Message": "dGVzdAo=",
"KeyId": "d79e97e5-69d1-11ef-bc87-02ac442a5a1f",
"MessageType": "RAW"
}{
"Response": {
"RequestId": "f60b4087-ab02-4c5b-bf50-956e591ccbc4",
"Signature": "MEYCIQDFunV6ujrE9k4IMOEeH4J0uwENYSf1JH2DI01qlFWKkwIhAMiv6S2s3VsLtMF/+4rDEiF3IyE3zfRGq5B+k7hHfGoQ"
}
}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 |
|---|---|
| AuthFailure | CAM signature/authentication error |
| FailedOperation.SignError | Signature operation failed. |
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue.InvalidKeyId | Invalid KeyId. |
| MissingParameter | Missing parameters. Please check and try again. |
| ResourceUnavailable.CmkNotFound | The CMK does not exist. |
| ResourceUnavailable.CmkStateNotSupport | This operation cannot be performed under the current CMK status. |
| UnsupportedOperation.UnsupportedKeyUsageInCurrentRegion | The encryption method is not supported in the current region. |
Esta página foi útil?
Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.
comentários