List Resource Addresses
DescriptionReturns 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
URLURL
https://{api_host}/api/stats/rsrc-addrs
Query Parameters
Query Parameters
string
page
Optional
The ResourceAddresses.FilterSpec.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 ResourceAddresses.list API. 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 set a follow up page in a paged result set will be delivered.
array of
string
resources
Optional
Resources to include in the query. Each resource is specified through a composite string that follows the following format.
type.[.]=
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 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 left unset the result will not be filtered for specific resources.
array of
string
types
Optional
List of Resource types. 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 unset the result will not be filtered by resource types.
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.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
vmware-api-session-id example
b00db39f948d13ea1e59b4d6fce56389
Response
Response
Response BodyResponse Body
200 OK returns
ResourceAddressesListResult of type application/json
Matching resource addresses.
{
"next": "string",
"rsrc_addrs": [
{
"id": "string",
"resource_ids": [
{
"id_value": "string",
"key": "string",
"predicate": "enum",
"scheme": "string",
"type": "string"
}
]
}
]
}
array of
ResourceAddressesInfo
rsrc_addrs
Required
List of Resource Addresses received. 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.
string
next
Optional
Used to retrieve paged data for larger result sets. Token is generated by server. The value of this field should be supplied in a subsequent call to ResourceAddresses.list operation. 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. unset when there are no more pages of data to be retrieved.
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/stats/rsrc-addrs
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if any of the specified parameters are invalid.
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have sufficient privileges.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
