查询作业列表
功能介绍
该接口用于查询具体某个集群的日志任务记录列表。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。
URI
GET /v1.0/{project_id}/clusters/{cluster_id}/logs/records
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。获取方法请参见获取项目ID和名称。 |
|
cluster_id |
是 |
String |
指定查询集群ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
start |
否 |
Integer |
指定查询起始值，默认值为1，即从第1个任务开始查询。 |
|
limit |
否 |
Integer |
指定查询个数，默认值为10，即一次查询10个任务信息。 |
|
status |
否 |
String |
指定查询的日志任务状态，未设置该参数时，查询集群的全部日志任务记录列表。 FAIL 日志任务失败状态 NOT_FAIL 日志任务运行或成功状态 |
请求参数
无
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
clusterLogRecord |
Array of clusterLogRecord objects |
集群日志记录实体对象。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
日志任务ID，通过系统UUID生成。 |
|
clusterId |
String |
集群ID。 |
|
createAt |
String |
创建时间。格式：Unix时间戳格式。 |
|
logPath |
String |
日志在OBS桶中的备份路径。 |
|
status |
String |
任务状态。
|
|
finishedAt |
Long |
结束时间，当创建未结束时结束时间为null。格式：Unix时间戳格式。 |
|
jobTypes |
String |
任务类型。
|
|
failedMsg |
String |
错误信息。当任务状态没有处于失败状态时该字段为null。 |
|
jobId |
String |
任务ID。 |
请求示例
无
响应示例
状态码： 200
请求已成功。
{
"clusterLogRecord" : [ {
"id" : "d455a541-597e-4846-a6be-baad0ea361b1",
"clusterId" : "4213d908-f5dc-4633-8401-cfd7175fca0c",
"createAt" : 1656042837000,
"logPath" : "css-backup-1610678043608/css/log",
"status" : "RUNNING",
"finishedAt" : null,
"jobTypes" : "Manual",
"failedMsg" : null,
"jobId" : "2c9080df7c171342017c5e0884f8011c"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功。 |
|
400 |
非法请求。 建议直接修改该请求，不要重试该请求。 |
|
409 |
服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 |
|
412 |
未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 |
错误码
请参见错误码。
