Developer Documentation
Create Acq Specs
Create a new acquisition specification record. 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/acq-specs
Request Body
Request Body
Contains
AcqSpecsCreateSpec
of type application/json
(required)
{
"counters": {},
"resources": [
{
"id_value": "string"
}
]
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | counters | AcqSpecsCounterSpec |
Designates the counter(s) to be sampled. 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. |
| required | resources | array of RsrcId |
A set of resource identifiers representing a single resource to be monitored. 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 | expiration | integer |
Expiration time for this acquisition specification in Unix UTC number of seconds (since epoch). 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 this field is unset or 0, default expiration duration is 100 minutes. |
| optional | interval | integer |
Desired sampling rate in seconds. 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. If unset default of 10s will be used. |
| optional | memo_ | string |
Consumer provided text about this acquisition specification. 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. If unset default empty string will be used. |
Response
Response
Response BodyResponse Body
201 Created returns
string
of type application/json
Identifier of the newly created acquisition specification. The result will be an identifier for the resource type: com.vmware.vstats.model.AcqSpec.
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | Error | 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 | Error | com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. |
| default | Error | Not available |
| 400 | Error | com.vmware.vapi.std.errors.invalid_argument : if acqSpec contain any errors. |
On This Page
Acq Specs Operations
get
post
get
patch
delete
