Analysis: Entity

Analysis: Entity

#340610

Description

The /analysis/<platformType>/<platformSubType> resource is used to return a list of analyses currently in the Densify system. The /analysis/<platformType>/<platformSubType>/<analysisId> resource is used to return the details of a specific analysis currently in Densify. An analysis entity encompasses infrastructure resources within a predefined environment scope, specific to the platform and cloud vendor. The infrastructure resources are analyzed to determine optimal recommendations.

See Analysis: Cloud and Analysis: Containers for the two platform types of analyses supported in Densify.

Resource

/analysis/<platformType>/<platformSubType>

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

Supported Operations

Table: Analysis Supported Operations

Operation

HTTP Method

Input

Output

Description

List all analyses for a particular platform and vendor

GET /analysis/<platformType>/<platformSubType>

Path Parameter:

Collection of:

Use this resource to return a list of existing analyses for a particular platform and sub-platform (vendor).

Example: Listing All Kubernetes Container Analyses

Example: Listing All AWS Analyses

Example: Listing All Azure Analyses

Get a specific analysis

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

Path Parameter:

Use this resource to return a specific analysis with a known analysis ID.

Example: Getting Details of a Specific Kubernetes Container Analysis

Parameters

Path Parameters

Table: Analysis 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 Response Schema

Element

Type

Filter/Sort

Description

accountId

string

 

The technology account identifier (i.e. AWS account number, Azure subscription ID, GCP project ID, etc.).

This element is not returned for container analyses.

  

accountName

string

 

The technology platform account name (e.g. AWS account name).

This element is not returned for container analyses.

  

analysisCompletedOn

string

 

The date and time (in milliseconds) when the last analysis completed.

If an analysis has never been completed, "0" is returned.

analysisId

string

 

The unique identifier for the analysis entity in Densify.

analysisName

string

Filter by:

  • analysisName
  • analysisName_like

The name given to the analysis entity.

The analysis name typically corresponds to the cluster name, account ID, subscription ID, or project ID from the infrastructure data collected.

Use the analysisName and analysisName_like filter to return only analyses you are interested in. For example, /cloud/aws?analysisName_like=bob will return all AWS analyses with a "bob" substring in the analysis name.

analysisResults

string

 

The referenced resource to the recommendations of the analysis.

For details of the various analysis recommendations, see:

analysisStatus

string

 

The referenced resource to the status of the analysis.

See Analysis: Status for details.

href

string

 

The referenced resource to the analysis entity.

message

string

 

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

policyInstanceId

string

 

The Densify policy instance GUID used for optimization analysis.

 

policyName

string

 

The Densify policy name used for optimization analysis.

 

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: Listing All Kubernetes Container Analyses

The following example shows you how to list all Kubernetes container analyses in Densify.

Request:

Copy 
GET /analysis/containers/kubernetes

Response:

Copy 
[
    {
        "policyInstanceId": "094d9c96-4802-4689-a260-ab4c08ee6123",
        "analysisCompletedOn": 1585725434757,
        "analysisResults": "/analysis/containers/kubernetes/8334887b-59ca-42a4-a241-f970d7c306f1/results",
        "policyName": "Initial Assessment",
        "analysisId": "8334887b-59ca-42a4-a241-f970d7c306f1",
        "href": "/analysis/containers/kubernetes/8334887b-59ca-42a4-a241-f970d7c306f1",
        "analysisStatus": "/analysis/containers/kubernetes/8334887b-59ca-42a4-a241-f970d7c306f1/status",
        "analysisName": "mini-kube"
    }
]

Example: Listing All AWS Analyses

The following example shows you how to list all AWS analyses in Densify.

Request:

Copy 
GET /analysis/cloud/aws

Response:

Copy 
[
 {
        "accountId": "922390019409",
        "policyInstanceId": "44b2ea5f-a3b7-44b2-9437-3c4e69650e58",
        "analysisCompletedOn": 1593606311863,
        "analysisResults": "/analysis/cloud/aws/0a87047f-e8dc-43f0-89bd-769962b06b9d/results",
        "accountName": "General Services",
        "policyName": "AWS (Mobile_Dev)",
        "analysisId": "0a87047f-e8dc-43f0-89bd-769962b06b9d",
        "href": "/analysis/cloud/aws/0a87047f-e8dc-43f0-89bd-769962b06b9d",
        "analysisStatus": "/analysis/cloud/aws/0a87047f-e8dc-43f0-89bd-769962b06b9d/status",
        "analysisName": "922390019409 (Mobile_Dev)"
    },
    {
        "accountId": "229192219122",
        "policyInstanceId": "ba022982-12da-48b8-b5f2-af6f0630952d",
        "analysisCompletedOn": 1585732332227,
        "analysisResults": "/analysis/cloud/aws/8bef9d74-94f7-414f-a032-5855258473a2/results",
        "accountName": "General Services",
        "policyName": "AWS General Prod",
        "analysisId": "8bef9d74-94f7-414f-a032-5855258473a2",
        "href": "/analysis/cloud/aws/8bef9d74-94f7-414f-a032-5855258473a2",
        "analysisStatus": "/analysis/cloud/aws/8bef9d74-94f7-414f-a032-5855258473a2/status",
        "analysisName": "229192219122"
    }
]

