Help Center/ Cloud Search Service/ API Reference/ APIs/ Logstash/ Querying Operation Records

Updated on 2024-10-17 GMT+08:00

View PDF

Querying Operation Records

Function

This API is used to query operation records.

Debugging

You can debug this API through automatic authentication in API Explorer.

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/lgsconf/listactions

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
cluster_id	Yes	String	ID of the cluster you want to query.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
actions	Array of actions objects	Operation records.

**Table 3** actions
Parameter	Type	Description
id	String	Operation record ID.
actionType	String	Operation type.
confContent	String	Configuration file content.
status	String	Operation status.
updateAt	String	Update time. The format is ISO8601: CCYY-MM-DDThh:mm:ss.
errorMsg	String	Error information. If the operation status is success, the value of this parameter is null.
message	String	Content.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "actions" : [ {
    "id" : "e487cb83-1b30-435d-a11a-def463bbe9aa",
    "actionType" : "stop",
    "confContent" : "xxxxxxxx",
    "status" : "success",
    "updateAt" : "2021-09-29T02:44:44",
    "errorMsg" : "xxxxxxxx",
    "message" : {
      "keepAlive" : "0",
      "confNames" : "conf1"
    }
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.
400	Invalid request. The client should modify the request instead of re-initiating it.
409	The request cannot be processed due to a conflict. This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.
412	The server did not meet one of the preconditions contained in the request.