Search Metrics
You can start a search to get a sortable, filterable and paginated list of metrics in an organization
Unique identifier (GUID) of the organization
Locale with language preference (e.g. en_US)
Sorting criteria for the paginated request in the format: "property(,asc|desc)". For multiple sort criteria: "sort=property1(,asc|desc)&sort=property2(,asc|desc)". Supported sorting properties are "metric_id, service_definition_id, seller_id, usage_date_time, commit_quantity, usage_quantity, overage_quantity, status". Default is "metric_id,asc"
Filtering criteria for the paginated request in the format: "property,eq:value". For multiple filter criteria: "filter=property1,eq:value&filter=property2,eq:value". Supported filtering properties are "metric_id, service_definition_id, seller_id, usage_date_time, commit_quantity, usage_quantity, overage_quantity, status. A property may be specified multiple times to match against multiple values"
Size of each page. Default = 20
The index of requested page (0-based). Default = 0
Unique identifier of the resource
JSON object containing filter criteria as charge attributes
{
"charge_attributes": {
"aws_region": "EU_WEST_3",
"category": "HOST_USAGE"
}
}OK
{
"content": [
{
"metadata": {
"metric_id": "<metric ID for vRNI vCPUs Public Cloud>",
"service_definition_id": "<service definition ID for VMC-AWS>",
"display_name": "i3en US West 2",
"unit_of_measure_display_name": "Hosts",
"charge_attributes": {
"category": "HOST_USAGE"
}
},
"usage": {
"commitment": 3,
"usage": 3,
"overage": 0,
"status": "AT_COMMITMENT",
"seller": "VMWARE",
"last_updated": "2021-06-20T01:02:03.000Z",
"resources": [
{
"resource_id": "res1",
"usage_quantity": 10
}
]
}
}
],
"empty": false,
"first": false,
"last": false,
"number": 0,
"number_of_elements": 0,
"pageable": {
"offset": 0,
"page_number": 0,
"page_size": 0,
"paged": false,
"sort": {
"empty": false,
"sorted": false,
"unsorted": false
},
"unpaged": false
},
"size": 0,
"sort": {
"empty": false,
"sorted": false,
"unsorted": false
},
"total_elements": 0,
"total_pages": 0
}True if no elements in the system match given request
True if this is the first page of items
True if this is the last page of MetricUsage items
The number of MetricUsage items in the response for given request after pagination operations. If number of items is less then size, it will be equal to total_elements.
Max number of MetricUsage items in the response (controlled by query parameter size or system default)
The total number of MetricUsage items in the system for given request.
Bad Request
{
"error_code": "string",
"error_message": "string",
"error_details": [
{
"error_code": "string",
"error_message": "string"
}
]
}The code associated with the error
A description of the error that occurred
Additional error details for ValidationException errors
Unauthorized
Forbidden