Example: Listing All Azure Analyses

The following example shows you how to list all Azure analyses in Densify.

Request:

Copy 
GET /analysis/cloud/azure

Response:

Copy 
[
    {
        "accountId": "3d4ba999-cbd8-40b8-9998-574be6824a97",
        "policyInstanceId": "72aa4f1a-906a-4af4-94e9-f8fb606cdfe9",
        "analysisCompletedOn": 1589935057627,
        "analysisResults": "/analysis/cloud/azure/b3573fb3-0a37-406d-bb08-24f088e8bc63/results",
        "accountName": "Test Subscription",
        "policyName": "Initial Assessment",
        "analysisId": "b3573fb3-0a37-406d-bb08-24f088e8bc63",
        "href": "/analysis/cloud/azure/b3573fb3-0a37-406d-bb08-24f088e8bc63",
        "analysisStatus": "/analysis/cloud/azure/b3573fb3-0a37-406d-bb08-24f088e8bc63/status",
        "analysisName": "3d4ba999-cbd8-40b8-9998-574be6824a97"
    },
    {
        "accountId": "cc377154-9605-4cb0-8b41-1b39e1c4ac0f",
        "policyInstanceId": "72aa4f1a-906a-4af4-94e9-f8fb606cdfe9",
        "analysisCompletedOn": 1589978789707,
        "analysisResults": "/analysis/cloud/azure/c1e0bb64-6582-41e8-b7f6-341797af4436/results",
        "policyName": "Initial Assessment",
        "analysisId": "c1e0bb64-6582-41e8-b7f6-341797af4436",
        "href": "/analysis/cloud/azure/c1e0bb64-6582-41e8-b7f6-341797af4436",
        "analysisStatus": "/analysis/cloud/azure/c1e0bb64-6582-41e8-b7f6-341797af4436/status",
        "analysisName": "cc377154-9605-4cb0-8b41-1b39e1c4ac0f"
    },
    {
        "accountId": "00d89cbc-bc00-4d00-bcf6-ce6ec08d8fbc",
        "policyInstanceId": "129fa559-2db5-40ff-8a57-94c56900308a",
        "analysisCompletedOn": 1585726564073,
        "analysisResults": "/analysis/cloud/azure/6b8ab8e1-a026-4db9-a4ae-2d684446731f/results",
        "policyName": "Azure Assessement",
        "analysisId": "6b8ab8e1-a026-4db9-a4ae-2d684446731f",
        "href": "/analysis/cloud/azure/6b8ab8e1-a026-4db9-a4ae-2d684446731f",
        "analysisStatus": "/analysis/cloud/azure/6b8ab8e1-a026-4db9-a4ae-2d684446731f/status",
        "analysisName": "00d89cbc-bc00-4d00-bcf6-ce6ec08d8fbc"
    }
]

Example: Listing All GCP Analyses

The following example shows you how to list all GCP analyses in Densify.

Request:

Copy 
GET /analysis/cloud/gcp

Response:

Copy 
[
    {
        "accountId": "gcpAcctEast-production-op",
        "policyInstanceId": "83003bdd-389e-4210-8ef0-c47a6d025c4d",
        "analysisCompletedOn": 1585736399537,
        "analysisResults": "/analysis/cloud/gcp/0930c31d-13ac-4a3f-892e-2a35c8a3f842/results",
        "accountName": "DVC_GCP",
        "policyName": "GCP Assessement",
        "analysisId": "0930c31d-13ac-4a3f-892e-2a35c8a3f842",
        "href": "/analysis/cloud/gcp/0930c31d-13ac-4a3f-892e-2a35c8a3f842",
        "analysisStatus": "/analysis/cloud/gcp/0930c31d-13ac-4a3f-892e-2a35c8a3f842/status",
        "analysisName": "gcpAcctEast-production-op"
    }
]

Example: Getting Details of a Specific Kubernetes Container Analysis

The following example shows you how to get the details of a Kubernetes container analysis in Densify with a known analysis ID.

Request:

Copy 
GET /analysis/containers/kubernetes/519a1b9f-aae0-4b65-bb63-1180ff68d27a

Response:

Copy 
{
    "policyInstanceId": "094d9c96-4802-4689-a260-ab4c08ee6123",
    "analysisCompletedOn": 1585725429013,
    "analysisResults": "/analysis/containers/kubernetes/519a1b9f-aae0-4b65-bb63-1180ff68d27a/results",
    "policyName": "Initial Assessment",
    "analysisId": "519a1b9f-aae0-4b65-bb63-1180ff68d27a",
    "href": "/analysis/containers/kubernetes/519a1b9f-aae0-4b65-bb63-1180ff68d27a",
    "analysisStatus": "/analysis/containers/kubernetes/519a1b9f-aae0-4b65-bb63-1180ff68d27a/status",
    "analysisName": "kube-master"
}