db2GetHealthNotificationList API - Get the list of contacts to whom health alert notifications can be sent

Returns the list of contacts or contact groups, or both, that are notified about the health of an instance. A contact list consists of email addresses or pager internet addresses of individuals who are to be notified when non-normal health conditions are present for an instance or any of its database objects.
Important: This API is deprecated for Db2® version 11.5.8 and will be discontinued in a future release or modification pack.

Authorization

None

Required connection

Instance. If there is no instance attachment, a default instance attachment is created.

API include file

db2ApiDf.h

API and data structure syntax

SQL_API_RC SQL_API_FN
  db2GetHealthNotificationList (
   db2Uint32 versionNumber,
   void * pParmStruct,
   struct sqlca * pSqlca);

typedef SQL_STRUCTURE db2GetHealthNotificationListData
{
   db2Uint32 ioNumContacts;
   struct db2ContactTypeData *poContacts;
} db2GetHealthNotificationListData;

typedef SQL_STRUCTURE db2ContactTypeData
{
   db2Uint32 contactType;
   char *pName;
} db2ContactTypeData;

db2GetHealthNotificationList API parameters

versionNumber
Input. Specifies the version and release level of the structure passed as the second parameter pParmStruct.
pParmStruct
Input. A pointer to the db2GetHealthNotificationListData structure.
pSqlca
Output. A pointer to the sqlca structure.

db2GetHealthNotificationListData data structure parameters

ioNumContacts
The number of contacts. If the API was called with a NULL poContact, then ioNumContacts will be set to the number of contacts the user should allocate to perform a successful call.
poContacts
Output. A pointer to the db2ContactTypeData structure.

db2ContactTypeData data structure parameters

contactType
Specifies the type of contact. Valid values are:
  • DB2CONTACT_SINGLE
  • DB2CONTACT_GROUP
pName
The contact group name, or the contact name if contactType is set to DB2CONTACT_SINGLE.