OpenAPI Get Recommendations

The public api for partner to get recommendations by CloudVerse

Service: Recommendation

API version: 1.0.0

URI

POST https://{host}/api-gw/cloud-provider-driver/recommendations

---

Authentication

Api-key

Example:

Key	Value	In
api-key	2DexvlG3bB9VT6SuoRaW6UzsFzNKWC55y	Header

Request Body

{
    "orgId": <number>,
    "orderBy"?:  <RecommendationOrder[]>,
    "filter"?:  <RecommendationFilterInput>,
    "skip": <number>,
    "take": <number>
}

• RecommendationOrder

  {
      field: <String>, 
      direction: <String>
  }

  • Field Enum

    {
      id = 'id',
      createdAt = 'createdAt',
      updatedAt = 'updatedAt',
      description = 'description',
      provider = 'provider',
      priority = 'priority',
      state = 'state',
      region = 'regionId',
      potentialSaving = 'potentialSaving',
      assetName = 'assetName',
      accountName = 'accountName',
    }

  • Direction Enum

    {
      asc = 'asc',
      desc = 'desc',
    }

• RecommendationFilterInput

  {
  	generatedBy: <Boolean[]>
  	integrationIds:<Number[]>
  	provider:<String[]>
  	recommendationResourceSubtype:<String[]>
  	recommendationResourceType:<String[]>
  	region: <String[]>
  	state: <String[]>
  }

Description

No	Key	Description
1	orgId	Organization Id in CloudVerse
2	orderBy	Sort Items
2.1	field	Name of field need to sort
2.2	direction	Sort Ascending or Descending
3	filter	Filter Condition to get recommendation
3.1	generatedBy	Generated by CloudProvider or CloudVerse
3.2	integrationIds	Account IntegrationId in CloudVerse
3.3	provider	Cloud Provider
3.4	recommendationResourceSubtype
3.5	recommendationResourceType
3.6	region	Region locate Instance
3.7	state	State of recommendation
4	skip	Number of page
5	take	Number of element

Example

{
	"orgId": 1,
	"orderBy": [
		{
			"field": "assetName",
			"direction": "asc"
		}
	],
	"filter":  {
		"generatedBy":["true", "true"],
		"integrationIds":[],
		"provider":["AWS", "AZURE" ],
		"recommendationResourceSubtype":[],
		"recommendationResourceType":[],
		"region": [],
		"state": ["DISMISSED","ACTIVE"]
	},
	"skip": 0,
	"take": 10
}

Response

No	Code	Message
1	200	Success
2	401	Unauthorized
3	Other

Success Data Response

{
  "nodes":[{
      "action": <String>,
      "category": <String>,
      "categoryResource": <String>,
      "createdAt": <DateTime UTC>,
      "currencyUnit": <String>,
      "description": <String>,
      "displayResourceConsoleUrl": <String>,
      "durationInSecond": <Number>,
      "id": <Number>,
      "integration": {
          "id": <Number>,
          "name": <String>
      },
      "isCustom": true,
      "jobInfo": {
          "resourceType": {
              "label": <String>,
              "name": <String>
          }
      },
      "potentialSaving": <Number>,
      "priority": <String>,
      "provider": <String>,
      "recommenderInsight": [],
      "regionId": <String>,
      "resourceConsoleUrl": <String>,
      "resourceData": {
          "id": <Number>,
          "name": <String>,
          "regionId": <String>
      },
      "resourceSubtype": {
          "label": <String>,
          "name": <String>
      },
      "resourceType": {
          "label": <String>,
          "name": <String>
      },
      "state": <String>,
      "title": <String>,
      "type": <String>,
      "updatedAt": <Datetime UTC>
  }]
  "pageInfo": {
      "currentPage": <Number>,
      "nodeCount": <Number>,
      "hasNextPage": <Boolean>,
      "hasPrevPage": <Boolean>,
  },
  "totalCount": <Number>,
  "totalSaving": <Number>
}

Description

