Updated on 2026-09-02 GMT+08:00

Querying Operation Records

Function

This API is used to query Logstash configuration 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, see Obtaining the Project ID and Name. Constraints N/A Range The value is a 32-character string consisting of lowercase letters and digits. Default Value N/A
cluster_id	Yes	String	Definition ID of the cluster to query. For details about how to obtain the cluster ID, see Obtaining the Cluster ID. Constraints UUID format, 36 characters. Range N/A Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	String	Definition Specifies the starting position in pagination queries. Offset starts from 0. Constraints N/A Range Greater than or equal to 0. Default Value 0
limit	No	String	Definition Number of records returned per page in pagination queries. Constraints N/A Range 1 to 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	Definition List of operation records. Each element is an action object, including the operation record ID, operation type, configuration file content, operation status, update time, error information, and operation record content.
totalSize	Integer	Definition Total number of operation records. Range N/A

**Table 4** actions
Parameter	Type	Description
id	String	Definition Operation record ID. Range N/A
actionType	String	Definition Operation type. Range submit: Submit. update: Update. extensionStart: Start capacity expansion. modifyFlavorStart: Start horizontal flavor change. start: Start. stop: Stop.
confContent	String	Definition Configuration file content. Range N/A
status	String	Definition: Operation status. Value range: running success failed warn: warning
updateAt	String	Definition Update time. The format is ISO8601: CCYY-MM-DDThh:mm:ss. Range N/A
errorMsg	String	Definition Error message. This field is null when the operating status is success. Range N/A
message	String	Definition Operation record content. Range N/A

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" : null,
    "message" : "{\"keepAlive\":\"1\",\"confNames\":\"es-11\"}"
  } ],
  "totalSize" : 1
}

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.

Error Codes

See Error Codes.

Parent topic: Logstash