Obtaining the Task List of Parameter Configurations

Updated on 2025-05-22 GMT+08:00

View PDF

Function

This API is used to obtain the parameter configuration task list of a cluster.

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/ymls/joblists

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
start	No	Integer	Parameter description: The start value of the query. The default value is 1, indicating that the query starts from the first task. Constraints: N/A Options: 1-1000 Default value: 1
limit	No	Integer	Parameter description: Number of tasks to be queried. The default value is 10, indicating that 10 tasks are queried at a time. Constraints: N/A Options: 1-1000 Default value: 10

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
configList	Array of configListRsp objects	Parameter description: List of historical configuration changes

**Table 4** configListRsp
Parameter	Type	Description
id	String	Parameter description: Operation ID
clusterId	String	Parameter description: Cluster ID.
createAt	String	Parameter description: Creation time. Format: Unix timestamp.
status	String	Parameter description: Task execution status. Options: success: The task is successful. failed: The task failed. running: The task is being executed.
finishedAt	String	Parameter description: End time. If the creation has not been completed, the end time is null. Format: Unix timestamp.
modifyDeleteReset	String	Parameter description: History of parameter setting modifications.
failedMsg	String	Parameter description: Returned error message. If the status is success, the value of this parameter is null.

Example Requests

Obtaining the Parameter Configuration Task List of a Cluster

GET https://{Endpoint}/v1.0/{project_id}/clusters/{cluster_id}/ymls/joblists

Example Responses

Status code: 200

Request succeeded.

{
  "configList" : [ {
    "id" : "7ed7258a-60a8-46fe-8814-52819d491b80",
    "clusterId" : "4213d908-f5dc-4633-8401-cfd7175fca0c",
    "createAt" : 1633658735000,
    "status" : "success",
    "finishedAt" : null,
    "modifyDeleteReset" : "{\"modify\":{\"elasticsearch.yml\":{\"thread_pool.force_merge.size\":\"1\"}}}",
    "failedMsg" : ""
  } ]
}

Status Codes


Status Code	Description
200	Request succeeded.
400	Invalid request. Modify the request before retry.
409	The request could not be completed due to a conflict with the current state of the resource. The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.
412	The server did not meet one of the preconditions contained in the request.