Vstats.AcqSpecs.Info

Vstats.AcqSpecs.Info
Vstats.AcqSpecs.Info

The Vstats.AcqSpecs.Info schema is the information about an acquisition specification. It specifies the statistical data that should be collected at desired sampling rates. It designates the resources and their counters which should be sampled, and a desired sampling rate.

Warning: this schema 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.

JSON Example
{
    "id": "string",
    "counters": {
        "cid_mid": {
            "cid": "string",
            "mid": "string"
        },
        "set_id": "string"
    },
    "resources": [
        {
            "key": "string",
            "type": "string",
            "id_value": "string",
            "predicate": "string",
            "scheme": "string"
        }
    ],
    "interval": 0,
    "expiration": 0,
    "memo_": "string",
    "status": "string"
}
string
id
Required

Acquisition specification identifier.

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 clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vstats.model.AcqSpec. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vstats.model.AcqSpec.

Vstats.AcqSpecs.CounterSpec
counters
Required

counters

resources
Required

A set of resource identifiers representing a single resource to be monitored.

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.

integer As int64 As int64
interval
Optional

Desired sampling rate in seconds.

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 this property is missing or null, default interval is 10 seconds.

integer As int64 As int64
expiration
Optional

Expiration time for this acquisition specification represented as Unix UTC number of seconds (since epoch).

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 this property is missing or null or 0, default expiration duration is 100 minutes.

string
memo_
Required

Consumer provided text about this Acquisition Specification.

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.

Vstats.AcqSpecs.Status
status
Required

status