REST API - get

vcenter hvc links sync providers: get

Gets Sync information for a sync provider. Warning: This operation is available as technical preview. It may be changed in a future release.

Request:

HTTP request

GET https://{server}/rest/hvc/links/{link}/sync/providers/{provider}

Path Parameters

Name	Type	Description
Required
link	string	Unique identifier of the link.
provider	string	Unique identifier of the sync provider.

Response:

HTTP Status Code: 200

Representation:

JSON

{
    "value": {
        "current_session_info": {
            "completed_work": 1,
            "completion_time": "2015-01-01T22:13:05.651Z",
            "exception": {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            },
            "stage": "CHANGE_DETECTION",
            "start_time": "2015-01-01T22:13:05.651Z",
            "total_work": 1
        },
        "last_sync_time": "2015-01-01T22:13:05.651Z",
        "polling_interval_in_seconds": 1,
        "status": "SUCCEEDED",
        "status_message": {
            "args": [
                "string",
                "string"
            ],
            "default_message": "string",
            "id": "string"
        }
    }
}

Response Type:

Name	Type	Description
bold = required
value	info	The Info of sync information for the provider.
value.last_sync_time	date_time	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 technical preview. It may be changed in a future release. Optional. If unset no sync was found for the provider.
value.status	string	Last Sync status for the provider. Warning: This attribute is available as technical preview. It may be changed in a future release. Defines valid sync status. Warning: This enumeration is available as technical preview. It may be changed in a future release. Value is one of: SUCCEEDED: If Sync was successful. Warning: This constant is available as technical preview. It may be changed in a future release. FAILED: If Sync failed. Warning: This constant is available as technical preview. It may be changed in a future release. NO_SYNC_FOUND: If Sync has not been triggered. Warning: This constant is available as technical preview. It may be changed in a future release.
value.polling_interval_in_seconds	long	Sync Polling interval between local and remote replicas for the provider. Warning: This attribute is available as technical preview. It may be changed in a future release.
value.current_session_info	session_info	Returns information on the forced sync for the provider. Warning: This attribute is available as technical preview. It may be changed in a future release. Optional. If unset there is no outstanding sync session created for this provider.
value.current_session_info.stage	string	Sync stage for the session. Warning: This attribute is available as technical preview. It may be changed in a future release. The `stage` structure defines the different stages of Sync. Warning: This enumeration is available as technical preview. It may be changed in a future release. Value is one of: CHANGE_DETECTION: Changes are being detected on the source replica. Warning: This constant is available as technical preview. It may be changed in a future release. CHANGE_ENUMERATION: Changes from the source replica are being enumerated. Warning: This constant is available as technical preview. It may be changed in a future release. CHANGE_APPLICATION: Changes are being applied to the destination replica. Warning: This constant is available as technical preview. It may be changed in a future release. COMPLETED: Sync has completed. Warning: This constant is available as technical preview. It may be changed in a future release. FAILED: Sync failed. Warning: This constant is available as technical preview. It may be changed in a future release. WAITING: Session is waiting for progress to be set. Warning: This constant is available as technical preview. It may be changed in a future release.
value.current_session_info.completed_work	long	Completed work for the session. Warning: This attribute is available as technical preview. It may be changed in a future release.
value.current_session_info.total_work	long	Total work for the session. Warning: This attribute is available as technical preview. It may be changed in a future release.
value.current_session_info.completion_time	date_time	Time at which forced sync session was completed. Warning: This attribute is available as technical preview. It may be changed in a future release. Optional. It is only relevant when stage has value [FAILED, COMPLETED]. If unset there is an ongoing sync that has not completed.
value.current_session_info.start_time	date_time	Time at which force sync was initiated. Warning: This attribute is available as technical preview. It may be changed in a future release.
value.current_session_info.exception	localizable_message	Exception message if there is a sync failure on forced sync. Warning: This attribute is available as technical preview. It may be changed in a future release. Optional. It is only relevant when stage has value [FAILED]. This field is optional and it is only relevant when the value of `stage` is FAILED.
value.current_session_info.exception.id	string	Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.current_session_info.exception.default_message	string	The value of this localizable string or message template in the `en_US` (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.current_session_info.exception.args	string[]	Arguments to be substituted into a message template.
value.status_message	localizable_message	Localizable messages associated with sync status. Warning: This attribute is available as technical preview. It may be changed in a future release. Optional. It is only relevant when status has value [FAILED]. This field is optional and it is only relevant when the value of `status` is FAILED.
value.status_message.id	string	Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.status_message.default_message	string	The value of this localizable string or message template in the `en_US` (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.status_message.args	string[]	Arguments to be substituted into a message template.

Errors:

HTTP Status Code	Type	Description
500	error	If get fails.
404	not_found	If the sync provider associated with `provider` does not exist.
403	unauthorized	If the user is not authorized to perform this operation.