Update Acq Specs
Update an existing acquisition specification. 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/{id}
Path Parameters
Path Parameters
string
id
Required
Acquisition specification ID. The parameter must be an identifier for the resource type: com.vmware.vstats.model.AcqSpec.
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
{
"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"
}
]
}
counters
Optional
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. If unset, the value is unchanged.
integer
expiration
Optional
Expiration time for this acquisition specification in Unix UTC number of seconds (since epoch). When this field is 0, the default expiration duration is 100 minutes. 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, the value is unchanged.
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, the value is unchanged.
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, the value is unchanged.
array of
RsrcId
resources
Optional
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. If unset, the value is unchanged.
Authentication
This operation uses the following authentication methods.
Errors
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.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK 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"
$AcqSpecsUpdateSpec = Initialize-AcqSpecsUpdateSpec -Counters $AcqSpecsCounterSpec -Resources $RsrcId -Interval 0 -Expiration 0 -Memo "MyMemo"
Invoke-UpdateIdStatsAcqSpecs -Id "MyId" -AcqSpecsUpdateSpec $AcqSpecsUpdateSpec
cURL Command
curl -X PATCH -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/{id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: update
On This Page
Acq Specs Operations
get
post
patch
delete
get
