tencent cloud

APIs

ドキュメントAPIsTencent Cloud Distributed Cache (Redis OSS-Compatible)Instance APIsModifyValkeyModule

ModifyValkeyModule

ダウンロード
フォーカスモード
フォントサイズ
最終更新日: 2026-11-09 15:06:38

1. API Description

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

This API is used to modify the enable status of the Valkey instance extension module.

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: ModifyValkeyModule.
Version Yes String Common Params. The value used for this API: 2018-04-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String

Specifies the instance ID. Example: crs-xjhsdj****. Log in to the Redis console and copy the instance ID from the instance list.
Name Yes String

Specify the extension module to be modified.

Enumeration values:

  • ValkeyBloom: Refers to the Bloom module, which can efficiently judge whether an element exists in a collection.
  • ValkeyJSON: Refers to the JSON module, which allows Redis to natively support the JSON data format, facilitating the storage and manipulation of JSON Objects.
  • ValkeySearch: Refers to the Search module, which provides a full-text search feature, enabling efficient search operations on data stored in Redis.
Status Yes String

Set the enable status of the extension module. Only support setting to ON to enable the extension module.

3. Output Parameters

Parameter Name Type Description
TaskId Integer

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 Enabling the ValkeyBloom Module

Input Example

POST / HTTP/1.1
Host: redis.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyValkeyModule
<Common request parameters>

{
    "InstanceId": "crs-d5rb****",
    "Name": "ValkeyBloom",
    "Status": "ON"
}

Output Example

{
    "Response": {
        "TaskId": 2031391183,
        "RequestId": "2ccfc821-f00d-43b7-b50d-fcceaa9c96a8"
    }
}

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
FailedOperation.SystemError Internal system error, which is irrelevant to the business.
FailedOperation.UnSupportError The instance does not support this API.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameter.PermissionDenied The API has no CAM permissions.
InvalidParameterValue Incorrect parameter value.
ResourceNotFound.InstanceNotExists No Redis instance is found by the serialId.
前の記事へ: UpdateSSLCert次の記事へ: ModifySSLEncryptionMode

ヘルプとサポート

この記事はお役に立ちましたか？

フィードバック

キーワードで検索
    Enter keywords to search documentation