Analysis: Status

Analysis: Status

#340620

Description

The /analysis/<platformType>/<platformSubType>/<analysisId>/status resource is used to return the current status of an analysis in Densify.

Resource

/analysis/<platformType>/<platformSubType>/<analysisId>/status

Supported Operations

Table: Analysis Status Supported Operations

Operation

HTTP Method

Input

Output

Description

Check for analysis status

GET /analysis/<platformType>/<platformSubType>/<analysisId>/status

Path Parameter:

For errors:

Use this resource to check the status of an analysis by providing the analysis ID.

Example: Checking for Kubernetes Container Analysis Status

Example: Checking for AWS Analysis Status

Example: Checking for GCP Analysis Status

Parameters

Path Parameters

Table: Analysis Status Path Parameters

Parameter Name

Type

Description

platformType

string

[cloud|containers]

The technology platform of the analysis.

platformSubType

string

The platform sub-type of the analysis. This is typically the vendor/flavor of the technology platform.

Possible platform sub-types depend on the platformType specified:

  • For platformType = cloud, platformSubType = [aws|gcp|azure]
  • For platformType = containers, platformSubType = [kubernetes]

analysisId

string

The unique referenced ID of the analysis.

Response

Table: Analysis Status Response Schema

Element

Type

Filter/Sort

Description

analysisStage

string

 

The current stage of the specified analysis.

Possible stages include:

  • Analyzing : {percent} Completed
  • Not analyzed
  • Completed

webHookStatus

string

 

The status of the last webhook POST request. Recommendations are pushed to the webhook URI via a POST request after analysis completion.

statusMessage

string

 

The message for the analysis status.

message

string

 

For errors, the message for the status response is returned.

status

number

 

The HTTP response code of the request error. Possible status values include:

  • 200—success with request;
  • 400—invalid parameters;
  • 401—authentication failed;
  • 404—resource not found;
  • 500—internal server error.

Examples

Example: Checking for Kubernetes Container Analysis Status

The following example shows you how to check for a specific Kubernetes container analysis status.

Request:

GET /analysis/containers/kubernetes/6e4da559-cbd8-40b8-5498-644be6843a93/status

Response:

{

  "analysisStage": "Completed",

  "webHookStatus": "",

  "statusMessage": "Analysis ABC-east-665-b was last completed on Wed Jan 30 18:08:45 EST 2019."

}

Example: Checking for AWS Analysis Status

The following example shows you how to check for a specific AWS analysis status.

Request:

GET /analysis/cloud/aws/9a5d2d55-6d85-4fde-8bab-fcd0cef8c5bf/status

Response:

{

  "analysisStage": "Completed",

  "webHookStatus": "",

  "message": "Analysis 231345225455 was last completed on Mon Jan 21 10:11:09 EST 2019."

}

Example: Checking for Azure Analysis Status

The following example shows you how to check for a specific Azure analysis status.

Request:

GET /analysis/cloud/azure/6b8ab8e1-a026-4db9-a4ae-2d684446731f/status

Response:

{

  "analysisStage": "Completed",

  "webHookStatus": "Success",

  "statusMessage": "Analysis 00d89cbc-bc00-4d00-bcf6-ce6ec09d8adc was last completed on Thu Jan 24 09:36:36 EST 2019."

}

Example: Checking for GCP Analysis Status

The following example shows you how to check for a specific GCP analysis status.

Request:

GET /analysis/cloud/gcp/0930c31d-13ac-4a3f-892e-2a35c8a3f842/status

Response:

{

  "analysisStage": "Analyzing : 38% Completed",

  "webHookStatus": "",

  "statusMessage": "Analysis gcpAcctEast-608378 is currently running."

}