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

Updated on 2025-12-26 GMT+08:00

View PDF

Querying Operation Records

Function

This API is used to query operation records.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. Constraints: N/A Value range: Project ID of the account. Default value: N/A
cluster_id	Yes	String	Definition: ID of the cluster you want to query. For details about how to obtain the cluster ID, see Obtaining the Cluster ID. Constraints: N/A Value range: Cluster ID. Default value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	String	Definition: Start value of the query. The default value is 0. Constraints: N/A Value range: 0-1000 Default value: 0
limit	No	String	Definition: Number of records to query. The default value is 10, indicating that 10 records are queried at a time. Constraints: N/A Value range: 1-1000 Default value: 10

Request Parameters

None

Response Parameters

Status code: 200

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

**Table 4** actions
Parameter	Type	Description
id	String	Operation record ID.
actionType	String	Definition: Operation type. Value range: submit: indicates a submit operation. update: indicates an update operation. extensionStart: starts scale-out. modifyFlavorStart: starts flavor modification. start: starts an operation. stop: stops an operation.
confContent	String	Configuration file content.
status	String	Definition: Operation status. Value range: running success failed warn: warning
updateAt	String	Definition: Update time. Value range: The format is CCYY-MM-DDThh:mm:ss (ISO 8601).
errorMsg	String	Error information. If the operation status is success, the value of this parameter is null.
message	String	Content.

Example Requests

Query operation records.

GET https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/lgsconf/listactions

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.