This is an automated email from the ASF dual-hosted git repository.
fanjia pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/seatunnel.git
The following commit(s) were added to refs/heads/dev by this push:
new e1211c73b0 [Doc] update rest api document (#6586)
e1211c73b0 is described below
commit e1211c73b0bfdc9e92c43b84b59fa5bce3aab86d
Author: Jarvis <[email protected]>
AuthorDate: Wed Mar 27 20:21:22 2024 +0800
[Doc] update rest api document (#6586)
---
docs/zh/seatunnel-engine/rest-api.md | 26 ++++++++++++++++++++------
1 file changed, 20 insertions(+), 6 deletions(-)
diff --git a/docs/zh/seatunnel-engine/rest-api.md
b/docs/zh/seatunnel-engine/rest-api.md
index a3f8d10d19..28a81c548d 100644
--- a/docs/zh/seatunnel-engine/rest-api.md
+++ b/docs/zh/seatunnel-engine/rest-api.md
@@ -91,8 +91,6 @@ network:
"jobId": "",
"jobName": "",
"jobStatus": "",
- "envOptions": {
- },
"createTime": "",
"jobDag": {
"vertices": [
@@ -100,13 +98,29 @@ network:
"edges": [
]
},
- "pluginJarsUrls": [
- ],
- "isStartWithSavePoint": false,
"metrics": {
"sourceReceivedCount": "",
"sinkWriteCount": ""
- }
+ },
+ "finishedTime": "",
+ "errorMsg": null,
+ "envOptions": {
+ },
+ "pluginJarsUrls": [
+ ],
+ "isStartWithSavePoint": false
+}
+```
+
+`jobId`, `jobName`, `jobStatus`, `createTime`, `jobDag`, `metrics` 字段总会返回.
+`envOptions`, `pluginJarsUrls`, `isStartWithSavePoint` 字段在Job在RUNNING状态时会返回
+`finishedTime`, `errorMsg` 字段在Job结束时会返回，结束状态为不为RUNNING，可能为FINISHED，可能为CANCEL
+
+当我们查询不到这个Job时，返回结果为：
+
+```json
+{
+ "jobId" : ""
}
```
