查询日志备份任务列表
功能介绍
该接口用于查询集群的日志备份任务记录列表。如果集群曾经打开过日志备份的开关,并且触发过日志备份任务,则可以通过该接口查询日志备份任务记录列表,方便客户查询对集群的操作过程。
调用方法
请参见如何调用API。
URI
GET /v1.0/{project_id}/clusters/{cluster_id}/logs/records
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID。获取方法请参见获取项目ID和名称。 约束限制: 不涉及 取值范围: 账户的项目ID。 默认取值: 不涉及 |
|
cluster_id |
是 |
String |
参数解释: 指定查询集群ID。获取方法请参见获取集群ID。 约束限制: 不涉及 取值范围: 集群ID。 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
参数解释: 指定查询集群日志备份记录起始值,默认值为1,即从第1条日志记录开始查询。 约束限制: 不涉及 取值范围: 1-1000 默认取值: 1 |
|
limit |
否 |
Integer |
参数解释: 指定查询集群日志记录个数,默认值为10,即一次查询10条集群日志信息。 约束限制: 不涉及 取值范围: 1-1000 默认取值: 10 |
|
status |
否 |
String |
参数解释: 指定查询的日志任务状态,未设置该参数时,查询集群的全部日志任务记录列表。 约束限制: 不涉及 取值范围:
默认取值: 空字符串,查询所有状态的任务。 |
请求参数
无
响应参数
状态码: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。 取值范围: 不涉及 |
请求示例
查询前10个日志备份任务列表
GET https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/logs/records
响应示例
状态码: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 |
未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。 |
错误码
请参见错误码。