List Counters
DescriptionReturns 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
URLURL
https://{api_host}/api/stats/counters
Query Parameters
Query Parameters
filter
Optional
Filters the returned records.
When unset no filtering will be applied.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Example: b00db39f948d13ea1e59b4d6fce56389
Response
Response
Response BodyResponse Body
200 OK returns
array of
CountersInfo
of type application/json
List of Counters.
{
"cid": "string",
"metric": "string",
"resource_address_schema": "string"
}
string
cid
Required
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.
string
metric
Required
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.
string
resource_address_schema
Required
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.
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/stats/counters
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if any of the specified parameters are invalid.
401
com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. | com.vmware.vapi.std.errors.unauthorized : if the user does not have sufficient privileges.
404
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
Counters Operations
get
get
