REST API - list

vstats metrics: list

Returns list of available Metrics as supplied by the discovered providers. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Request:

HTTP request

GET https://{server}/api/stats/metrics

Response:

HTTP Status Code: 200

Response Body Structure:

[
    {
        "metric""obj-103"
    },
    {
        "metric""obj-103"
    }
]

Headers:

None

Type:

Name Type Description
bold = required
- summary[] List of Metrics.
-[].metric string Metric name. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vstats.model.Metric. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vstats.model.Metric.

Errors:

HTTP Status Code Type Description
500 error if the system reports an error while responding to the request.
401 unauthenticated if the user can not be authenticated.
403 unauthorized if the user does not have sufficient privileges.