Vstats. Counters List

Vstats. Counters List

Returns information about all counters matching the filter parameters.

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
URI
GET
https://{api_host}/stats/counters
COPY
Query Parameters
string
cid
Optional

Counter identifier that will be listed.

Warning: this property 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.

If missing or null counter filter will not be applied.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vstats.model.Counter. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vstats.model.Counter.

string of array
types
Optional

Resource type filter.

Warning: this property 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.

If missing or null resource type filter will not be applied.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.vstats.model.RsrcType. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.vstats.model.RsrcType.

string
metric
Optional

Metric for which counters will be listed.

Warning: this property 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.

If missing or null metric filter will not be applied.

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


Authentication
This operation uses the following authentication methods.
Responses
200

List of Counters.

[
    "Vstats.Counters.Info Object"
]
Optional

400

if any of the specified parameters are invalid.

Returns Vapi.Std.Errors.InvalidArgument of type(s) application/json
"Vapi.Std.Errors.InvalidArgument Object"

401

if the user can not be authenticated.

Returns Vapi.Std.Errors.Unauthenticated of type(s) application/json
"Vapi.Std.Errors.Unauthenticated Object"

403

if the user does not have sufficient privileges.

Returns Vapi.Std.Errors.Unauthorized of type(s) application/json
"Vapi.Std.Errors.Unauthorized Object"

500

if the system reports an error while responding to the request.

Returns Vapi.Std.Errors.Error of type(s) application/json
"Vapi.Std.Errors.Error Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/stats/counters