tencent cloud

APIs

OpenLog

Download
フォーカスモード
フォントサイズ
最終更新日: 2026-08-14 16:52:23

1. API Description

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

Enable logging

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

Specify the instance ID. Example: crs-xjhsdj****. Log in to the Redis console and copy the instance ID from the instance list.

LogType Yes String

Log type.

Enumeration value:

  • auditLog: Audit log.
LogSubType Yes String

Log subcategory.

Enumeration value:

  • write: Write command.
  • read: Read command.
  • all: Read/write commands.
LogExpireDay Yes Integer

Log valid period, unit: day.

Enumeration value:

  • 7: 7 days
  • 30: 30 days

Default value: 7

HighLogExpireDay Yes Integer

High-frequency log valid period, unit: day.

Enumeration value:

  • 7: 7 days

Default value: 7

DegradeStrategy No Integer

Log degradation policy threshold. When the P99 latency of an instance reaches this threshold, the system will automatically discard audit log data to ensure service availability.

  • Measurement unit: ms.
  • Default value: 500.
  • Value ranges from 300 to 1000.

3. Output Parameters

Parameter Name Type Description
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 Request Example

Input Example

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

{
    "InstanceId": "crs-k2vhnkix",
    "LogType": "auditLog",
    "LogSubType": "write",
    "LogExpireDay": 7,
    "HighLogExpireDay": 7,
    "DegradeStrategy": 600
}

Output Example

{
    "Response": {
        "RequestId": "8936d9b0-3819-479d-855e-919422cffdb9"
    }
}

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

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

ヘルプとサポート

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

フィードバック