Content SubscribedLibrary sync
Forces the synchronization of the subscribed library.
Synchronizing a subscribed library forcefully with this operation will perform the same synchronization behavior as would run periodically for the library. The Content Library SubscriptionInfo.on_demand setting is respected. Calling this operation on a library that is already in the process of synchronizing will have no effect.
Returns an authorization error if you do not have all of the privileges described as follows:
- The resource
com.vmware.content.Libraryreferenced by the parameter libraryId requiresContentLibrary.SyncLibrary.
Identifier of the subscribed library to synchronize.
The parameter must be an identifier for the resource type: com.vmware.content.Library.
Success!
Vapi Std Errors InvalidElementType if the library specified by libraryId is not a subscribed library.
Vapi Std Errors NotAllowedInCurrentState 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 synchronizing a 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.
Vapi Std Errors InvalidArgument if some parameter in the subscribed library subscription info is invalid.
{
"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"
}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.
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.
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.
if the library specified by libraryId does not exist.
"Vapi Std Errors NotFound Object"if the published library cannot be contacted or found.
"Vapi Std Errors ResourceInaccessible Object" curl -X POST -H 'Authorization: <value>' https://{api_host}/api/content/subscribed-library/{libraryId}?action=sync