Content SubscribedLibrary evict

Content SubscribedLibrary evict

Evicts the cached content of an on-demand subscribed library.

This operation allows the cached content of a subscribed library to be removed to free up storage capacity. This operation will only work when a subscribed library is synchronized on-demand.

Returns an authorization error if you do not have all of the privileges described as follows:

  • The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.EvictSubscribedLibrary.
Request
URI
POST
https://{api_host}/api/content/subscribed-library/{libraryId}?action=evict
COPY
Path Parameters
string
libraryId
Required

Identifier of the subscribed library whose content should be evicted.

The parameter must be an identifier for the resource type: com.vmware.content.Library.

Authentication
This operation uses the following authentication methods.
Responses
204

Success!

Operation doesn't return any data structure

400

Vapi Std Errors InvalidElementType if the library specified by libraryId is not a subscribed library.

Vapi Std Errors NotAllowedInCurrentState if the library specified by libraryId does not synchronize on-demand, or if the content of the library specified by libraryId has been deleted from the storage backings (see Content LibraryModel.storage_backings) associated with it.

For instance, this {@term error) is reported on evicting an on-demand subscribed library that was restored from backup, and the library was deleted after the backup was taken, thus resulting in its content being deleted from the associated storage backings. In this scenario, the metadata of the library is present on a restore, while its content has been deleted.

Returns Vapi Std Errors Error of type(s) application/json 
{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": "Vapi Std NestedLocalizableMessage Object",
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}
array of object
messages
Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string
error_type
Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.


404

if the library specified by libraryId does not exist.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0 
"Vapi Std Errors NotFound Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' https://{api_host}/api/content/subscribed-library/{libraryId}?action=evict
On This Page
Content Operations
GET
Content SubscribedLibrary list
POST
Content SubscribedLibrary create
GET
Content SubscribedLibrary get
DELETE
Content SubscribedLibrary delete
PATCH
Content SubscribedLibrary update
POST
Content SubscribedLibrary evict
POST
Content SubscribedLibrary sync
POST
Content SubscribedLibrary probe