TestEndpoint
Connect to an endpoint to test connectivity and configuration (permissions, CDC configuration, and so on).
Required User Role: See Required Enterprise Manager permissions.
Syntax
public AemTestEndpointResp TestEndpoint(
string server,
string endpoint,
int timeout = 60
);
Parameters
| Parameter | Type | Description |
|---|---|---|
| server | string | The name of the server on which the endpoint is defined. |
|
endpoint |
string |
The name of the endpoint. |
|
timeout |
int |
Time in seconds to wait until getting a response. |
Return values
AemTestEndpointResp
| Parameter | Type | Description |
|---|---|---|
|
Status |
AemEndpointState { UNKNOWN = 0, CONNECTED = 1, ERROR = 2 } |
- |
| Message | string | Short description of the error. |
|
DetailedMessage |
string |
Detailed description of the error. |
Errors
| Error | Message | Description |
|---|---|---|
|
AEM_TEST_ENDPOINT_CONNECTION_TIMEOUT |
A timeout occurred while testing the connection for endpoint {endpoint} on Replicate server {server}. |
Connection was not established within 60 seconds. |
|
AEM_ENDPOINT_NOT_FOUND |
Replicate endpoint {0} on server {1} could not be found. |
The specified endpoint could not be found. |