GET /xpanse/metrics – Eclipse Xpanse XpanseAPI

Monitor

Changed on Apr 17, 2025

Get metrics of a deployed service or a resource. Required role: admin or user

get/xpanse/metrics

Request

Base URL: http://localhost:8080
URL: http://localhost:8080/xpanse/metrics
Auth: OAuth 2 (authorization code, authorization URL https://xpanse-demo.eclipseprojects.io/oauth/v2/authorize, token URL https://xpanse-demo.eclipseprojects.io/oauth/v2/token)

Query parameters

serviceIdstring uuid required

Id of the deployed service

resourceIdstring uuid

Id of resource in the deployed service

monitorResourceType'cpu' | 'mem' | 'vm_network_incoming' | 'vm_network_outgoing'

Types of the monitor resource.

frominteger

Start UNIX timestamp in milliseconds. If no value filled,the default value is the UNIX timestamp in milliseconds of the five minutes ago.

tointeger

End UNIX timestamp in milliseconds. If no value filled,the default value is the UNIX timestamp in milliseconds of the current time.

granularityinteger

Return metrics collected in provided time interval. This depends on how the source systems have generated/collected metrics.

onlyLastKnownMetricboolean

Returns only the last known metric. When this parameter is set then all other query parameters are ignored.

Response

namestring required

The name of the metric.

descriptionstring

The description of the metric.

type'counter' | 'gauge' | 'histogram' | 'summary' required

monitorResourceType'cpu' | 'mem' | 'vm_network_incoming' | 'vm_network_outgoing' required

unit'mb' | 'kb' | 'percentage' | 'bit/s' | 'Byte/s' required

labelsobject

The labels of the metric.

Changes

Apr 17, 202510c3487eebbc Revision changes
- warning
  added the new Invalid Service Deployment State enum value to the response property for the response status
- warning
  added the new Invalid Service Deployment State enum value to the response property for the response status
- warning
  added the new Invalid Service Deployment State enum value to the response property for the response status
- warning
  added the new Invalid Service Deployment State enum value to the response property for the response status
- warning
  added the new Invalid Service Deployment State enum value to the response property for the response status
- warning
  added the new Invalid Service Deployment State enum value to the response property for the response status
- warning
  added the new Invalid Service Deployment State enum value to the response property for the response status
- warning
  added the new Invalid Service Object Request enum value to the response property for the response status
- warning
  added the new Invalid Service Object Request enum value to the response property for the response status
- warning
  added the new Invalid Service Object Request enum value to the response property for the response status
- warning
  added the new Invalid Service Object Request enum value to the response property for the response status
- warning
  added the new Invalid Service Object Request enum value to the response property for the response status
- warning
  added the new Invalid Service Object Request enum value to the response property for the response status
- warning
  added the new Invalid Service Object Request enum value to the response property for the response status
- warning
  added the new Service Object Change Order Already Exists enum value to the response property for the response status
- warning
  added the new Service Object Change Order Already Exists enum value to the response property for the response status
- warning
  added the new Service Object Change Order Already Exists enum value to the response property for the response status
- warning
  added the new Service Object Change Order Already Exists enum value to the response property for the response status
- warning
  added the new Service Object Change Order Already Exists enum value to the response property for the response status
- warning
  added the new Service Object Change Order Already Exists enum value to the response property for the response status
- warning
  added the new Service Object Change Order Already Exists enum value to the response property for the response status
- warning
  added the new Service Object Not Found enum value to the response property for the response status
- warning
  added the new Service Object Not Found enum value to the response property for the response status
- warning
  added the new Service Object Not Found enum value to the response property for the response status
- warning
  added the new Service Object Not Found enum value to the response property for the response status
- warning
  added the new Service Object Not Found enum value to the response property for the response status
- warning
  added the new Service Object Not Found enum value to the response property for the response status
- warning
  added the new Service Object Not Found enum value to the response property for the response status
Feb 28, 20254595066769f9 Revision changes
- warning
  added the new Service Action Change Order Already Exists enum value to the response property for the response status
- warning
  added the new Service Action Change Order Already Exists enum value to the response property for the response status
- warning
  added the new Service Action Change Order Already Exists enum value to the response property for the response status
- warning
  added the new Service Action Change Order Already Exists enum value to the response property for the response status
- warning
  added the new Service Action Change Order Already Exists enum value to the response property for the response status
- warning
  added the new Service Action Change Order Already Exists enum value to the response property for the response status
- warning
  added the new Service Action Change Order Already Exists enum value to the response property for the response status
- warning
  added the new Service Configuration Change Order Already Exists enum value to the response property for the response status
- warning
  added the new Service Configuration Change Order Already Exists enum value to the response property for the response status
- warning
  added the new Service Configuration Change Order Already Exists enum value to the response property for the response status
- warning
  added the new Service Configuration Change Order Already Exists enum value to the response property for the response status
- warning
  added the new Service Configuration Change Order Already Exists enum value to the response property for the response status
- warning
  added the new Service Configuration Change Order Already Exists enum value to the response property for the response status
- warning
  added the new Service Configuration Change Order Already Exists enum value to the response property for the response status

Operation history (25 revisions)