# 服务信息
# 获取服务
接口说明
查询所有服务，仅返回服务基本属性。
请求示例
http:///ginsight/service/all
curl --location -g --request GET 'http:///ginsight/service/all'
返回示例
成功
{
"code": 200,
"msg": "成功",
"data": {
"totalCount": 7,
"items": [
{
"id": "8a1be006-5871-4a65-9afb-08be9636d2cc",
"name": "SRV_Test",
"alias": "测试",
"desc": "测试",
"categoryId": "0",
"username": null,
"model Id": "32054438-7f66-49dd-8d67-03912ec29ad3",
"workflow": true,
"createTime": "2022-08-01 14:50:53",
"state": "Registered",
"web url": null,
"tag": null,
"score": 0,
"extraData": null,
"publicParamMetas": null,
"templateTask": null
},
{
"id": "46387322-cb94-410f-9926-8259bc8a04d0",
"name": "SRV_sssssss",
"alias": "ssssss",
"desc": "ssssss",
"categoryId": "C0001001-184a-4810-b594-b999c999e004",
"username": null,
"model Id": "14eaf2bc-f50a-428d-ad8c-efe055aa897f",
"workflow": true,
"createTime": "2022-08-02 16:29:16",
"state": "Registered",
"web url": null,
"tag": null,
"score": 0,
"extraData": null,
"publicParamMetas": null,
"templateTask": null
},
{
"id": "a4cd27c5-b921-4cdc-bf7e-584c80c0905a",
"name": "SRV_11111",
"alias": "1111",
"desc": "11111",
"categoryId": "0",
"username": null,
"model Id": "14eaf2bc-f50a-428d-ad8c-efe055aa897f",
"workflow": true,
"createTime": "2022-08-02 16:33:19",
"state": "Registered",
"web url": null,
"tag": null,
"score": 0,
"extraData": null,
"publicParamMetas": null,
"templateTask": null
},
{
"id": "416c2401-a813-4841-bc12-08cfbb5c4dff",
"name": "SRV_ceshi0803",
"alias": "ceshi0803",
"desc": "ceshi0803",
"categoryId": "0",
"username": null,
"model Id": "84428f3f-c89e-46f0-a33a-95ce2f848f30",
"workflow": true,
"createTime": "2022-08-03 10:56:58",
"state": "Registered",
"web url": null,
"tag": null,
"score": 0,
"extraData": null,
"publicParamMetas": null,
"templateTask": null
},
{
"id": "2b84e658-7e98-4c37-b9bb-6d3eabf2d7e6",
"name": "SRV_pgOverlay",
"alias": "pg 叠加分析服务",
"desc": "pg 叠加分析服务",
"categoryId": "0",
"username": null,
"model Id": "84428f3f-c89e-46f0-a33a-95ce2f848f30"
"workflow": true,
"createTime": "2022-08-03 15:51:26",
"state": "Registered",
"web url": null,
"tag": null,
"score": 0,
"extraData": null,
"publicParamMetas": null,
"templateTask": null
},
{
"id": "2e199641-b64d-4c30-87bf-992fc016ba8c",
"name": "SRV_2",
"alias": "2",
"desc": "2",
"categoryId": "0",
"username": null,
"model Id": "8080feed-b7f2-4a5b-a839-dbc7e27623f9"
"workflow": false,
"createTime": "2022-08-05 17:23:12",
"state": "Registered",
"web url": null,
"tag": null,
"score": 0,
"extraData": null,
"publicParamMetas": null,
"templateTask": null
},
{
"id": "6b75ac4f-b433-4835-8413-947dbc8b4577",
"name": "SRV_toDB_Test",
"alias": "导入数据库测试",
"desc": "导入数据库测试试验",
"categoryId": "0",
"username": null,
"model Id": "a8ed7484-eecc-41b0-af59-8dc74c753fef"
"workflow": true,
"createTime": "2022-08-08 10:08:36",
"state": "Registered",
"web url": null,
"tag": null,
"score": 0,
"extraData": null,
"publicParamMetas": null,
"templateTask": null
}
]
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 按照分页获取服务
接口说明
分页加载服务列表，仅返回服务基本属性。
当请求的分页记录超出最大记录个数时， 自动返回最后一页。
支持过滤条件：String categoryId, String name
请求示例
curl --location -g --request GET
'http:///ginsight/service/page?pageId=1&pageSize=10'
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| pageId | query | string | 否 | none |
| pageSize | query | query | query | query |
| categoryId | query | query | query | query |
| name | query | query | query | query |
返回示例
成功
{
"code": 200,
"msg": "成功",
"data": {
"page": 1,
"count": 7,
"pageSize": 10,
"totalCount": 7,
"rows": [
{
"id": "6b75ac4f-b433-4835-8413-947dbc8b4577",
"name": "SRV_toDB_Test",
"alias": "导入数据库测试",
"desc": "导入数据库测试试验",
"categoryId": "0",
"username": null,
"model Id": "a8ed7484-eecc-41b0-af59-8dc74c753fef",
"workflow": true,
"createTime": "2022-08-08 10:08:36",
"state": "Registered",
"web url": null,
"tag": null,
"score": 0,
"extraData": null,
"publicParamMetas": null,
"templateTask": null
},
{
"id": "2e199641-b64d-4c30-87bf-992fc016ba8c",
"name": "SRV_2",
"alias": "2",
"desc": "2",
"categoryId": "0",
"username": null,
"model Id": "8080feed-b7f2-4a5b-a839-dbc7e27623f9",
"workflow": false,
"createTime": "2022-08-05 17:23:12",
"state": "Registered",
"web url": null,
"tag": null,
"score": 0,
"extraData": null,
"publicParamMetas": null,
"templateTask": null
},
{
"id": "2b84e658-7e98-4c37-b9bb-6d3eabf2d7e6",
"name": "SRV_pgOverlay",
"alias": "pg 叠加分析服务",
"desc": "pg 叠加分析服务",
"categoryId": "0",
"username": null,
"model Id": "84428f3f-c89e-46f0-a33a-95ce2f848f30"
"workflow": true,
"createTime": "2022-08-03 15:51:26",
"state": "Registered",
"web url": null,
"tag": null,
"score": 0,
"extraData": null,
"publicParamMetas": null,
"templateTask": null
},
{
"id": "416c2401-a813-4841-bc12-08cfbb5c4dff",
"name": "SRV_ceshi0803",
"alias": "ceshi0803",
"desc": "ceshi0803",
"categoryId": "0",
"username": null,
"model Id": "84428f3f-c89e-46f0-a33a-95ce2f848f30"
"workflow": true,
"createTime": "2022-08-03 10:56:58",
"state": "Registered",
"web url": null,
"tag": null,
"score": 0,
"extraData": null,
"publicParamMetas": null,
"templateTask": null
},
{
"id": "a4cd27c5-b921-4cdc-bf7e-584c80c0905a",
"name": "SRV_11111",
"alias": "1111",
"desc": "11111",
"categoryId": "0",
"username": null,
"model Id": "14eaf2bc-f50a-428d-ad8c-efe055aa897f"
"workflow": true,
"createTime": "2022-08-02 16:33:19",
"state": "Registered",
"web url": null,
"tag": null,
"score": 0,
"extraData": null,
"publicParamMetas": null,
"templateTask": null
},
{
"id": "46387322-cb94-410f-9926-8259bc8a04d0",
"name": "SRV_sssssss",
"alias": "ssssss",
"desc": "ssssss",
"categoryId": "C0001001-184a-4810-b594-b999c999e004",
"username": null,
"model Id": "14eaf2bc-f50a-428d-ad8c-efe055aa897f",
"workflow": true,
"createTime": "2022-08-02 16:29:16",
"state": "Registered",
"web url": null,
"tag": null,
"score": 0,
"extraData": null,
"publicParamMetas": null,
"templateTask": null
},
{
"id": "8a1be006-5871-4a65-9afb-08be9636d2cc",
"name": "SRV_Test",
"alias": "测试",
"desc": "测试",
"categoryId": "0",
"username": null,
"model Id": "32054438-7f66-49dd-8d67-03912ec29ad3",
"workflow": true,
"createTime": "2022-08-01 14:50:53",
"state": "Registered",
"web url": null,
"tag": null,
"score": 0,
"extraData": null,
"publicParamMetas": null,
"templateTask": null
}
]
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 查询服务详情
接口说明
查询服务详细内容，返回完整服务属性及参数。
请求示例
http:///ginsight/service/get?id=6f1846be-e407-4775-9d96- a389510af333
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| id | query | string | 否 | none |
返回示例
成功
{
"code": 500,
"msg": "Atlas 后台服务出现异常<GANotFound Exception>: 未找到计算服务：6f1 846be-e407-4775-9d96-a389510af333",
"data": null
}
2
3
4
5
6
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 搜索服务
接口说明
搜索满足条件的服务，分页返回结果。 过滤条件为可选参数，支持过滤的字段：
name, tag, state, categoryId, score name： 按照名称或别名进行模糊匹配；
flag: 标 签模糊匹配；
state：枚举常量；
egistered | enabled | disabled 精确匹配；
score：查 找评分大于或小于当前值的服务，正数表示大于，负数表示小于；
categoryId: 查找 指定分组的服务，精确匹配；分页参数可选，默认返回第一页，分页大小为 10。
请求示例
http:///ginsight/service/search?name=tool&tag=&state=&categoryId=&score=&pageId=1&pageSize=10
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| name | query | string | 否 可选 | 服务名过滤，不区分大小写 |
| tag | query | string | 否 可选 | 服务标签过滤 |
| state | query | string | 否 可选 | 服务状态过滤。支持的状态有： registered |
| categoryId | query | string | 否 可选 | 服务目录过滤，精确匹配 |
| score | query | string | 否 可选 | 服务评分过滤。正数表示选择大于评分的服务，负数表示小于评分的。 |
| pageId | query | string | 否 可选 | 返回的页码，默认 1 |
| pageSize | query | string | 否 可选 | 分页大小。默认 10 |
返回示例
成功
{
"code": 200,
"msg": "成功",
"data": {
"totalCount": 0,
"items": null
}
}
2
3
4
5
6
7
8
9
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 名称查重
接口说明
用于判断是否已存在同名服务，返回值 true 或 false。
请求示例
http:///ginsight/service/exists?name=SRV_Tool5s
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| name | query | string | 否 | 服务名称，精确匹配 |
返回示例
成功
false
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 查询服务所有参数
接口说明
返回的参数列表按照模板 Job 进行分组，返回的参数信息中：
1. actionId 字段表示关联的工作流顶点 ID；
2. 参数的 vid 字段与 actionId 相同。
请求示例
http:///ginsight/service/allparams?id=6c3a6597-b3dd-43a2- a79b-54cc1624d798
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| id | query | string | 否 | 服务ID |
返回示例
成功
{
"code": 200,
"msg": "成功",
"data": {
"totalCount": 2,
"items": [
{
"job Id": "938774ff-9581-4a02-ba90-28b1f3368176",
"jobName": "上一步结果与专题图层求交",
"actionId": "a52e7832-968c-438e-8179-4e99bf27ed21",
"paramList": [
{
"pid": "a52e7832-968c-438e-8179-4e99bf27ed21",
"name": "Operator",
"value": "Intersection",
"open": false,
"dataset": false,
"result": false,
"proto": {
"id": "275e8d51-8f79-4658-93ac-a4d25c80b9db",
"name": "Operator",
"alias": "叠加算法",
"desc": "计算两个图层的空间几何相交部分，两图层的图形互相分割",
"categoryId": "a5073b56-6b65-4955-b317-360724158f10",
"paramType": "String",
"direction": "Input",
"defaultValueString": "Intersection",
"order": 0,
"required": true,
"datasetRelated": false
}
}
]
}
]
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 获取服务公开参数
GET /ginsight/service/openparammetas
接口说明
返回的categoryId 字段表示对应的工作流顶点 ID。
请求示例
http:///ginsight/service/openparammetas?id=6c3a6597- b3dd-43a2-a79b-54cc1624d798
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| id | query | string | 否 | 服务ID |
返回示例
成功
{
"code": 200,
"msg": "成功",
"data": {
"totalCount": 2,
"items": [
{
"id": "5558c270-4f0d-4348-925b-1acd3ed9de8d",
"name": "InputLayer",
"alias": "源图层",
"desc": null,
"categoryId": "2a80d02c-6f5c-437e-8476-b036d998a44f",
"valueString": "postgresql://atlas:atlas@172.16.83.221:5432/gis?
layername=dltb_13",
"serviceId": "6c3a6597-b3dd-43a2-a79b-54cc1624d798",
"protoId": "d932c71a-0b8a-44e0-b304-955f16bbea48",
"effect": "MotherVariable",
"must": true,
"datasource": true,
"result": false,
"order": 1
}
]
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 获取分析服务结果参数列表
接口说明
返回的参数 pid 字段表示对应的 Job 的 ID。
请求示例
http:///ginsight/service/resultparams?svcid=6c3a6597-b3dd- 43a2-a79b-54cc1624d798&taskid=xxx
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| svcid | query | string | 否 | 服务ID |
| taskid | query | string | 否 | 分析任务 ID |
返回示例
成功
{
"code": 500,
"msg": "Atlas 后台服务出现异常<GANotFound Exception>: 未找到计算服务：6c3 a6597-b3dd-43a2-a79b-54cc1624d798",
"data": null
}
2
3
4
5
6
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 删除服务
接口说明
删除已有的分析服务。
请求示例
http:///ginsight/service/delete?id=6f1846be-e407-4775- 9d96-a389510af333
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| id | query | string | 否 | 服务ID |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 创建服务
接口说明
创建一个新的分析服务。
id 字段：服务 ID ，新建服务时不需要传或者设置为空。
cstype 字段： 服务底层模型类型。枚举值： Workflow （基于工作流） ，Plugin （基于插件算子）。
参数列表中的vid 字段： 必须为工作流节点 ID。
请求示例
curl --location -g --request POST
'http://{{ginsight}}/ginsight/service/create' \
--data-raw '{
"name": "GHPC_ANA_WEB",
"alias": "GHPC 测试分析服务",
"desc": "GHPC 测试分析服务",
"categoryId": "C2021",
"modelId": "ff2d44ad-5335-4a08-ab9f-d5dbb3278017",
"cstype": "Workflow",
"csparams": [
{
"vid": "aff03f58-dd16-eb0a-9254-dad05c7d945b",
"pname": "IntervalTime",
"pvalue": "5",
"open": true,
"dataset": true,
"result": false
}
]
}'
Body 请求参数
|-
{
"name": "GHPC_ANA_WEB",
"alias": "GHPC 测试分析服务",
"desc": "GHPC 测试分析服务",
"categoryId": "C2021",
"model Id": "ff2d44ad-5335-4a08-ab9f-d5dbb3278017",
"cstype": "Workflow",
"csparams": [
{
"vid": "aff03f58-dd16-eb0a-9254-dad05c7d945b",
"pname": "IntervalTime",
"pvalue": "5",
"open": true,
"dataset": true,
"result": false
}
]
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| body | body | string | 否 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 修改分析服务基本属性
接口说明
支持修改：名称、别名、描述、分组 id 等属性。 id 字段：标识要修改的服务 ID。 不能为空。
请求示例
http:///ginsight/service/modify
{
"id": "11234",
"name": null,
"alias": null,
"desc": null,
"categoryId": null
}
2
3
4
5
6
7
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| body | body | string | 否 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 修改分析服务参数
接口说明
参数列表中的vid 字段： 必须为工作流节点 ID。
请求示例
http:///ginsight/service/updateparams
Body 请求参数
|-
{
"id": "0bfce7be-893d-4e58-bfc6-c40d5df5abad",
"csparams": [
{
"vid": null,
"pname": null,
"pvalue": null,
"open": false,
"dataset": false,
"result": false
}
]
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| body | body | string | 否 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 分析信息
# 执行在线分析服务
接口说明
通过服务名称执行在线分析服务。
请求体传入实际的参数值 JSON 。主要面向工作流服务，每项参数名称可能会重 复，需要通过vid 和 name 组合来标识。
vid 字段： 所关联的工作流顶点 ID；
pname 字段： 参数名称；
pvalue 字段： 参数值。
请求示例
http:///ginsight/analysis/SVC_ABC_001
Body 请求参数
> -
[
{
"vid": "5ccb148f-d348-40e4-89c8-e18e53656d66",
"pname": "atlas.data.base.identity",
"pvalue": "jdbc:postgresql://postgres/123@172.16.15.57:5432/kjk
/public.gmh result1"
},
{
"vid": "e26d1ee0-bfde-4328-b18d-82004066f17c",
"pname": "atlas.process.dissolve.group.fields",
"pvalue": "r hid"
},
{
"vid": "88975ea1-b0d9-400b-8e5c-9068ab4db33c",
"pname": "atlas.data.result.identity",
"pvalue": "spark:result"
}
]
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| body | body | string | 否 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# **根据 ID 执行在线分析服务 **
接口说明
{SVC_ID} 服务 ID 在请求 URL 路径中传入。
请求 Body：传入实际的参数值JSON。通常主要面向工作流服务，每项参数与工作流节点关联，通过vid 和 name 组合唯 一标识。name 可能有重名，无法作为唯一标识。
vid 字段： 所关联的工作流顶点 ID；
pname 字段：参数名称；
pvalue 字段：参数值。
请求示例
http:// /ginsight/analysis/execute/a9e4dba0-c3e3-482f-8f67-627d3a2e4916
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 查看服务 API 列表缓存
接口说明
查看服务 API 列表缓存
请求示例
http:///ginsight/analysis/cache/list
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 刷新服务 API 列表缓存
接口说明
刷新服务 API 列表缓存
请求示例
http:///ginsight/analysis/cache/refresh
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 查看在线分析服务实例ID
GET /ginsight/analysis/instance/id
接口说明
查看在线分析服务实例 ID
请求示例
http:///ginsight/analysis/instance/id
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# **POST **分析样例
请求示例
POST /172.16.15.57:7040/atlas/service/SRV_overlay12
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 任务信息
# 获取所有任务
接口说明
获取所有任务
请求示例
http:///ginsight/task/all
返回示例
成功
{
"code": 200,
"msg": "成功",
"data": {
"totalCount": 297,
"items": [
{
"id": "ad6be580-6d15-42a5-b778-48ae200f02fe",
"name": "SRV_pgpool-0809.103950.584",
"timeout": 0,
"createTime": "2022-08-09 10:39:50",
"startTime": "2022-08-09 10:49:53",
"endTime": "2022-08-09 10:50:30",
"state": "Finished",
"succeed": true,
"progress": 100,
"priority": 0,
"username": "system",
"workflowId": "84428f3f-c89e-46f0-a33a-95ce2f848f30",
"serviceId": "9c5905c0-6545-48fe-8711-dce9f8056f39",
"jobs": [],
"taskType": "Workflow",
"strategy": "TSS_Workflow",
"tag": null,
"web url": null,
"jobCount": 0,
"empty": true,
"elapsedSeconds": 37
},
{
"id": "fb0c01d1-771c-4109-b22c-c47489e37c40",
"name": "SRV_pgpool-0809.103336.751",
"timeout": 0,
"createTime": "2022-08-09 10:33:36",
"startTime": "2022-08-09 10:39:06",
"endTime": "2022-08-09 10:39:07",
"state": "Finished",
"succeed": false,
"progress": 75,
"priority": 0,
"username": "system",
"workflowId": "84428f3f-c89e-46f0-a33a-95ce2f848f30",
"serviceId": "9c5905c0-6545-48fe-8711-dce9f8056f39",
"jobs": [],
"taskType": "Workflow",
"strategy": "TSS_Workflow",
"tag": null,
"web url": null,
"jobCount": 0,
"empty": true,
"elapsedSeconds": 1
}
]
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 获取任务详情
接口说明
获取任务详情
请求示例
http:///ginsight/task/get?id=ad6be580-6d15-42a5-b778- 48ae200f02fe
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| id | query | string | 否 | 任务id |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 分页获取任务
接口说明
分页获取任务。
请求示例
http:///ginsight/task/page?pageId=1&pageSize=10
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| pageId | query | string | 否 | 默认1 |
| pageSize | query | string | 否 | 默认10 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 搜索任务
接口说明
支持按名称和状态过滤。 state 支持的枚举值： initial | running | succeed | failed。
请求示例
http:///ginsight/task/search?name=&state=&pageId=1&page Size=10
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| name | query | string | 否 | 过滤任务名称 |
| state | query | string | 否 | 过滤任务状态，可选值为： initial |
| pageId | query | string | 否 | 默认1 |
| pageSize | query | string | 否 | 默认10 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 查找列表中的任务
接口说明
查找列表中指定的多个任务，仅返回基本属性。
请求示例
http:///ginsight/task/tasklist?ids=1,2,4
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| ids | query | string | 否 | 任务ID列表，多个ID用逗号拼接 |
返回示例
成功
{
"code": 200,
"msg": "成功",
"data": {
"totalCount": 0,
"items": null
}
}
2
3
4
5
6
7
8
9
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 目录信息
# 查询所有的服务目录
接口说明
查询所有的服务目录。
请求示例
http:///ginsight/service/categories
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 批量删除服务目录
接口说明
批量删除服务目录。支持最少一个目录。
请求示例
http:///ginsight/service/deletecats?cids=id1,id2,id3
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| cids | query | string | 否 | 需要删除的服务目录 ID 列表， 目录 ID 之间用逗号分隔，只有一个目录 ID 时不需要逗号。 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 删除指定的服务目录
接口说明
删除指定的服务目录。
目录 ID 作为请求 URL 路径的一部分传递。
请求示例
http:///ginsight/service/deletecategory/{cateId}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| cated | path | string | 是 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 新建服务目录
接口说明
新建一个服务目录
请求示例
http:///ginsight/service/addcategory
Body 请求参数
|-
{
"name": "耕地保护",
"desc": "耕地保护业务具体信息描述",
"order": 1,
"logo": ""
}
2
3
4
5
6
7
8
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| body | body | string | 是 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 更新服务目录
接口说明
更新一个服务目录
请求示例
http:///ginsight/service/updatecategory
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 统计信息
# 获取服务总数
接口说明
查询所有服务的总个数
请求示例
http:///ginsight/service/count
返回示例
成功
{
"code": 200,
"msg": "成功",
"data": 11
}
2
3
4
5
6
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 获取每个目录下的服务数量
接口说明
查询各个目录下的服务个数
请求示例
http:///ginsight/service/countbycategory
返回示例
成功
{
"code": 200,
"msg": "成功",
"data": {
"totalCount": 3,
"items": [
{
"cid": "C0001001-184a-4810-b594-b999c999e003",
"cname": "统计分析",
"count": 2
},
{
"cid": "0",
"cname": "基础分析",
"count": 8
},
{
"cid": "C0001001-184a-4810-b594-b999c999e004",
"cname": "调查评价",
"count": 1
}
]
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 获取服务调用次数
接口说明
统计某个服务的历史任务个数（即服务的调用次数）
请求示例
http:///ginsight/service/counttasks?id=svc_id
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| id | query | string | 否 | 服务ID |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 获取单个服务的任务统计指标
接口说明
统计单个服务的历史任务汇总指标
请求示例
http:///ginsight/service/statistic?id=svc_id
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| id | query | string | 否 | 服务ID |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 获取所有服务的任务统计指标
接口说明
统计全部服务的历史任务汇总指标
请求示例
http:///ginsight/service/overviewstatistic
返回示例
成功
{
"code": 200,
"msg": "成功",
"data": {
"timesCalled": 85,
"timesResultDownloaded": 85,
"successRate": 57,
"avgSecondsElapsed": 30
}
}
2
3
4
5
6
7
8
9
10
11
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 获取热门服务
接口说明
统计热门服务并返回排名靠前的 N 条记录
默认按照调用次数来统计。
请求示例
http:///ginsight/service/hotservices?topn=5
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| topn | query | string | 否 | 返回前n条，默认值5 |
返回示例
成功
{
"code": 200,
"msg": "成功",
"data": {
"totalCount": 9,
"items": [
{
"serviceId": "8a1be006-5871-4a65-9afb-08be9636d2cc",
"serviceName": "SRV_Test",
"serviceAlias": "测试",
"taskCount": 36
},
{
"serviceId": "2b84e658-7e98-4c37-b9bb-6d3eabf2d7e6",
"serviceName": "SRV_pgOverlay",
"serviceAlias": "pg 叠加分析服务",
"taskCount": 26
},
{
"serviceId": "9c5905c0-6545-48fe-8711-dce9f8056f39",
"serviceName": "SRV_pgpool",
"serviceAlias": "pg 数据库连接池测试",
"taskCount": 9
},
{
"serviceId": "544d9337-a158-4812-ba49-d7c4f12715af",
"serviceName": "SRV_qsptest",
"serviceAlias": "qsptest",
"taskCount": 4
},
{
"serviceId": "af9021ee-1dda-45ae-a3b2-9dcf2be13c3d",
"serviceName": "SRV_FENXI-ticker-physical-0808",
"serviceAlias": "ticker-测试试-0808",
"taskCount": 3
},
{
"serviceId": "416c2401-a813-4841-bc12-08cfbb5c4dff",
"serviceName": "SRV_ceshi0803",
"serviceAlias": "ceshi0803",
"taskCount": 3
},
{
"serviceId": "ca34632d-4287-4e7c-8e0d-0e98be5dd235",
"serviceName": "SRV_FENXI-0808",
"serviceAlias": "分析服务 0808",
"taskCount": 2
},
{
"serviceId": "a4cd27c5-b921-4cdc-bf7e-584c80c0905a",
"serviceName": "SRV_11111",
"serviceAlias": "1111",
"taskCount": 1
},
{
"serviceId": "6b75ac4f-b433-4835-8413-947dbc8b4577",
"serviceName": "SRV_toDB_Test",
"serviceAlias": "导入数据库测试",
"taskCount": 1
}
]
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 获取常用模型
接口说明
统计热门模型并返回排名靠前的 N 条记录
请求示例
http:///ginsight/service/hotmodels?topn=5
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| topn | query | string | 否 | 返回前n条，默认值5 |
返回示例
成功
{
"code": 200,
"msg": "成功",
"data": {
"hotWorkflows": [
{
"model Id": "84428f3f-c89e-46f0-a33a-95ce2f848f30"
"modelName": "pg 叠加计算模型",
"modelAlias": "pg 叠加计算模型",
"count": 3
},
{
"model Id": "14eaf2bc-f50a-428d-ad8c-efe055aa897f"
"modelName": "ceshi1",
"modelAlias": "ceshi1",
"count": 2
},
{
"model Id": "1d3f423d-6179-49c6-b2dd-717485800eff"
"modelName": "ticker-physical-0808",
"modelAlias": "ticker-physical-0808",
"count": 1
},
{
"model Id": "32054438-7f66-49dd-8d67-03912ec29ad3"
"modelName": "Test_input",
"modelAlias": "测试用输入",
"count": 1
},
{
"model Id": "86aeb cae-485c-434d-beff-c27aacdcc775"
"modelName": "test0808",
"modelAlias": "test0808",
"count": 1
}
],
"hotPlugins": [
{
"model Id": "8080feed-05c3-4813-831a-2b5022f73aa9",
"modelName": "/data/load/db",
"modelAlias": "载入 db(oid 筛选)",
"count": 207
},
{
"model Id": "8080feed-ba3a-4fb1-b5e4-1a9bd81f7e03",
"modelName": "/data/export/db",
"modelAlias": "导出到数据库",
"count": 69
},
{
"model Id": "46a4e1c4-3d32-4be b-ba7a-bf2e206a4593",
"modelName": "/business/overlay",
"modelAlias": "叠加计算（简）",
"count": 58
},
{
"model Id": "8080feed-fc16-4f30-af89-ae9453b8f9af",
"modelName": "/data/load/s hp",
"modelAlias": "载入 shapefile",
"count": 18
},
{
"model Id": "8080feed-d2ec-45c3-b8a6-634568167a20",
"modelName": "/data/export/s hp",
"modelAlias": "导出为 shapefile",
"count": 14
}
]
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 工作流信息
# 获取所有工作流信息
接口说明
获取所有的工作流信息
请求示例
http:///ginsight/workflow/all
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 获取工作流详情
接口说明
获取工作流详情
请求示例
http:///ginsight/workflow/get?id=71a517c6-18b4-4ce8- a049-229df7dc0be2
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| id | query | string | 否 | 工作流ID号 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 获取工作流的行为
接口说明
获取工作流的行为
请求示例
http:///ginsight/workflow/getaction?actid=123
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| actid | query | string | 否 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 获取工作流链接信息
接口说明
获取工作流链接信息
接口示例
http:///ginsight/workflow/getlink?linkid=123
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| linkid | query | string | 否 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 获取工作流视图
接口说明
获取工作流视图 JSON ，返回的是 JSON 文本，需反转义引号。
接口示例
http:///ginsight/workflow/graph?id=8955fb48-ea6c-4e4e- a4bb-1243178aa402
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| id | query | string | 否 | 工作流ID号 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 获取工作流目录
接口说明
获取工作流目录
请求示例
http:///ginsight/workflow/categories
返回示例
成功
{
"code": 200,
"msg": "成功",
"data": {
"totalCount": 4,
"items": [
{
"id": "4a544c08-a9e0-44a6-a231-4b8e8f3a94f7",
"name": "test",
"desc": "test",
"order": 0,
"logo": null,
"pid": "-1"
},
{
"id": "36cdd8fc-5740-421b-af6f-32e40818ea83",
"name": "空间分析",
"desc": "基础空间分析计算模型",
"order": 0,
"logo": null,
"pid": "-1"
},
{
"id": "5226f8ca-7a8f-4aa6-be36-c283e97f65e6",
"name": "sdfsdf",
"desc": "sdfsdfds",
"order": 0,
"logo": null,
"pid": "-1"
},
{
"id": "384ec03d-8d1e-4a68-8042-1c79a3ede723",
"name": "0808test",
"desc": null,
"order": 0,
"logo": null,
"pid": "-1"
}
]
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 添加工作流目录
接口说明
添加工作流目录
请求示例
http:///ginsight/workflow/addcategory?name=NewWorkflow Category&desc=description&pid=-1
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| name | query | string | 否 | 目录名称 |
| desc | query | string | 否 | 目录描述 |
| pid | query | string | 否 | 上级目录ID |
返回示例
成功
{
"code": 200,
"msg": "成功",
"data": {
"id": "431a64ed-7c2b-485c-b20a-6f1f6193af7a",
"name": "NewWorkflowCategory",
"desc": "description",
"order": 0,
"logo": null,
"pid": "-1"
}
}
2
3
4
5
6
7
8
9
10
11
12
13
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 导出指定的工作流
接口说明
导出指定的工作流，返回 JSON 格式的数据。
请求参数：URL 路径最后一段为工作流 ID ，可以指定一个或多个工作流 ID ，多个 ID 之间用逗号','拼接；参数支持通配符： * 表示所有工作流全部导出。
请求示例
http:///ginsight/workflow/export/0ccc5620-b76a-1cbe-ca22- 4bf83a6f3fbb
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 导出工作流文件
接口说明
导出工作流文件，返回 json 文件供下载。
请求参数：URL 路径最后一段为工作流 ID ，可以指定一个或多个工作流 ID ，多个 ID 之间用逗号','拼接；参数支持通配符： * 表示所有工作流全部导出。
请求示例
http:///ginsight/workflow/exp/8955fb48-ea6c-4e4e-a4bb- 1243178aa402
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 试运行
接口说明
试运行。需要部署 Atlas调度系统和大数据集群运行环境。
接口示例
http:///ginsight/workflow/tryrun?id=123
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| id | query | string | 否 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 创建工作流
接口说明
创建新的工作流。
新建时 id 属性必须为空或不传，params.vid 字段表示新建的工作流节点 ID。
新建的工作流，约定需要自带“开始”（id:0）和“结束”(id:1)两个节点。 除了开始和 结束节点，其他模型节点必须带有modelId 属性，表示关联的插件 ID.
请求示例
http:///ginsight/workflow/design
Body 请求参数
|-
{
"name":"AtlasDemo",
"alias":"G hpc 环境测试",
"desc":"测试",
"categoryID":"d33a00a5-4d21-4165-aa28-f0450479649e",
"id":"",
"params":[
{
"vid":"aaa6c338-97ac-4f05-8f9a-ad69a760f4bf",
"pname":"IntervalTime",
"pvalue":"1500"
},
{
"vid":"aaa6c338-97ac-4f05-8f9a-ad69a760f4bf",
"pname":"ThreadCount",
"pvalue":"4"
}
],
"graph Json":{
"graphNodes":[
{
"id":"b38a37a4-94af-4f53-9c45-3b98f2d382b7",
"width":150,
"height":80,
"x":70,
"y":-122,
"name":"开始",
"index":0
},
{
"id":"d7342833-3ed7-4764-a647-4a7af5db63d8",
"width":150,
"height":80,
"x":390,
"y":15,
"name":"结束",
"index":1
},
{
"id":"aaa6c338-97ac-4f05-8f9a-ad69a760f4bf",
"width":150,
"height":80,
"x":170,
"y":70,
"model Id":"20210702-0000-a bcd-efef-123456780001", "name":"Atlas 步骤二",
"index":2
}
],
"graph Links":[
{
"source":{
"cell":"aaa6c338-97ac-4f05-8f9a-ad69a760f4bf"
"port":"left",
"index":2
},
"target":{
"cell":"d7342833-3ed7-4764-a647-4a7af5db63d8"
"port":"left",
"index":1
}
},
{
"source":{
"cell":"b38a37a4-94af-4f53-9c45-3b98f2d382b7"
"port":"left",
"index":0
},
"target":{
"cell":"aaa6c338-97ac-4f05-8f9a-ad69a760f4bf"
"port":"bottom",
"index":2
}
}
]
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| body | body | string | 否 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 修改工作流参数
接口说明
工作流参数修改专用接口，效率更高。其中， id 属性不能为空； params 属性必填； params.vid 字段表示工作流节点 ID。
请求示例
http:///ginsight/workflow/editparams
Body 请求参数
|-
{
"id":"0bfce7be-893d-4e58-bfc6-c40d5df5abad",
"params":[
{
"vid":"aaa6c338-97ac-4f05-8f9a-ad69a760f4bf",
"pname":"IntervalTime",
"pvalue":"1500"
},
{
"vid":"aaa6c338-97ac-4f05-8f9a-ad69a760f4bf",
"pname":"ThreadCount",
"pvalue":"4"
}
]
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| id | query | string | 否 | 工作流ID号 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 编辑工作流
接口说明
工作流编辑修改。其中， id 属性不能为空；params属性可选，为空表示不更新参数，非 空则填入已改变的参数值； params.vid 字段表示工作流节点 ID。
工作流约定需要自带“开始”（id:0）和“结束”(id:1)两个节点。 除了开始和结束节 点，其他模型节点必须带有modelId 属性，表示关联的插件 ID.
请求示例
http:///ginsight/workflow/edit
Body 请求参数
|-
{
"name":"AtlasDemo",
"alias":"G hpc 环境测试",
"desc":"测试",
"categoryID":"d33a00a5-4d21-4165-aa28-f0450479649e",
"id":"113331222",
"params":[
{
"vid":"aaa6c338-97ac-4f05-8f9a-ad69a760f4bf",
"pname":"IntervalTime",
"pvalue":"1500"
},
{
"vid":"aaa6c338-97ac-4f05-8f9a-ad69a760f4bf",
"pname":"ThreadCount",
"pvalue":"4"
}
],
"graph Json":{
"graphNodes":[
{
"id":"b38a37a4-94af-4f53-9c45-3b98f2d382b7",
"width":150,
"height":80,
"x":70,
"y":-122,
"name":"开始",
"index":0
},
{
"id":"d7342833-3ed7-4764-a647-4a7af5db63d8",
"width":150,
"height":80,
"x":390,
"y":15,
"name":"结束",
"index":1
},
{
"id":"aaa6c338-97ac-4f05-8f9a-ad69a760f4bf",
"width":150,
"height":80,
"x":170,
"y":70,
"model Id":"20210702-0000-a bcd-efef-123456780001", "name":"Atlas 步骤二",
"index":2
}
],
"graph Links":[
{
"source":{
"cell":"aaa6c338-97ac-4f05-8f9a-ad69a760f4bf"
,
"port":"left",
"index":2
},
"target":{
"cell":"d7342833-3ed7-4764-a647-4a7af5db63d8"
,
"port":"left",
"index":1
}
},
{
"source":{
"cell":"b38a37a4-94af-4f53-9c45-3b98f2d382b7"
,
"port":"left",
"index":0
},
"target":{
"cell":"aaa6c338-97ac-4f05-8f9a-ad69a760f4bf",
"port":"bottom",
"index":2
}
}
]
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| body | body | string | 否 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 导入工作流
接口说明
上传文件导入工作流。（注意：尽量在新建的环境中还原工作流）
请求体数据类型： JSON 数组。表示 Ginsight 导出的标准工作流。
响应状态码：
200 ， 全部成功；
206 ， 部分成功；
501 ， 存在异常，可能有部分成功。
请求示例
Body 请求参数
gflowFile**: **string
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| body | body | object | 否 | |
| gflowFile | body | string | 否 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 删除工作流目录
接口说明
删除工作流目录及其下面的所有工作流。（需谨慎操作）
请求示例
http:///ginsight/workflow/deletecategory?id=Category_ID_xx x
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| id | query | string | 否 | 工作流目录ID号 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 删除工作流
接口说明
删除工作流。
请求示例
http:///ginsight/workflow?id=aad5e593-35b0-4fde-bb38- 73abc77d2028
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| id | query | string | 否 | 工作流ID号 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# **通过URL删除工作流 **
接口说明
直接通过 URL 删除工作流。
请求示例
http:///ginsight/workflow/8955fb48-ea6c-4e4e-a4bb- 1243178aa402
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 模型信息
# 获取所有模型
接口说明
获取所有的基础模型信息。
请求示例
http:///ginsight/plugin/all
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 获取模型详情
接口说明
模型详情。获取基础算法模型详情。
请求示例
http:///ginsight/plugin/get?id=8080feed-8669-49b4-a2f2- a554355d0f23
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| id | query | string | 否 | 模型D号 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 获取模型参数原型
接口说明
获取模型参数原型。
paramid 是是基础模型的 prototypeId。
请求示例
http:///ginsight/plugin/getparam?paramid=acb21e1e-90fb- 4367-99c7-537fe6545e91
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| paramid | query | string | 否 | 基础模型 prototypeId 的 id |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 获取模型目录
接口说明
获取模型的目录。
请求示例
http:///ginsight/plugin/categories
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 添加模型目录
接口说明
添加模型目录
请求示例
http:///ginsight/plugin/addcategory?name=newcat&desc=&p id=-1
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| name | query | string | 否 | 新目录名 |
| desc | query | string | 否 | |
| pid | query | string | 否 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 导出所有模型
接口说明
导出所有模型。导出 json 文件以供下载。
请求示例
http:///ginsight/plugin/exp
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 批量查询模型
接口说明
批量查询模型（基础算法）。按照 ID 批量查询插件。
请求示例
http:///ginsight/plugin/list?ids=5c59d479-4a2f-4c4d-a555- 742e0f7a4724,c30c4681-5395-4326-8e56-be14ee0d5e6b
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| ids | query | string | 否 | 插件（基础算法）ID |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 查询工作流中的所有模型
接口说明
查询工作流中的所有相关模型。
请求示例
http:///ginsight/plugin/listbywf?wfid=71a517c6-18b4-4ce8- a049-229df7dc0be2
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| wfid | query | string | 否 | 工作流ID |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 导入基础模型
接口说明
上传文件导入基础模型。（注意：必须在新建业务库环境下导入，否则会出现意外的故障！）
请求体数据类型： JSON 数组。表示 Ginsight 导出的标准插件。
请求示例
http:///ginsight/plugin/imp
Body 请求参数
gplgFile: string
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| body | body | object | 否 | 工作流ID |
| gplgFile | body | string | 否 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 日志信息
# 获取日志字段
接口说明
获取日志字段。
请求示例
http:///ginsight/loginfo/getLogField
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 通过ID查找日志
接口说明
通过 ID 查找日志。
请求示例
http:///ginsight/loginfo/findLogInfoById?id=
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| id | query | string | 否 | 日志ID |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 日志分页查询
接口说明
日志分页查询。
请求示例
http:///ginsight/loginfo/logInfoPage?currentPage=1&pageSiz e=50&startTime=&endTime=&returnFields=&keyword=
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| currentPage | query | string | 否 | 当前页 |
| pageSize | query | string | 否 | 页大小 |
| startTime | query | string | 否 | 开始时间 |
| endTime | query | string | 否 | 结束时间 |
| returnFields | query | string | 否 | 返回字段 |
| keyword | query | string | 否 | 关键字 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 导出日志
接口说明
导出日志。
请求示例
http:///ginsight/loginfo/exportLogInfo?startTime=&endTime =&keyword=
Body 请求参数
|-
{
"id": "",
" " ""
message : ,
"level": "",
"task Id": "",
"job Id": "",
"threadName": "",
"className": "",
"stackTrace": "",
"hostName": "",
"ip": "",
"processId": 0,
"timeStamp": ""
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| startTime | query | string | 否 | 开始时间 |
| endTime | query | string | 否 | 结束时间 |
| keyword | query | string | 否 | 关键字 |
| body | body | string | 否 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 日志直方图
接口说明
日志直方图。
请求示例
http:///loginfo/logHistogram?startTime=&endTime=&dateEn um=&keyword=
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| startTime | query | string | 否 | 开始时间 |
| endTime | query | string | 否 | 结束时间 |
| dateEnum | query | string | 否 | |
| keyword | query | string | 否 | 关键字 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |
# 日志字段排序
接口说明
日志字段排行。
请求示例
http:///loginfo/logRanking?size=5&startTime=&endTime=&RankField=
Body 请求参数
|-
{
"id": "",
" " ""
message : ,
"level": "",
"task Id": "",
"job Id": "",
"threadName": "",
"className": "",
"stackTrace": "",
"hostName": "",
"ip": "",
"processId": 0,
"timeStamp": ""
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| size | query | string | 否 | |
| startTime | query | string | 否 | 开始时间 |
| endTime | query | string | 否 | 结束时间 |
| RankField | query | string | 否 | |
| body | body | string | 否 |
返回示例
200 Response
{}
返回结果
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功 | Inline |