Obtaining the Task List of Parameter Configurations¶

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	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.

**Table 2** Query Parameters¶
Parameter	Mandatory	Type	Description
start	No	Integer	The start value of the query. The default value is 1, indicating that the query starts from the first task.
limit	No	Integer	Number of task to be queried. The default value is 10, indicating that the information about 10 tasks is queried at a time.

Request Parameters¶

None

Response Parameters¶

Status code: 200

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

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

Example Requests¶

None

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.

Error Codes¶

See Error Codes.

last updated: 2024-11-27 11:29 UTC - commit: b6cfaea6ecb36562dcaab59e2cab1c4b61be822b