文档首页> 云搜索服务 CSS> API参考> 参数配置接口> 获取参数配置任务列表
更新时间:2024-04-22 GMT+08:00

获取参数配置任务列表

功能介绍

该接口可获取参数配置的任务操作列表。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

cluster_id

String

指定查询集群ID。

表2 Query参数

参数

是否必选

参数类型

描述

start

Integer

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

limit

Integer

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

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

configList

Array of configListRsp objects

历史修改配置列表。

表4 configListRsp

参数

参数类型

描述

id

String

操作ID

clusterId

String

集群ID。

createAt

String

创建时间。格式:Unix时间戳格式。

status

String

任务执行状态。

  • true: 执行成功。

  • false: 执行失败。

finishedAt

String

结束时间,当创建未结束时结束时间为null。格式:Unix时间戳格式。

modifyDeleteReset

String

修改参数配置记录。

failedMsg

String

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

请求示例

响应示例

状态码: 200

请求已成功。

{
  "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" : ""
  } ]
}

状态码

状态码

描述

200

请求已成功。

400

非法请求。

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

409

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

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

412

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

错误码

请参见错误码