获取自动作业模板列表
功能介绍
获取自动作业模板列表
URI
GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/auto-jobs
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
eihealth_project_id |
是 |
String |
平台项目ID，您可以在平台单击所需的项目名称，进入项目设置页面查看。 最小长度：1 最大长度：128 |
project_id |
是 |
String |
华为云项目ID，您可以从获取项目ID中获取。 最小长度：1 最大长度：128 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
limit |
否 |
Integer |
限制量，单次查询总量，必须由数字组成，默认为100，取值范围[1,1000] 最小值：1 最大值：1000 缺省值：100 |
offset |
否 |
Integer |
偏移量，查询起始偏移，必须由数字组成，默认为0，取值范围[0,100000000] 最小值：0 最大值：100000000 缺省值：0 |
sort_key |
否 |
String |
排序字段 |
sort_dir |
否 |
String |
排序方向，升序或降序，即ASC 和DESC 缺省值：DESC |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Language |
否 |
String |
Locale语言类型，zh_cn返回中文，en_us返回英文 缺省值：en_us 最小长度：1 最大长度：10 |
X-Auth-Token |
是 |
String |
用户Token。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，获取Token接口响应消息头中X-Subject-Token的值即为Token。 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
auto_jobs |
Array of AutoJobListDto objects |
自动作业列表 |
count |
Integer |
作业总数 |
参数 |
参数类型 |
描述 |
|---|---|---|
id |
String |
自动作业id |
name |
String |
自动作业的名称，取值范围：[1,63]，允许大小写字母、数字、以及特殊字符中划线(-) |
description |
String |
自动作业的描述, 取值范围：输入字符最大长度为255 |
labels |
Array of strings |
自动作业标签 |
priority |
Integer |
自动作业优先级，[0,9]，0表示最低，默认0 |
timeout |
Integer |
作业执行超时时长，取值范围: [1, 144000]，单位：分钟，默认数值1440 最小值：1 最大值：144000 |
status |
String |
自动作业状态 |
create_time |
String |
自动作业创建时间 |
finish_time |
String |
自动作业结束时间 |
failed_reason |
String |
失败原因，当自动作业执行失败时会返回，比如依赖的数据表，流程不存在等等 |
user_name |
String |
自动作业的创建者 |
tool_info |
ToolInfoDto object |
作业依赖的组件信息 |
database_id |
String |
自动作业依赖的数据表ID |
database_name |
String |
自动作业依赖的数据表名称 |
请求示例
无
响应示例
状态码： 200
OK
{
"auto_jobs" : [ {
"id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1",
"name" : "demo-job",
"description" : "description",
"labels" : [ "labelA", "labelB" ],
"priority" : 0,
"timeout" : 1440,
"status" : "SUCCEEDED",
"create_time" : "2021-01-30T02:53:26Z",
"finish_time" : "2021-01-30T02:53:26Z",
"failed_reason" : "Database does not exist.",
"user_name" : "gwj-test-01",
"tool_info" : {
"tool_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1",
"tool_name" : "demo-workflow",
"tool_version" : "1.0.0",
"tool_type" : "workflow"
},
"database_id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1",
"database_name" : "demo-database"
} ],
"count" : 1
}
状态码
状态码 |
描述 |
|---|---|
200 |
OK |
错误码
请参见错误码。
