All Products
Search
Document Center

Elasticsearch:ListDiagnoseReportIds

更新時間:May 07, 2024

Queries the IDs of the historical intelligent O&M reports of an Elasticsearch cluster.

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 header

This operation does not have operation-specific request headers and uses only common request headers. For more information, see the "Common request parameters" section of the Common parameters topic.

Request syntax

GET /openapi/diagnosis/instances/{InstanceId}/report-ids HTTP/1.1

Request parameters

Parameter

Type

Position

Required

Example

Description

InstanceId String Path Yes es-cn-n6w1qu7ei000p****

The instance ID.

lang String Query No en

The language of the reports. The default is the browser language, which supports:

  • en: English
  • zh: simplified Chinese
  • zt: traditional Chinese
  • es: Spanish
  • fr: French
startTime Long Query Yes 1595088000000

The beginning of the time range to query. The value must be a UNIX timestamp.

Minimum value: 1000000000000 ms

Maximum: 2000000000000 ms

endTime Long Query Yes 1595174399999

The end of the time range to query. The value must be a UNIX timestamp.

Minimum value: 1000000000000 ms

Maximum: 2000000000000 ms

page Integer Query No 1

The number of the page to return. Valid values: 1 to 200. Default value: 1.

size Integer Query No 15

The number of entries to return on each page. Valid values: 1 to 500. Default value: 10.

trigger String Query No SYSTEM

The method that is used to trigger health diagnostics. Valid values: SYSTEM, INNER, and USER.

Response parameters

Parameter

Type

Example

Description

RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

The request ID.

Result Array of String ["scheduled__2020-09-13T00:40:00"]

The data returned.

Headers Object

The header of the response.

X-Total-Count Integer 1

The total number of entries returned.

Examples

Sample requests

GET /openapi/diagnosis/instances/es-cn-09k1rocex0006****/report-ids?startTime=1600099200000&endTime=1600185600000 HTTP/1.1
Common request parameters

Sample success responses

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Result" : [ "scheduled__2020-09-15T00:40:00" ],
  "RequestId" : "B5F822C5-03E9-4899-8D80-2B35515A****",
  "Headers" : {
    "X-Total-Count" : 1
  }
}

Error codes

For a list of error codes, see Service error codes.