更新时间:2023-12-29 GMT+08:00

查询任务列表和详情

功能介绍

查询任务列表和详情,默认查询任务列表。

URI

GET https://{Endpoint}/v3/{project_id}/jobs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一region下的project ID。获取方法请参见获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

id

String

任务ID。

start_time

String

查询开始时间,默认当前时间往前30天,格式为“yyyy-mm-ddThh:mm:ssZ”。

其中,T指某个时间的开始,Z指时区偏移量。

end_time

String

查询结束时间,默认当前时间,格式为“yyyy-mm-ddThh:mm:ssZ”,且大于查询开始时间,时间跨度不超过30天。

其中,T指某个时间的开始,Z指时区偏移量。

status

String

任务状态。取值为“Running”为执行中。取值为“Completed”为完成。取值为“Failed”为失败。

name

String

任务名称。对应取值如下:

  • "CreateInstance":创建实例。
  • "RestoreNewInstance":恢复到新实例。
  • "EnlargeInstance":扩容实例。
  • "ReduceInstance":缩容实例。
  • "RestartInstance":重启实例。
  • "RestartNode":重启节点。
  • "EnlargeInstanceVolume":扩容实例磁盘。
  • "ReduceInstanceVolume":缩容实例磁盘。
  • "ResizeInstance":规格变更实例。
  • "UpgradeDbVersion":升级数据库版本。
  • "BindPublicIP":绑定公网IP。
  • "UnbindPublicIP":解绑公网IP。
  • "DeleteInstance":删除实例。
  • "EnlargeInstanceColdVolume":扩容实例冷存储。
  • "AddInstanceColdVolume":增加实例冷存储。
  • "ModifySecurityGroup":修改安全组。
  • "ModifyCcmCert":修改CCM证书。
  • "ModifyPort":修改端口。
  • "ConstructDisasterRecovery":构造容灾关系。
  • "DeConstructDisasterRecovery":解除容灾关系。
  • "SwitchOverDisasterRecovery":切换容灾关系。
  • "BuildBiActiveInstance":构建双活实例。
  • "ReleaseBiActiveInstance":解除双活实例关系。
  • "BackupInstance":备份实例。

offset

Integer

索引位置,偏移量。

从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。

limit

Integer

查询记录数。取值10,20,50 ,默认为50。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

jobs

Array of 表5 objects

任务列表。

total_count

Integer

任务列表总数。

表5 JobDetail

参数

参数类型

描述

id

String

任务ID。

name

String

任务名称。

status

String

任务执行状态。取值: Running:表示任务正在执行。 Completed:表示任务执行成功。 Failed:表示任务执行失败。

start_time

String

创建时间,格式为“yyyy-mm-ddThh:mm:ssZ”。

其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。

end_time

String

结束时间,格式为“yyyy-mm-ddThh:mm:ssZ”。

其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。

progress

String

任务执行进度。

说明:

执行中状态才返回执行进度,例如“60%”,表示任务执行进度为60%,否则返回“”。

instance

表6 object

任务关联的实例信息。

fail_reason

String

任务执行失败时的错误信息。

表6 JobInstanceInfo

参数

参数类型

描述

id

String

实例ID。

name

String

实例名称。

请求示例

  • URI样例
    GET https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/jobs?id=89a0cde6-9c46-4b89-a92c-573e1083ff23

响应示例

状态码: 200

Success

{ 
  "total_count" : 1, 
  "jobs" : [ { 
    "id" : "6f85e061-04dd-42e7-86d6-d3b1e40aac2e", 
    "name" : "CreateCassandra", 
    "status" : "Running", 
    "start_time" : "2023-09-12T06:44:01+0000", 
    "end_time" : "2023-09-12T06:44:03+0000", 
    "progress" : "14%", 
    "instance" : { 
      "id" : "27a045b6bf9e46f691f81366d398cb04in06", 
      "name" : "nosql-12f5" 
    }, 
    "fail_reason" : "" 
  } ] 
}

状态码

请参见状态码

错误码

请参见错误码