Skip to main content Skip to complementary content

get_endpoint_list

Retrieves a list of endpoints and their properties for the specified server.

Required User Role: See Required Enterprise Manager permissions.

Syntax

def get_endpoint_list(

self,

server

)

Parameters

Parameters
Parameter Type Description
server string The name of the server on which the endpoints are defined.

Return values

AemGetEndpointListResp

Return values
Value Type Description

endpointList

List<Endpoint>

An array of Endpoint objects.

description

string

The endpoint description.

isLicensed

bool

Indicates whether the endpoint is licensed on this server.

name

string

The endpoint name.

role

EndpointRole

{

ALL = 0,

SOURCE = 1,

TARGET = 2,

BOTH = 3

}

The endpoint role: SOURCE or TARGET.

type

string

The endpoint type, for example, Oracle.

Errors

All of the general errors as well as the errors listed in the table below.

Error responses
Error Message Description

AEM_ENDPOINT_LIST_INNER_ERR

Failed to retrieve endpoints list from Replicate server {name}.

Replicate experienced an error/exception when trying to retrieve the endpoint list.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!