110 lines
1.7 KiB
Markdown
110 lines
1.7 KiB
Markdown
# API Reference
|
|
|
|
## Base URL
|
|
|
|
- **Local**: `http://schedulerservice.cnoe.localtest.me/schedulerService/`
|
|
- **Production**: `http://schedulerservice.{namespace}.svc.cluster.local/schedulerService/`
|
|
|
|
## Health Check
|
|
|
|
### GET /schedulerService/jobTrigger
|
|
|
|
Returns the health status of the service.
|
|
|
|
**Request:**
|
|
```
|
|
GET /schedulerService/jobTrigger?jsonQuery={"application":"nagios","jobName":"monitoring_scheduler_svc"}
|
|
```
|
|
|
|
**URL Encoded:**
|
|
```
|
|
GET /schedulerService/jobTrigger?jsonQuery=%7B%22application%22%3A%22nagios%22%2C%22jobName%22%3A%22monitoring_scheduler_svc%22%7D
|
|
```
|
|
|
|
**Response (200 OK):**
|
|
```json
|
|
{
|
|
"status": "success"
|
|
}
|
|
```
|
|
|
|
## Endpoints
|
|
|
|
### Job Management
|
|
|
|
#### POST /schedulerService/job
|
|
|
|
Create a new job.
|
|
|
|
**Request Body:**
|
|
```json
|
|
{
|
|
"jobName": "my-job",
|
|
"application": "my-app",
|
|
"command": "echo hello",
|
|
"preemption": false
|
|
}
|
|
```
|
|
|
|
### Schedule Management
|
|
|
|
#### GET /schedulerService/schedules
|
|
|
|
List all schedules.
|
|
|
|
#### POST /schedulerService/schedules
|
|
|
|
Create a new schedule.
|
|
|
|
#### PUT /schedulerService/schedules
|
|
|
|
Update an existing schedule.
|
|
|
|
#### DELETE /schedulerService/schedules
|
|
|
|
Delete a schedule.
|
|
|
|
### Job Trigger
|
|
|
|
#### GET /schedulerService/jobTrigger
|
|
|
|
Get job trigger status.
|
|
|
|
#### POST /schedulerService/jobTrigger
|
|
|
|
Trigger a job execution.
|
|
|
|
### Statistics
|
|
|
|
#### GET /schedulerService/jobStat
|
|
|
|
Get job statistics.
|
|
|
|
### Job Details
|
|
|
|
#### GET /schedulerService/jobDetail
|
|
|
|
Get detailed information about a job.
|
|
|
|
### Group Management
|
|
|
|
#### GET /schedulerService/group
|
|
|
|
List groups.
|
|
|
|
#### POST /schedulerService/group
|
|
|
|
Create a group.
|
|
|
|
### Cluster Information
|
|
|
|
#### GET /schedulerService/cluster
|
|
|
|
Get cluster information.
|
|
|
|
### Command Prefix Mapping
|
|
|
|
#### GET /schedulerService/commandPrefixImageMapping
|
|
|
|
Get command prefix to container image mappings.
|