Queries the error logs of an OpenSearch application.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see Common request parameters.

Request syntax

GET /v4/openapi/app-groups/[appGroupIdentity]/errors HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
appGroupIdentity String Path Yes my_app_group_name

The name of the application.
appId String Query No 130101972

The ID of the application version.
startTime Integer Query No 1582214400

The beginning of the time range to query. If you do not set this parameter, the time range to query starts from 00:00:00 on the current day.

stopTime Integer Query No 1582646399

The end of the time range to query. If you do not set this parameter, the time range to query ends at the current time.

pageNumber Integer Query No 1

The number of the page to return. Default value: 1.
pageSize Integer Query No 10

The number of entries to return on each page. Default value: 10.

Response parameters

Parameter Type Example Description
requestId String 89DE5688-8E0B-2494-6E4B-CB32F9F80D91

The ID of the request.
result List {}

The information about the error logs.
totalCount Long 4

The total number of entries returned.
Information about the error logs

Parameter

Type

Description

result[].version

String

The ID of the application version.

result[].docCount

String

The number of documents.

result[].tableName

String

The name of the table.

result[].errorCode

String

The error code.

result[].errorMessage

String

The error message.

result[].timeStart

String

The beginning of the time range in which the error logs were queried.

result[].timeStop

String

The end of the time range in which the error logs were queried.

result[].errorDetail[]

Object

The details about the error.

result[].errorDetail[].message

String

The detailed error message.

result[].errorDetail[].description

String

The description of the error message.

result[].errorDetail[].params

Array

The invalid parameters.

result[].more

Boolean

Indicates whether detailed information is displayed.

result[].seq

Integer

The number of return results of the same type.

Examples

Sample requests

GET /v4/openapi/app-groups/110116134/errors?pageNumber=1&pageSize=5&startTime=1582214400&stopTime=1582646399&appId=130101972

Sample success responses

XML format 

<requestId>89DE5688-8E0B-2494-6E4B-CB32F9F80D91</requestId>
<result>
    <version>100303385</version>
    <docCount>0</docCount>
    <tableName/>
    <errorCode>7601</errorCode>
    <errorMessage>定时任务执行失败</errorMessage>
    <timeStart>2020-07-02 17:12:48</timeStart>
    <timeStop>2020-07-02 17:12:48</timeStop>
    <errorDetail>
        <message>Failed to execute task. </message>
        <description>Failed to execute task. </description>
    </errorDetail>
    <more>true</more>
    <seq>1</seq>
</result>
<totalCount>4</totalCount>

JSON format 

{
    "requestId": "89DE5688-8E0B-2494-6E4B-CB32F9F80D91",
    "result": {
        "version": 100303385,
        "docCount": 0,
        "tableName": "",
        "errorCode": 7601,
        "errorMessage": "定时任务执行失败",
        "timeStart": "2020-07-02 17:12:48",
        "timeStop": "2020-07-02 17:12:48",
        "errorDetail": {
            "message": "Failed to execute task.",
            "description": "Failed to execute task."
        },
        "more": true,
        "seq": 1
    },
    "totalCount": 4
}

Error codes

For a list of error codes, visit the API Error Center.