No	Key	Description
1	nodes	List of Recommendations
2	pageInfo
2.1	currentPage	Serial number of current page
2.2	hasNextPage	If has next page return true else return false
2.3	hasPrevPage	If has previous page return true else return false
2.4	nodeCount	Number of Element
3	nodes	Filter Condition to get recommendation
3.1	id	Id of recommendation in CloudVerse
3.2	title	Generated by CloudProvider or CloudVerse
3.3	description	Account IntegrationId in CloudVerse
3.4	provider	Cloud Supply
3.5	regionId	Region locate Instance Id
3.6	resourceData
3.6.1	id	Id of resource
3.6.2	name	Name of resource
3.6.3	regionId	Region of resource
3.7	state	Region locate Instance
3.8	potentialSaving	Cost Saving of Recommendation
3.9	currencyUnit	Unit of currency
3.10	cloudState
3.11	errorState
3.12	location
3.13	action	action advise to optimize cost
3.14	category
3.15	durationInSecond
3.16	displayResourceConsoleUrl
3.17	resourceConsoleUrl	Console url of resource
3.18	categoryResource	Category of resource
3.19	type
3.20	createdAt	time create
3.21	updatedAt	time update
3.22	jobInfo
3.22.1	resourceType
3.22.1.1	id	id of resourceType
3.22.1.2	name
3.22.1.3	label
3.22.1.4	categoryId
3.22.1.5	createdAt
3.22.1.6	updatedAt
3.23	subType
3.24	isCustom	True if recommendation of CloudVerse
3.25	recommenderInsight
3.26	resourceType
3.26.1	name
3.26.2	label
3.27	resourceSubtype
3.27.1	name
3.27.2	label
3.28	integration	Integration in CloudVerse
3.28.1	id	Id of Integration in CloudVerse
3.28.2	name	Name of Integration in CloudVerse
4	totalCount	Number of recommend in nodelist
5	totalSaving	Total amount Saving when do recommendation

Example

{
    "pageInfo": {
        "currentPage": 1,
        "hasNextPage": false,
        "hasPrevPage": false,
        "nodeCount": 3
    },
    "nodes": [
        {
            "id": 1,
            "title": "Save $23.59 / Month by deleting the Snapshot 'snap-0285cd391af51d32f'",
            "description": "A snapshot is unused for more than 30 days. <br/>",
            "provider": "AWS",
            "resourceData": {
                "id": 5,
                "name": "snap-0285cd391af51d32f",
                "regionId": "ap-southeast-1"
            },
            "regionId": "ap-southeast-1",
            "priority": "MEDIUM",
            "potentialSaving": 23.59,
            "currencyUnit": "USD",
            "cloudState": "ACTIVE",
            "state": "ACTIVE",
            "errorState": null,
            "location": null,
            "action": "Delete",
            "category": "COST",
            "durationInSecond": 103494,
            "displayResourceConsoleUrl": null,
            "resourceConsoleUrl": null,
            "categoryResource": "STORAGE",
            "type": "ASSET",
            "createdAt": "2024-06-27T04:02:56.117Z",
            "updatedAt": "2024-06-27T04:02:56.117Z",
            "jobInfo": {
                "resourceType": {
                    "id": 167,
                    "name": "CustomRecommendationGenerationIdle",
                    "label": "Idle Resource",
                    "categoryId": 20,
                    "createdAt": "2024-06-26T08:38:00.487Z",
                    "updatedAt": "2024-06-26T08:38:00.487Z"
                }
            },
            "subType": "IDLE_SNAPSHOT",
            "isCustom": true,
            "recommenderInsight": [],
            "resourceType": {
                "name": "IDLE_RESOURCE",
                "label": "Idle Resource"
            },
            "resourceSubtype": {
                "name": "IDLE_SNAPSHOT",
                "label": "Idle Snapshot"
            },
            "integration": {
                "id": 1,
                "name": "AWS account Duy99"
            }
        }
    ],
    "totalCount": 3,
    "totalSaving": 24.81
}