Analysis: GCP Systems

Analysis: GCP Systems

#340640

Description

The /analysis/cloud/gcp/<analysisId>/systems resource is used to return a collection of all the systems that were included in the Google Cloud Platform (GCP) optimization analysis.

The recommendations from an GCP optimization analysis can be obtained using the /analysis/cloud/gcp/<analysisId>/results resource. See Analysis: GCP Recommendations for details on the GCP recommendations resource. The set of analyzed systems may be more than the set of recommendations produced, as there can be potentially no recommendations for some analyzed systems.

Resource

/analysis/cloud/gcp/<analysisId>/systems

Supported Operations

Table: GCP Systems Supported Operations

Operation

HTTP Method

Input

Output

Description

List all systems included in a GCP analysis

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

Path Parameter:

analysisId

Collection of:

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

Example: Listing All Systems in a GCP Analysis

Parameters

Path Parameters

Table: GCP Systems Path Parameters

Parameter Name

Type

Description

analysisId

string

The unique referenced ID of the GCP analysis.

Response

Table: GCP Systems Response Schema

Element

Type

Filter/Sort

Description

serviceType

string

 

The cloud service type (i.e. Compute Engine).

resourceId

string

 

The GCP unique identifier assigned to the instance system.

powerState

string

 

The power state of the system.

currentType

string

 

The current instance type of the system.

displayName

string

 

The GCP name assigned to the system.

entityId

string

 

The Densify assigned entity ID of the system.

href

string

 

The referenced resource to the system entity.

See Systems for details of the /systems resource.

Examples

Example: Listing All Systems in a GCP Analysis

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

Request:

Copy 
GET /analysis/cloud/gcp/d930c31d-13ac-4a3f-892e-2a35c8a3f232/systems

Response:

Copy 
[
   {
      "serviceType": "Compute Engine",
      "resourceId": "4390409739570762220",
      "powerState": "Running",
      "currentType": "n1-standard-8",
      "displayName": "gl08.mln_gas-286",
      "entityId": "00d60166-b9a5-4825-990e-a2efeb3caa32",
      "href": "/systems/00d60166-b9a5-4825-990e-a2efeb3caa32"
   },
   {
      "serviceType": "Compute Engine",
      "resourceId": "4090399486108714123",
      "powerState": "Running",
      "currentType": "n1-highmem-8",
      "displayName": "gl08.hosa_far-348",
      "entityId": "02cbfdb5-3a0d-4ecb-8732-c6f04cfcf7f9",
      "href": "/systems/02cbfdb5-3a0d-4ecb-8732-c6f04cfcf7f9"
   },
   ...
]