更新时间:2026-09-02 GMT+08:00

获取参数配置任务列表

功能介绍

该接口可获取集群参数配置的任务操作列表,可以得到参数配置列表ID、集群ID、修改参数记录等。在完成集群创建之后,可以调用此接口,检查集群参数配置信息,确保集群正常运行。

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。获取方法请参见获取项目ID和名称。

约束限制:

不涉及

取值范围:

账户的项目ID。

默认取值:

不涉及

cluster_id

是

String

参数解释:

指定查询集群ID。获取方法请参见获取集群ID。

约束限制:

不涉及

取值范围:

集群ID。

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释:

指定查询起始值,默认值为1,即从第1个任务开始查询。

约束限制:

不涉及

取值范围:

大于或等于1

默认取值:

1

limit

否

Integer

参数解释:

指定查询个数,默认值为10,即一次查询10个任务信息。

约束限制:

不涉及

取值范围:

1-1000

默认取值:

10

请求参数

无

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

configList

Array of configListRsp objects

参数解释:

历史修改配置列表。

取值范围:

不涉及

totalSize

Integer

参数解释:

配置任务数量。

取值范围:

不涉及

表4 configListRsp

参数

参数类型

描述

id

String

参数解释:

配置列表ID。

取值范围:

不涉及

clusterId

String

参数解释:

集群ID。

取值范围:

不涉及

createAt

String

参数解释:

配置列表创建时间。

取值范围:

格式:Unix时间戳格式。

status

String

参数解释:

集群任务执行状态。

取值范围:

  • success: 执行成功。

  • failed: 执行失败。

  • running: 执行中。

finishedAt

String

参数解释:

结束时间,当创建未结束时结束时间为null。

取值范围:

格式:Unix时间戳格式。

modifyDeleteReset

String

参数解释:

修改参数配置记录。

取值范围:

不涉及

failedMsg

String

参数解释:

返回错误信息。当状态为success时该参数为null。

取值范围:

不涉及

instType

String

参数解释:

节点类型。

取值范围:

不涉及

请求示例

获取集群参数配置的任务列表。

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

响应示例

状态码:200

请求成功。

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

状态码

状态码

描述

200

请求成功。

400

非法请求。

建议直接修改该请求,不要重试该请求。

409

服务器在完成请求时发生冲突。

返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。

412

未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。

错误码

请参见错误码。