-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathopenapi.yaml
More file actions
374 lines (373 loc) · 11.8 KB
/
openapi.yaml
File metadata and controls
374 lines (373 loc) · 11.8 KB
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
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
# Generated with protoc-gen-openapi
# https://github.com/google/gnostic/tree/master/cmd/protoc-gen-openapi
openapi: 3.0.3
info:
title: ""
version: 0.0.1
paths:
/agent/v1/task/{id}:
put:
tags:
- Agent
description: UpdateTask update task info.
operationId: Agent_UpdateTask
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/api.agent.UpdateTaskRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/api.agent.UpdateTaskReply'
/agent/v1/tasks:
get:
tags:
- Agent
description: ListTasks list this agent all tasks.
operationId: Agent_ListTasks
parameters:
- name: name
in: query
schema:
type: array
items:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/api.agent.ListTaskReply'
/executor/v1/beat:
post:
tags:
- Executor
description: Beat 心跳检测
operationId: Executor_Beat
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/api.executor.BeatRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/api.executor.BeatReply'
/executor/v1/deregister:
post:
tags:
- ExecutorRegistrar
description: Deregister the registration.
operationId: ExecutorRegistrar_Deregister
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/api.executor.ExecutorDeregisterRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/api.executor.ExecutorDeregisterReply'
/executor/v1/idlebeat:
post:
tags:
- Executor
description: IdleBeat 忙碌检测
operationId: Executor_IdleBeat
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/api.executor.IdleBeatRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/api.executor.IdleBeatReply'
/executor/v1/kill:
post:
tags:
- Executor
description: Kill 杀死任务单元
operationId: Executor_Kill
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/api.executor.KillRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/api.executor.KillReply'
/executor/v1/log:
post:
tags:
- Executor
description: GetUnitLog 获取任务日志
operationId: Executor_GetUnitLog
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/api.executor.UnitLogRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/api.executor.UnitLogReply'
/executor/v1/register:
post:
tags:
- ExecutorRegistrar
description: Register the registration.
operationId: ExecutorRegistrar_Register
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/api.executor.ExecutorRegisterRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/api.executor.ExecutorRegisterReply'
/executor/v1/run:
post:
tags:
- Executor
description: Run 触发任务单元
operationId: Executor_Run
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/api.executor.RunRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/api.executor.RunReply'
components:
schemas:
api.agent.ListTaskReply:
type: object
properties:
tasks:
type: array
items:
$ref: '#/components/schemas/api.agent.Task'
api.agent.Task:
type: object
properties:
id:
type: integer
format: int64
name:
type: string
status:
type: integer
format: int32
created_at:
type: string
updated_at:
type: string
schedule_available_ratio:
type: number
format: float
schedule_total_count:
type: integer
format: int32
schedule_success_count:
type: integer
format: int32
schedule_failed_count:
type: integer
format: int32
online_nodes:
type: array
items:
type: string
api.agent.UpdateTaskReply:
type: object
properties: {}
api.agent.UpdateTaskRequest:
type: object
properties:
id:
type: integer
format: int64
name:
type: string
title:
type: string
status:
type: integer
format: int32
type:
type: integer
format: int32
api.executor.BeatReply:
type: object
properties:
success:
type: boolean
key:
type: string
api.executor.BeatRequest:
type: object
properties: {}
api.executor.ExecutorDeregisterReply:
type: object
properties:
success:
type: boolean
api.executor.ExecutorDeregisterRequest:
type: object
properties:
key:
type: string
api.executor.ExecutorRegisterReply:
type: object
properties:
success:
type: boolean
key:
type: string
api.executor.ExecutorRegisterRequest:
type: object
properties:
executor_name:
type: string
executor_protocol:
type: integer
format: enum
executor_addr:
type: string
executor_port:
type: integer
format: int32
executor_dsn:
type: string
api.executor.IdleBeatReply:
type: object
properties:
success:
type: boolean
key:
type: string
reason:
type: string
api.executor.IdleBeatRequest:
type: object
properties: {}
api.executor.KillReply:
type: object
properties:
success:
type: boolean
key:
type: string
reason:
type: string
api.executor.KillRequest:
type: object
properties:
key:
type: string
unit_name:
type: string
api.executor.RunReply:
type: object
properties:
success:
type: boolean
key:
type: string
reason:
type: string
remark:
type: string
api.executor.RunRequest:
type: object
properties:
key:
type: string
unit_name:
type: string
unit_args:
type: string
api.executor.UnitLog:
type: object
properties:
time:
type: string
unit_name:
type: string
log:
type: string
error:
type: string
api.executor.UnitLogReply:
type: object
properties:
success:
type: boolean
key:
type: string
logs:
type: array
items:
$ref: '#/components/schemas/api.executor.UnitLog'
api.executor.UnitLogRequest:
type: object
properties:
key:
type: string
unit_name:
type: string
tags:
- name: Agent
description: |-
Agent is the service for dc task agent.
Resource: agent
Version: v1
BasePath: /agent/v1/**
- name: Executor
- name: ExecutorRegistrar