Skip to main content

Home

Celery endpoints
/celery/analyze-queue-data

Generates a Queue Analysis report.

Request
GET http://unravel-host:3000/api/v1/celery/analyze-queue-data?max_size=1000&version=2
Path parameters

None.

Query parameters

Required parameters are highlighted.

Name

Type

Description

start_time

string

Start date. Format YYYY-MM-DD

end_time

string

End date. Format YYYY-MM-DD

Response body

Name

Type

Description

[no name]

array

JSON structure containing a Queue Analysis report.

Examples

Request:

curl -X GET "http://myserver.com:3000/v1/celery/analyze-queue-data?max_size=1000&version=2" -H  "accept: application/json" -H  "Authorization: JWT token"

Response:

/celery/cloud-mappings-grouped-reports
Generates a Cloud Mapping grouped report.
Request
GET http://unravel-host:3000/api/v1/celery/cloud-mappings-grouped-reports
Path parameters
None.
Query parameters
Required parameters are highlighted.
Name
Type
Description
from
string
instance_type
string
Response body
Name
Type
Description
task_id
integer
Task ID
Examples
Request:
curl -X GET "http://myserver.com:3000/api/v1/cloud-mappings-grouped-reports" -H  "accept: application/json" -H  "Authorization: JWT token"
Response body:
{
  "task_id": "c097620d-b0c5-434c-8a94-76c83fcf28da"
}
/celery/cloud-mappings-reports
Generates a Cloud Mappping report.
Request
GET http://unravel-host:3000/api/v1/celery/cloud-mappings-reports
Path parameters
None.
Query parameters
None.
Response body
Name
Type
Description
[no name]
array
JSON structure containing the report.
Examples
Request:
curl -X GET "http://myserver.com:3000/api/v1/celery/cloud-mappings-reports" -H  "accept: application/json" -H  "Authorization: JWT token"
Request body:
/celery/cloud_reports/cloud_providers
Generates a report on cloud providers.
Request
GET http://unravel-host:3000/api/v1/celery/cloud_reports/cloud_providers
Path parameters
None.
Query parameters
None.
Response body
Name
Type
Description
[no name]
array
JSON structure containing the report.
Examples
Request:
curl -X GET "http://myserver.com:3000/api/v1/celery/cloud_reports/cloud_providers" -H  "accept: application/json" -H  "Authorization: JWT token"
Request body:
/celery/cluster-discovery
Generates a Cluster Discovery report.
Request
GET http://unravel-host:3000/api/v1/celery/cluster-discovery
Path parameters
None.
Query parameters
None.
Response body
Name
Type
Description
[no name]
array
JSON structure containing information about the cluster(s).
Examples
Request:
curl -X GET "http://myserver.com:3000/api/v1/celery/cluster-discovery" -H  "accept: application/json" -H  "Authorization: JWT token"
Request body:
/celery/generate_cluster_app_param_report
Generates a cluster app parameter report.
Request
GET http://unravel-host:3000/api/v1/celery/generate_cluster_app_param_report
Path parameters
None.
Query parameters
None.
Response body
Name
Type
Description
[no name]
array
JSON structure containing the report.
Examples
Request:
curl -X GET "http://myserver.com:3000/api/v1/celery/generate_cluster_app_param_report" -H  "accept: application/json" -H  "Authorization: JWT token"
Request body:
/celery/predict_capacity
Generates a Forecasting report.
Request
GET http://unravel-host:3000/api/v1/celery/predict_capacity
Path parameters
None.
Query parameters
None.
Response body
Name
Type
Description
[no name]
array
JSON structure containing a Forecasting report.
Examples
Request:
curl -X GET "http://myserver.com:3000/api/v1/celery/predict_capacity" -H  "accept: application/json" -H  "Authorization: JWT token"
Request body:
/celery/small-files-report
Gets the Small Files report.
Request
GET http://unravel-host:3000/api/v1/celery/small-files-report?avg_size_threshold={sizethreshold}&num_files_threshold={countthreshold}&top_n_small_files={topx}
Path parameters
None.
Query parameters
Required parameters are highlighted.
Name
Type
Description
avg_size_thresholdavg_size_threshold
string
File size threshold in bytes
num_files_thresholdnum_files_threshold
string
File count threshold
top_n_small_filestop_n_small_files
string
"Top x" small files
drill_down_subdirs_flag
string
Need to drill down subdirectories? (true or false)
use_avg_file_size_flag
string
Need to use average file size? (true or false)
max_parent_dir_depth
string
Maximum depth of parent directories.
min_parent_dir_depth
string
Minimum depth of parent directories.
Response Body
Name
Type
Description
[no name]
array
JSON structure containing the Small Files report.
Examples
Request:
curl -X GET "http://myserver.com:3000/api/v1/celery/small-files-report?avg_size_threshold=456&num_files_threshold=22&top_n_small_files=5" -H  "accept: application/json" -H  "Authorization: JWT token"
Request body:
{
  "task_id": "831e5966-3233-4400-ab0f-ed8a459859e3"
}
In this section: