REST API - 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:

HTTP request

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

?cid={obj-103}
&types={value-1}
&types={value-2}
&metric={obj-103}

Query Parameters:

Name	Type	Description
bold = required
cid	string	Counter identifier that will be listed. 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. Optional. If unset counter filter will not be applied.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.Counter`. 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.Counter`.
types	string[]	Resource type filter. 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. Optional. If unset resource type filter will not be applied.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: `com.vmware.vstats.model.RsrcType`. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: `com.vmware.vstats.model.RsrcType`.
metric	string	Metric for which counters will be listed. 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. Optional. If unset metric filter will not be applied.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`.

Response:

HTTP Status Code: 200

Response Body Structure:

[
    {
        "resource_address_schema" : "obj-103",
        "metric" : "obj-103",
        "cid" : "obj-103"
    },
    {
        "resource_address_schema" : "obj-103",
        "metric" : "obj-103",
        "cid" : "obj-103"
    }
]

Headers:

None

Type:

Name	Type	Description
bold = required
-	info[]	List of Counters.
-[].cid	string	Counter Id. 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.Counter`. 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.Counter`.
-[].metric	string	A metric is typically human-legible ASCII/English name of a measurable aspect, for example "length" and "temperature". It is not internationalizable. 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`.
-[].resource_address_schema	string	Describes formally how to address (or identify) the resources the counter could be bound to (or instantiated for). 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.RsrcAddrSchema`. 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.RsrcAddrSchema`.

Errors:

HTTP Status Code	Type	Description
500	error	if the system reports an error while responding to the request.
400	invalid_argument	if any of the specified parameters are invalid.
401	unauthenticated	if the user can not be authenticated.
403	unauthorized	if the user does not have sufficient privileges.