REST API - get

vstats retention plans: get default

Returns the default retention plan. 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/retentions/default

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "max_ages" : {
        "hour1" : 1,
        "week1" : 1,
        "minute1" : 1,
        "raw" : 1
    },
    "memo_" : "string",
    "id" : "obj-103"
}

Headers:

None

Type:

Name	Type	Description
bold = required
-	info	Retention plan information.
-.id	string	Retention plan 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.RetentionPlan`. 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.RetentionPlan`.
-.max_ages	max_ages_info	Maximum retention times for the different roll up levels. 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.
-.max_ages.raw	long	Retention time for raw data. Default is one week. Unit is 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.
-.max_ages.minute1	long	Retention time for data rolled up into 1-minute intervals. Unit is 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.
-.max_ages.hour1	long	Retention time for data rolled up into 1-hour intervals. Unit is 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.
-.max_ages.week1	long	Retention time for data rolled up into 1-week intervals. Unit is 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.
-.memo_	string	Consumer provided text about this Retention Plan. 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. if unset no consumer text is set.

Errors:

HTTP Status Code	Type	Description
500	error	if the system reports an error while responding to the request.
404	not_found	if no default retention plan is found.
401	unauthenticated	if the user can not be authenticated.
403	unauthorized	if the user does not have sufficient privileges.