REST API - list
  1. Operations
  2. vstats
  3. providers

vstats providers: list

Returns a list of stats providers. 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/providers

Response:

HTTP Status Code: 200

Response Body Structure:

[
    {
        "metadata" : "string",
        "scheme" : "string",
        "id" : "obj-103",
        "type" : "string",
        "id_value" : "string",
        "tracking_sn" : 1
    },
    {
        "metadata" : "string",
        "scheme" : "string",
        "id" : "obj-103",
        "type" : "string",
        "id_value" : "string",
        "tracking_sn" : 1
    }
]

Headers:

None

Type:

Name Type Description
bold = required
- summary[] List of stats providers.
-[].id string Provider 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.Provider. 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.Provider.
-[].id_value string The ID given to the provider by its respective inventory. 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.
-[].type string Provider type. 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.
-[].scheme string An optional designation of the scheme. 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 provider is not designating a specific scheme.

Errors:

HTTP Status Code Type Description
500 error if the system reports an error while responding to the request.
401 unauthenticated if the user can not be authenticated.
403 unauthorized if the user does not have sufficient privileges.