tencent cloud

APIs

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

DescribeLogInstanceList

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

1. API Description

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

This API is used to query log instances.

A maximum of 35 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: DescribeLogInstanceList.
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.
LogType Yes String

Log type.

Enumeration value:

  • auditLog: Audit log.
Limit No Integer

Size of the output task list per page.

  • Value ranges from 1 to 100.
  • Default value: 20.
Offset No Integer

Pagination offset. Default value: 0. Value: Multiple of Limit. Calculation formula: offset=limit*(page number-1).
Filters.N No Array of Filter

Set the log filtering field to filter and return logs that meet a specified condition.
LogSubType No String

Log subcategory.

Enumeration value:

  • write: Write logs.
  • read: Read logs.
  • all: Read/write logs.
LogSwitch No String

Log switch.

Enumeration value:

  • on: Enable
  • off: Disable

Default value: off

3. Output Parameters

Parameter Name Type Description
TotalCount Integer

The number of queried logs.
Items Array of LogInstance

Log platform instance information.
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: DescribeLogInstanceList
<Common request parameters>

{
    "LogType": "auditLog",
    "Limit": 100,
    "Offset": 0
}

Output Example

{
    "Response": {
        "Items": [
            {
                "CreateAt": "",
                "Deliver": "",
                "DeliverSummary": null,
                "EnableQuery": "",
                "HighLogExpireDay": 0,
                "HighStorage": 0,
                "InstanceId": "crs-d285tydf",
                "InstanceInfo": {
                    "DegradeStrategy": 500,
                    "InstanceName": "test-redis-5.0-cluster-1s1r-2g",
                    "InstanceTags": [],
                    "ProjectId": 0,
                    "Region": "ap-guangzhou",
                    "Status": 2,
                    "SubStatus": 19,
                    "Type": 9,
                    "Zone": "ap-guangzhou-2"
                },
                "LogExpireDay": 0,
                "LogStorage": 0,
                "LowLogExpireDay": 0,
                "LowStorage": 0,
                "Status": ""
            }
        ],
        "TotalCount": 3,
        "RequestId": "63a0297c-850a-40df-a897-939ec135438b"
    }
}

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.

前の記事へ: DescribeLogs次の記事へ: DescribeExportTasks

ヘルプとサポート

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

フィードバック