Analysis: AWS Systems

Analysis: AWS Systems

#340630

Description

The /analysis/cloud/aws/<analysisId>/systems resource is used to return a collection of all systems included in an AWS optimization analysis.

The recommendations from an AWS optimization analysis can be obtained using the /analysis/cloud/aws/<analysisId>/results resource. See Analysis: AWS Recommendations for details on the AWS recommendations resource.

The number of analyzed systems (i.e. /aws/<analysisId>/systems entities) will always be greater than or equal to the number of system recommendations produced (i.e. /aws/<analysisId>/results entities), as some systems may not have any recommendations.

Resource

/analysis/cloud/aws/<analysisId>/systems

Supported Operations

Table: AWS Systems Supported Operations

Operation

HTTP Method

Input

Output

Description

List all systems included in an AWS analysis

GET /analysis/cloud/aws/<analysisId>/systems

Path Parameter:

Collection of:

Use this resource to return a list of all systems included in the AWS analysis.

Example: Listing All Systems in an AWS Analysis

Parameters

Path Parameters

Table: AWS System Path Parameters

Parameter Name

Type

Description

analysisId

string

The unique referenced ID of the AWS analysis.

Response

Table: AWS System Response Schema

Element

Type

Filter/Sort

Description

serviceType

string

 

The cloud service type (e.g. EC2, RDS, ASG, SPOT).

Note: Unlike the Densify Console, ASGs with maximum group size of 1 (i.e. maxGroupCurrent=1) will have serviceType=ASG. However, the returned elements are similar to those for an EC2 service (i.e. min/max group size values are not returned).

resourceId

string

 

The AWS identifier assigned to the instance.

powerState

string

 

The power state of the instance.

currentType

string

 

The current instance type of the AWS system.

displayName

string

 

The AWS name assigned to the system.

entityId

string

 

The Densify-assigned entity ID of the AWS system.

href

string

 

The referenced resource to the system entity.

See Systems for details of the /systems resource.

Examples

Example: Listing All Systems in an AWS Analysis

The following example shows you how to return all systems (instances) included in an AWS optimization analysis.

Request:

Copy 
GET /analysis/cloud/aws/8b5d2d56-6d85-4fde-8beb-fcd3cdf8e5b8/systems

Response:

Copy 
[
   {
      "serviceType": "EC2",
      "resourceId": "i-bc1037760797bc103",
      "powerState": "Running",
      "currentType": "t2.medium",
      "displayName": "ex-prod-ecds-216",
      "entityId": "008a502d-0a1a-40d4-bb83-42413289fe1e",
      "href": "/systems/008a502d-0a1a-40d4-bb83-42413289fe1e"
   },
   {
      "serviceType": "EC2",
      "resourceId": "i-00bc71015587bc83",
      "powerState": "Running",
      "currentType": "m4.2xlarge",
      "displayName": "ex-dev-abds-131",
      "entityId": "0090c272-7e02-4dd5-b7f3-ad4bc225fbd2",
      "href": "/systems/0090c272-7e02-4dd5-b7f3-ad4bc225fbd2"
   },
   ...
]