Listing data domain profiles

Non-default data domain profiles are created by an administrator in charge of the Endeca Server cluster. Before you create a data domain, you need to know the names and characteristics of previously defined domain profiles. This information is returned with the operations from the Manage Web Service and Cluster Web Service, or with endeca-cmd.

Note: Existing data domain profiles do not necessarily reflect the characteristics of existing data domains that used these profiles. The data domains could have been changed after they were created.

To obtain a list of one or more data domain profiles:

Use one of these options either from endeca-cmd or the Cluster or Manage Web Services:

Option	Description
`endeca-cmd get-dd-profile name` or `getDataDomainProfile` from the Manage Web Service	Lists the details of a single specified data domain profile.
`endeca-cmd list-dd-profiles` or `listDataDomainProfiles` from the Manage Web Service	Lists all defined data domain profiles.

Note: The Cluster Web Service also has the same set of operations, listDataDomainProfiles and getDataDomainProfiles; both return the same information as the equivalent operations from the Manage Web Service. Each web service is intended for different users — administrators managing data domains use the Manage Web Service, while administrators managing the Endeca Server cluster use the Cluster Web Service. Having these operations in both interfaces allows each user to have a full list of features for managing either their data domains or Endeca Server clusters.

Here is an abbreviated example of a listDataDomainProfiles request to the Manage Web Service:

<ns1:listDataDomainProfiles 
xmlns:ns1="http://www.endeca.com/endeca-server/manage/1/0"/>

The request returns the set of data domain profiles configured in the Endeca Server cluster. For each data domain profile, it returns its name, description, and other characteristics, such as the number of follower nodes, the number of query processing threads, and the list of arguments that are sent to the Dgraph processes for this data domain profile.

A getDataDomainProfile request is similar, but requires you to specify the name of the data domain profile.

Here is an example of a response from endeca-cmd get-dd-profile MyTestProfile. It lists the details of the profile named MyTestProfile:

MyTestProfile
Description: test_profile_with_0_followers_readonly_false
AllowQueriesOnLeader: true
AllowOverSubscribe: true
NumFollowers: 0
NumComputeThreads: 2
read-only: false
computeCacheSizeMB: 0
startupTimeoutSeconds: 60
shutdownTimeoutSeconds: 60
session-id-type: header
session-id-key: X-Endeca-Session-ID
args: []

When you use endeca-cmd list-dd-profiles, by default it returns only the names of the data domain profiles. If you use the --verbose parameter, the command also returns information for each of the configured data domain profiles.