REST API - list
  1. Operations
  2. vstats
  3. acq specs

vstats acq specs: list

Returns information about all acquisition specifications. 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

?page={value}
&epids={value-1}
&epids={value-2}
&status={value}

Query Parameters:

Name Type Description
bold = required
page string Used to retrieve paged data for larger result sets. The value of this token is generated by server and returned as next field in the result of list operations. 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. unset the first page of results will be returned.
endpoints string[] Endpoint filter which is based on endpoints configured to acquisition specifications. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. When unset the result will not be filtered by endpoints configured.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vstats.model.AcqSpec. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vstats.model.AcqSpec.
status string Acquisition specification status filter. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. When unset the result will not be filtered by acquisition specification status.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "next" : "string",
    "acq_specs" : [
        {
            "endpoints" : [
                "obj-103",
                "obj-103"
            ],
            "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_reason" : "string",
            "status" : "ENABLED"
        },
        {
            "endpoints" : [
                "obj-103",
                "obj-103"
            ],
            "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_reason" : "string",
            "status" : "ENABLED"
        }
    ]
}

Headers:

None

Type:

Name Type Description
bold = required
- list_result List of acquisition specification records.
-.acq_specs info[] List of acquisition specifications received. 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.
-.acq_specs[].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.
-.acq_specs[].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.
-.acq_specs[].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.
-.acq_specs[].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.
-.acq_specs[].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.
-.next string The next field is a token used to retrieve paged data for larger result sets. This is opaque token generated by the server. It is to be sent in the vstats.acq_specs.filter_spec.page field to issue a subsequent call to the list operation for retrieving results that did not fit the current page. 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. set when there are more results to retrieve.

Errors:

HTTP Status Code Type Description
500 error if the system reports an error while responding to the request.
400 invalid_argument if any of the specified parameters are invalid.
401 unauthenticated if the user can not be authenticated.
403 unauthorized if the user does not have sufficient privileges.