vstats acq specs: get
Returns information about a specific 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:
HTTP request
GET https://{server}/api/stats/acq-specs/{id}
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| id | string | Acquisition specification ID. |
Response:
HTTP Status Code: 200
Response Body Structure:
{
"counters" : {
"cid_mid" : {
"mid" : "obj-103",
"cid" : "obj-103"
},
"set_id" : "obj-103"
},
"resources" : [
{
"predicate" : "EQUAL",
"scheme" : "string",
"type" : "string",
"key" : "string",
"id_value" : "string"
},
{
"predicate" : "EQUAL",
"scheme" : "string",
"type" : "string",
"key" : "string",
"id_value" : "string"
}
],
"interval" : 1,
"expiration" : 1,
"memo_" : "string",
"id" : "obj-103",
"status" : "ENABLED"
}
"counters" : {
"cid_mid" : {
"mid" : "obj-103",
"cid" : "obj-103"
},
"set_id" : "obj-103"
},
"resources" : [
{
"predicate" : "EQUAL",
"scheme" : "string",
"type" : "string",
"key" : "string",
"id_value" : "string"
},
{
"predicate" : "EQUAL",
"scheme" : "string",
"type" : "string",
"key" : "string",
"id_value" : "string"
}
],
"interval" : 1,
"expiration" : 1,
"memo_" : "string",
"id" : "obj-103",
"status" : "ENABLED"
}
Headers:
NoneType:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| - | info | Information about the desired acquisition specification. |
| -.id | string | Acquisition specification 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.AcqSpec. 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.AcqSpec. |
| -.counters | counter_spec | 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. |
| -.counters.cid_mid | cid_mid | Counter and optional meatadata 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. Optional. When unset the set_id field will be used. |
| -.counters.cid_mid.cid | string | Counter Id. CID is a string with rather strong semantic consistency across deployments and versions. If two CIDs are identical it implies the corresponding counters are the same. 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.Counter. 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.Counter. |
| -.counters.cid_mid.mid | string | MID is a 64-bit integer with strong consistency. Given a particular CID=cid, if two MIDs are the same, then the corresponding counter-metadata objects are same. 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 vStats will use default for the counter metadata as obtained from the provider.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.CounterMetadata. 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.CounterMetadata. |
| -.counters.set_id | string | Counter set 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. Optional. When unset the cid_mid field will be used.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.CounterSet. 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.CounterSet. |
| -.resources | rsrc_id[] | 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. |
| -.interval | long | 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. Optional. When this field is unset, default interval is 10 seconds. |
| -.expiration | long | Expiration time for this acquisition specification represented as 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. Optional. When this field is unset or 0, default expiration duration is 100 minutes. |
| -.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. |
| -.status | string | Acquisition Specification status. 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. Describes the status of an Acquisition Specification. Warning: This enumeration 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. Value is one of: ENABLED: The acquisition specification is enabled. Warning: This constant 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. DISABLED: The acquisition specification is disabled. Warning: This constant 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. EXPIRED: The acquisition specification is expired. Warning: This constant 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. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 500 | error | if the system reports an error while responding to the request. |
| 400 | invalid_argument | if id is invalid. |
| 404 | not_found | acquisition specification could not be located. |
| 401 | unauthenticated | if the user can not be authenticated. |
| 403 | unauthorized | if the user does not have sufficient privileges. |