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
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
AcqSpecsCreateSpec of mimetype application/json
Required
Specification for the acquisition of stats data.
{
"counters": {},
"resources": [
{
"id_value": "string"
}
]
}
counters
Required
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.
array of
RsrcId
resources
Required
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.
integer
expiration
Optional
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.
integer
interval
Optional
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.
string
memo_
Optional
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.
Authentication
This operation uses the following authentication methods.
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.
Code Samples
PowerCLI Client SDK Example
$AcqSpecsCounterSpec = Initialize-AcqSpecsCounterSpec
$RsrcId = Initialize-RsrcId -IdValue "MyIdValue"
$AcqSpecsCreateSpec = Initialize-AcqSpecsCreateSpec -Counters $AcqSpecsCounterSpec -Resources $RsrcId
Invoke-CreateStatsAcqSpecs -AcqSpecsCreateSpec $AcqSpecsCreateSpec
PowerCLI Client SDK All Parameters Example
$CidMid = Initialize-CidMid -Cid "MyCid" -Mid "MyMid"
$AcqSpecsCounterSpec = Initialize-AcqSpecsCounterSpec -CidMid $CidMid -SetId "MySetId"
$RsrcId = Initialize-RsrcId -Key "MyKey" -Type "MyType" -IdValue "MyIdValue" -Predicate "EQUAL" -Scheme "MyScheme"
$AcqSpecsCreateSpec = Initialize-AcqSpecsCreateSpec -Counters $AcqSpecsCounterSpec -Resources $RsrcId -Interval 0 -Expiration 0 -Memo "MyMemo"
Invoke-CreateStatsAcqSpecs -AcqSpecsCreateSpec $AcqSpecsCreateSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"counters":{"cid_mid":{"cid":"string","mid":"string"},"set_id":"string"},"expiration":0,"interval":0,"memo_":"string","resources":[{"id_value":"string","key":"string","predicate":"EQUAL","scheme":"string","type":"string"}]}' https://{api_host}/api/stats/acq-specs
Errors
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.
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create
On This Page
Acq Specs Operations
get
post
get
patch
delete
