tencent cloud

TencentDB for DBbrain

DocumentationTencentDB for DBbrainAPI DocumentationRedis related APIsCreateRedisBigKeyAnalysisTask

CreateRedisBigKeyAnalysisTask

Download
Focus Mode
Font Size
Last updated: 2026-05-21 11:06:57

1. API Description

Domain name for API request: dbbrain.intl.tencentcloudapi.com.

This API is used to create an ad hoc big key analysis task for Redis instances. By default, there can only be up to five running ad hoc analysis tasks.

A maximum of 20 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 Params. The value used for this API: CreateRedisBigKeyAnalysisTask.
Version Yes String Common Params. The value used for this API: 2021-05-27.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID
Product Yes String Service type. Valid value: redis (TencentDB for Redis).
ShardIds.N No Array of Integer The list of the serial numbers of shard nodes. When the list is empty, all shard nodes will be selected.
KeyDelimiterList.N No Array of String The list of separators of top key prefixes.
Currently, the following separators are supported: ",", ";", ":", "_", "-", "+", "@", "=", "

3. Output Parameters

Parameter Name Type Description
AsyncRequestId Integer Async task ID
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.

4. Example

Example1 Creating an ad hoc big key analysis task for Redis instances

This example shows you how to create an ad hoc big key analysis task for Redis instances.

Input Example

https://dbbrain.intl.tencentcloudapi.com/?Action=CreateRedisBigKeyAnalysisTask
&InstanceId=cdb-test
&Product=redis
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "24665720-8c93-11eb-bee6-e98cea0e6794",
        "AsyncRequestId": 8011
    }
}

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 Error with CAM signature/authentication.
FailedOperation Operation failed.
InvalidParameterValue Incorrect parameter value.
MissingParameter Missing parameter.
OperationDenied.UserHasNoStrategy Error with CAM authentication.
UnknownParameter Unknown parameter.
UnsupportedOperation Unsupported operation.
Previous Topic: ModifyDiagDBInstanceConfNext Topic: DescribeRedisTopKeyPrefixList

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback