Obtaining information about data domains

You can list one or more data domains using endeca-cmd list-dd, or the operations from the Manage Web Service.

For each data domain, the Endeca Server returns its name, description, whether it is enabled, and other characteristics.

To list data domains:

  1. Use a command-line window (for example, open a Command Prompt in Windows) and navigate to the endeca-cmd directory or access the Manage Web Service.
  2. Use one of these options, depending on which list you would like to receive:
    Option Description
    listDataDomains in the Manage Web Service, or the equivalent endeca-cmd list-dd --verbose command. Returns information about all data domains registered with the Endeca Server, along with their characteristics.
    getDataDomain in the Manage Web Service, or the equivalent endeca-cmd get-dd name command. Returns information about a single data domain with the specified name.
    Note: The Bulk Load port and host are determined dynamically and allocated by the Endeca Server cluster, for each data domain. To obtain information about the Bulk Load host and port, use the allocateBulkLoadPortname operation of the Manage Web Service, or endeca-cmd allocate-bulk-load-port <data-domain> [global-options].

Example

Here is an example of the response from the listDataDomains operation. In this example, two data domains are listed, test1 and test2: 
<ns3:listDataDomainsResponse
    xmlns:ns2="http://www.endeca.com/endeca-server/types/2/0"
    xmlns:ns3="http://www.endeca.com/endeca-server/manage/2/0">
   <ns3:dataDomainDetail>
    <ns2:name>test1</ns2:name>
    <ns2:allowOversubscribe>true</ns2:allowOversubscribe>
    <ns2:allowQueriesOnLeader>true</ns2:allowQueriesOnLeader>
    <ns2:numFollowers>0</ns2:numFollowers>
    <ns2:readOnly>false</ns2:readOnly>
    <ns2:enabled>true</ns2:enabled>
    <ns2:idle>false</ns2:idle>
    <ns2:numComputeThreads>4</ns2:numComputeThreads>
    <ns2:computeCacheSizeMB>0</ns2:computeCacheSizeMB>
    <ns2:startupTimeoutSeconds>600</ns2:startupTimeoutSeconds>
    <ns2:shutdownTimeoutSeconds>30</ns2:shutdownTimeoutSeconds>
    <ns2:sessionIdType>header</ns2:sessionIdType>
    <ns2:sessionIdKey>X-Endeca-Session-ID</ns2:sessionIdKey>
    <ns2:autoIdle>false</ns2:autoIdle>
    <ns2:idleTimeoutMinutes>10</ns2:idleTimeoutMinutes>
   </ns3:dataDomainDetail>
   
   <ns3:dataDomainDetail>
    <ns2:name>test2</ns2:name>
    <ns2:allowOversubscribe>true</ns2:allowOversubscribe>
    <ns2:allowQueriesOnLeader>true</ns2:allowQueriesOnLeader>
    <ns2:numFollowers>0</ns2:numFollowers>
    <ns2:readOnly>false</ns2:readOnly>
    <ns2:enabled>true</ns2:enabled>
    <ns2:idle>false</ns2:idle>
    <ns2:numComputeThreads>2</ns2:numComputeThreads>
    <ns2:computeCacheSizeMB>0</ns2:computeCacheSizeMB>
    <ns2:startupTimeoutSeconds>600</ns2:startupTimeoutSeconds>
    <ns2:shutdownTimeoutSeconds>30</ns2:shutdownTimeoutSeconds>
    <ns2:sessionIdType>header</ns2:sessionIdType>
    <ns2:sessionIdKey>X-Endeca-Session-ID</ns2:sessionIdKey>
    <ns2:autoIdle>true</ns2:autoIdle>
    <ns2:idleTimeoutMinutes>1</ns2:idleTimeoutMinutes>
    </ns3:dataDomainDetail>
  </ns3:listDataDomainsResponse>