tencent cloud

Elasticsearch Service

User Guide
Release Notes and Announcements
Release Notes
Product Announcements
Security Announcement
Product Introduction
Overview
Elasticsearch Version Support Notes
Features
Elastic Stack (X-Pack)
Strengths
Scenarios
Capabilities and Restrictions
Related Concepts
Purchase Guide
Billing Overview
Pricing
Elasticsearch Service Serverless Pricing
Notes on Arrears
ES Kernel Enhancement
Kernel Release Notes
Targeted Routing Optimization
Compression Algorithm Optimization
FST Off-Heap Memory Optimization
Getting Started
Evaluation of Cluster Specification and Capacity Configuration
Creating Clusters
Accessing Clusters
ES Serverless Guide
Service Overview
Basic Concepts
5-Minute Quick Experience
Quick Start
Access Control
Writing Data
Data Query
Index Management
Alarm Management
ES API References
Related Issues
Data Application Guide
Data Application Overview
Data Management
Elasticsearch Guide
Managing Clusters
Access Control
Multi-AZ Cluster Deployment
Cluster Scaling
Cluster Configuration
Plugin Configuration
Monitoring and Alarming
Log Query
Data Backup
Upgrade
Practical Tutorial
Data Migration and Sync
Use Case Construction
Index Configuration
SQL Support
Receiving Watcher Alerts via WeCom Bot
API Documentation
History
Introduction
API Category
Instance APIs
Making API Requests
Data Types
Error Codes
FAQs
Product
ES Cluster
Service Level Agreement
Glossary
New Version Introduction
Elasticsearch Service July 2020 Release
Elasticsearch Service February 2020 Release
Elasticsearch Service December 2019 Release
문서Elasticsearch ServiceAPI DocumentationInstance APIsDescribeInstanceLogs

DescribeInstanceLogs

PDF
포커스 모드
폰트 크기
마지막 업데이트 시간: 2025-11-13 20:48:24

1. API Description

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

This API is used to query the eligible ES cluster logs in the current region.

A maximum of 50 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: DescribeInstanceLogs.
Version Yes String Common Params. The value used for this API: 2018-04-16.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-mumbai, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
InstanceId Yes String Cluster instance ID
LogType No Integer Log type. Default value: 1
  • 1: primary log
  • 2: search slow log
  • 3: index slow log
  • 4: GC log
    		•
    SearchKey No String Search keyword, which supports LUCENE syntax, such as level:WARN, ip:1.1.1.1, and message:test-index
    StartTime No String Log start time in the format of YYYY-MM-DD HH:MM:SS, such as 2019-01-22 20:15:53
    EndTime No String Log end time in the format of YYYY-MM-DD HH:MM:SS, such as 2019-01-22 20:15:53
    Offset No Integer Pagination start value. Default value: 0
    Limit No Integer Number of entries per page. Default value: 100. Maximum value: 100
    OrderByType No Integer Time sorting order. Default value: 0
  • 0: descending
  • 1: ascending
    		•

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of returned logs
    InstanceLogList Array of InstanceLog Log details list
    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 Querying ES cluster logs

    This example shows you how to query the latest primary logs of a cluster.

    Input Example

    https://es.intl.tencentcloudapi.com/?Action=DescribeInstanceLogs
&InstanceId=es-f5mwm28u
&<Common request parameters>

    Output Example

    {
    "Response": {
        "TotalCount": 71633,
        "InstanceLogList": [
            {
                "Time": "2019-01-22T10:45:36.220+08:00",
                "Ip": "10.0.128.65",
                "Level": "INFO",
                "Message": "[o.e.p.o.OPackActionFilter] [1547723102001286009] forbidden request: { ID:cdc62072721547678872c0448c1ecaf9, TYP:MainRequest, USR:null, BRS:false, ACT:cluster:monitor/main, OA:10.0.128.43, IDX:, MET:GET, PTH:/, CNT:<OMITTED, LENGTH=0>, HDR:content-length, EFF:0 } Reason: null"
            },
            {
                "Time": "2019-01-22T10:45:35.730+08:00",
                "Ip": "10.0.128.65",
                "Level": "INFO",
                "Message": "[o.e.p.o.OPackActionFilter] [1547723102001286009] forbidden request: { ID:1a8a5b7ea41a485ebdd769586c1dcdf6, TYP:MainRequest, USR:null, BRS:false, ACT:cluster:monitor/main, OA:10.0.128.73, IDX:, MET:GET, PTH:/, CNT:<OMITTED, LENGTH=0>, HDR:content-length, EFF:0 } Reason: null"
            }
        ],
        "RequestId": "783d9290-dc60-4862-9340-10b632605374"
    }
}

    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.RequestTimeOut Request timeout.
    InternalError Internal error.
    InvalidParameter Invalid parameter.
    InvalidParameter.InvalidAppId AppId value does not match the expected value.
    InvalidParameter.InvalidInstanceId Invalid InstanceId, no corresponding resource found.
    InvalidParameter.InvalidLimit The page size Limit value does not match the expected value.
    InvalidParameter.InvalidLogType The LogType value does not match the expected value.
    InvalidParameter.InvalidOffset The Offset value does not match the expected value.
    InvalidParameter.InvalidOrderByKey The sort field OrderByKey value does not match the expected value.
    InvalidParameter.InvalidQueryString Invalid lucene syntax
    InvalidParameter.InvalidRegion The Region value does not match the expected value.
    InvalidParameter.InvalidTimeParam The value or format of time-related parameters does not match the expected.
    ResourceNotFound.ClusterInfoNotFound Failed to obtain cluster resources.
    ResourceNotFound.DBInfoNotFound Failed to obtain database resources.
    이전 주제: DeleteIndex다음 주제: UpdateInstance

    도움말 및 지원

    문제 해결에 도움이 되었나요?

    피드백