CreateRedisBigKeyAnalysisTask

下载PDF

最后更新时间：2025-10-24 14:50:46

CreateRedisBigKeyAnalysisTask

最后更新时间： 2025-10-24 14:50:46

下载PDF

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	No	String	Common Params. This parameter is not required for this API.
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: ",", ";", ":", "_", "-", "+", "@", "=", "\|", "#", ".". When the list is empty, all separators will be selected by default.

3. Output Parameters

Parameter Name	Type	Description
AsyncRequestId	Integer	Async task ID
RequestId	String	The unique request ID, which is returned for each request. 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

Tencent Cloud CLI 3.0

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.

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud