REST API - list
  1. Operations
  2. vstats
  3. resource addresses

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:

HTTP request

GET https://{server}/api/stats/rsrc-addrs

?types={value-1}
&types={value-2}
&rsrcs={value-1}
&rsrcs={value-2}
&page={value}

Query Parameters:

Name Type Description
bold = required
types string[] 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.

Optional. 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.
resources string[] 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 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. When left unset the result will not be filtered for specific resources.
page string 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 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.

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

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "next" : "string",
    "rsrc_addrs" : [
        {
            "id" : "obj-103",
            "resource_ids" : [
                {
                    "predicate" : "EQUAL",
                    "scheme" : "string",
                    "type" : "string",
                    "key" : "string",
                    "id_value" : "string"
                },
                {
                    "predicate" : "EQUAL",
                    "scheme" : "string",
                    "type" : "string",
                    "key" : "string",
                    "id_value" : "string"
                }
            ]
        },
        {
            "id" : "obj-103",
            "resource_ids" : [
                {
                    "predicate" : "EQUAL",
                    "scheme" : "string",
                    "type" : "string",
                    "key" : "string",
                    "id_value" : "string"
                },
                {
                    "predicate" : "EQUAL",
                    "scheme" : "string",
                    "type" : "string",
                    "key" : "string",
                    "id_value" : "string"
                }
            ]
        }
    ]
}

Headers:

None

Type:

Name Type Description
bold = required
- list_result Matching resource addresses.
-.rsrc_addrs info[] 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.
-.rsrc_addrs[].id string Identifier. 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.RsrcAddr. 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.RsrcAddr.
-.rsrc_addrs[].resource_ids rsrc_id[] List of Resource Identifiers. 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.
-.rsrc_addrs[].resource_ids[].key string Key relates to the corresponding ResourceIdDefinition of the related resource address schema. 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. When this field is unset, type field will be used.
-.rsrc_addrs[].resource_ids[].type string Type of the resource identified by the Resource 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.

Optional. When this field is unset, in current version the api will throw InvalidArgument error. To be made optional in future.
-.rsrc_addrs[].resource_ids[].id_value string The id value binding the related resource id definition. 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.
-.rsrc_addrs[].resource_ids[].predicate string Predicate to use to match resource Ids. 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. When this field is unset, default predicate is EQUAL.
-.rsrc_addrs[].resource_ids[].scheme string An optional designation of the scheme. 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. When this field is unset, default scheme is moid (ManagedObject Identifier).
-.next string 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 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.

Optional. unset when there are no more pages of data to be retrieved.

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.