Vstats. Resource Addresses List

Vstats. Resource Addresses List

Returns the list of Resource Addresses 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/rsrc-addrs
COPY
Query Parameters
string of array
types
Optional

List of Resource types.

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.

When missing or null the result will not be filtered by resource types.

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 of array
rsrcs
Optional

Resources to include in the query. Each resource is specified through a composite string that follows the following format.

type.<resource type>[.<scheme>]=<resource id>

resource type specifies the type of resource for example VM, VCPU etc.

scheme is an optional element to disambiguate the resource as needed for example to differentiate managed object id from uuid.

resource id is the unique resource identifier value for example: vm-41

Example values include: type.VM=vm-41, type.VCPU=1, type.VM.moid=vm-41

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.

When left missing or null the result will not be filtered for specific resources.

string
page
Optional

The page field is used to retrieve paged data for large result sets. It is an opaque paging token obtained from a prior call to the GET /stats/rsrc-addrs API.

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.

when set a follow up page in a paged result set will be delivered.


Authentication
This operation uses the following authentication methods.
Responses
200

Matching resource addresses.

Returns Vstats.ResourceAddresses.ListResult of type(s) application/json
"Vstats.ResourceAddresses.ListResult Object"

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/rsrc-addrs