Help & DocumentationAPIsKey Management ServiceKey APIsListAlgorithms

ListAlgorithms

Last updated: 2020-04-10 11:39:41

1. API Description

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

This API is used to list the encryption methods supported in the current region.

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

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: ListAlgorithms.
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.

3. Output Parameters

Parameter Name Type Description
SymmetricAlgorithms Array of AlgorithmInfo Symmetric encryption algorithms supported in this region
AsymmetricAlgorithms Array of AlgorithmInfo Asymmetric encryption algorithms supported in this region
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Listing encryption methods supported in the current region

Input Example

https://kms.tencentcloudapi.com/?Action=ListAlgorithms
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "460fe7ff-f4db-4509-9b20-208badcfb915",
    "SymmetricAlgorithms": [
      {
        "KeyUsage": "ENCRYPT_DECRYPT",
        "Algorithm": "SM4"
      }
    ],
    "AsymmetricAlgorithms": [
      {
        "KeyUsage": "ASYMMETRIC_DECRYPT_SM2",
        "Algorithm": "SM2"
      },
      {
        "KeyUsage": "ASYMMETRIC_DECRYPT_RSA_2048",
        "Algorithm": "RSA_2048"
      }
    ]
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.