- Print
- PDF
Create task run
- Print
- PDF
Available in VPC
Create a new task model run.
When you request to create a run, the creation process will proceed according to the following sequence.
Order | Creation status | Description |
---|---|---|
Step 1 | registered : registered | Status where the creation job is registered in the NCLUE system
|
Step 2 | pending : pending | Status where the creation job is queued in the system |
Step 3 | in_progress : creating | Status where the creation job is running on the server |
Step 4 |
| Status where the creation job has been completed
|
The duration of each job when creating a run depends on the amount of data and service's available resources. To check the progress of the creation, call the Get task run API and check the status
field in the response body.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
POST | /task-runs |
Request headers
For information about the headers common to all NCLUE APIs, see NCLUE request headers.
Request body
You can include the following data in the body of your request:
Field | Type | Required | Description |
---|---|---|---|
name | String | Required | Task name
|
task_id | String | Required | Task ID to apply |
feature_id | String | Required | ID of the feature applied to the task
|
result_bucket | String | Optional | Name of the Object Storage bucket where the job result will be stored |
result_file_path | String | Optional | File path in result_bucket to store the job result
|
Request example
The request example is as follows:
Response
This section describes the response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
run_id | String | - | Run ID |
run_name | String | - | Run name |
task_id | String | - | Task ID to apply |
task_name | String | - | Task name to apply |
feature_id | String | - | ID of the feature applied to the task |
feature_name | String | - | Name of the feature applied to the task |
created_at | String | - | Task creation request date and time (ISO 8601 format) |
result_bucket | String | - | Name of the Object Storage bucket where the job result will be stored |
result_file_path | String | - | File path in Object Storage where the job result will be stored |
Response status codes
For response status codes common to NCLUE, see NCLUE response status codes.
Response example
The response example is as follows: