Obtaining the Task List of Parameter Configurations

Function

This API is used to obtain the task list of parameter configurations.

Debugging

You can debug this API in . Automatic authentication is supported.

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, see Obtaining a Project ID and Name.

cluster_id

Yes

String

ID of the cluster to be queried

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameter

Parameter

Type

Description

configList

Array of configListRsp objects

List of historical configuration changes

Table 3 configListRsp

Parameter

Type

Description

id

String

Action 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 configuration modifications

failedMsg

String

Returned error message. If the status is success, the value of this parameter is null.

Request Example

None

Response Example

Status code: 200

The request is processed successfully.

{
  "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

The request is processed successfully.

400

Invalid request.

Modify the request instead of retrying.

409

The request cannot be processed due to a conflict.

This status code indicates that the resource that the client attempts to create already exists, or the request fails to be processed because of the update of the conflict request.

412

The server does not meet one of the requirements that the requester puts on the request.