This API has a deprecated equivalent from v7.0U1.
Get Links Sync Providers
Gets Sync information for a sync provider. Usage beyond VMware Cloud on AWS is not supported. 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
URLURL
https://{api_host}/api/hvc/links/{link}/sync/providers/{provider}
Path Parameters
Path Parameters
string
link
Required
Unique identifier of the link The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.Links.
string
provider
Required
Unique identifier of the sync provider. The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.sync.Providers.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
HvcLinksSyncProvidersInfo of type application/json
The Info of sync information for the provider.
{
"current_session_info": {
"completed_work": 0,
"completion_time": "string",
"exception": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"stage": "CHANGE_DETECTION",
"start_time": "string",
"total_work": 0
},
"last_sync_time": "string",
"polling_interval_in_seconds": 0,
"status": "SUCCEEDED",
"status_message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
}
}
integer
polling_interval_in_seconds
Required
Sync Polling interval between local and remote replicas for the provider. 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.
status
Required
The Providers.Status enumerated type defines valid sync status. Warning: This enumeration 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.
SUCCEEDED : If Sync was successful. Warning: This constant 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.
FAILED : If Sync failed. Warning: This constant 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.
NO_SYNC_FOUND : If Sync has not been triggered. Warning: This constant 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.
Possible values are: SUCCEEDED , FAILED , NO_SYNC_FOUND
current_session_info
Optional
Returns information on the forced sync for the provider. 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. If unset there is no outstanding sync session created for this provider
string
last_sync_time
Optional
Last sync time for the provider. This indicates the last time that either a background sync or a force sync was started for the provider. 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. If unset no sync was found for the provider.
status_message
Optional
Localizable messages associated with sync status. 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. This field is optional and it is only relevant when the value of Providers.Info.status is FAILED.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user is not authorized to perform this operation.
404
com.vmware.vapi.std.errors.not_found : if the sync provider associated with provider does not exist.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
Code Samples
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/hvc/links/{link}/sync/providers/{provider}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/hvc/links/{link}/sync/providers/{provider}
x-vmw-doc-operation: get
Availability
Added in 7.0U2
