Vstats. Counter Metadata Get Default

Vstats. Counter Metadata Get Default

This operation returns the "default" CounterMetadata. A Counter has at least one related metadata object. Usually, stats providers (for example hosts) are in agreement about the default metadata. In this case the returned list has a single metadata object.

Sometimes, when providers are in "disagreement" about the default, then the returned list would include all the possible "defaults". This potential ambiguity isn't a real issue because consumers of the vStats API rarely need to specify the "mid" of metadata. Therefore, this API is used primarily for informational purposes.

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/{cid}/metadata/default
COPY
Path Parameters
string
cid
Required

Counter ID.

The parameter must be an identifier for the resource type: com.vmware.vstats.model.Counter.


Authentication
This operation uses the following authentication methods.
Responses
200

List of counter metadata records.

[
    "Vstats.CounterMetadata.Info Object"
]

400

if cid is 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"

404

if Counter could not be located.

Returns Vapi.Std.Errors.NotFound of type(s) application/json
"Vapi.Std.Errors.NotFound 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/{cid}/metadata/default