NotificationUsage

NotificationUsage #

A NotificationUsage is a resource indicating daily Protocol usage. The limit set by the resource Quota is applied based on the NotificationUsage.

Package : spaceone.api.notification.v1



NotificationUsage #

NotificationUsage Methods:

MethodRequestResponse
listNotificationUsageQueryNotificationUsagesInfo
statNotificationUsageStatQueryStruct

list #

Gets a list of all NotificationUsages. You can use a query to get a filtered list of Notification Usages.

POST /notification/v1/notification-usage/list

NotificationUsageQuery

  • domain_id (string) Required

    The ID of domain.

  • query (Query)

    Query format provided by SpaceONE. Please check the link for more information.

  • protocol_id (string)

    The ID of Protocol.

{
   "query": {}
}

NotificationUsagesInfo

  • results (NotificationUsageInfo) Repeated Required

    List of queried Notification Usage.

  • total_count (int32) Required

    Total counts of queried Notification Usage.

{
   "results": [
       {
           "protocol_id": "protocol-123456789012",
           "usage_date": "08",
           "usage_month": "2022-05",
           "count": 2,
           "domain_id": "domain-123456789012"
       },
       {
           "protocol_id": "protocol-123456789012",
           "usage_date": "18",
           "usage_month": "2022-05",
           "count": 7,
           "domain_id": "domain-123456789012"
       }
   ],
   "total_count": 2
}

stat #

POST /notification/v1/notification-usage/stat



Message #

NotificationUsageInfo #

  • protocol_id (string) Required

    The ID of Protocol.

  • usage_date (string) Required

    Usage Date.

  • usage_month (string) Required

    Usage Month.

  • count (int32) Required

    Usage count using actual notifications.

  • fail_count (int32) Required

    Fail count when dispatching notifications.

  • domain_id (string) Required

    The ID of domain


NotificationUsageQuery #

  • domain_id (string) Required

    The ID of domain.

  • query (Query)

    Query format provided by SpaceONE. Please check the link for more information.

  • protocol_id (string)

    The ID of Protocol.


NotificationUsageStatQuery #

  • query (StatisticsQuery) Required

    Statistics Query format provided by SpaceONE. Please check the link for more information.

  • domain_id (string) Required

    The ID of domain.


NotificationUsagesInfo #

  • results (NotificationUsageInfo) Repeated Required

    List of queried Notification Usage.

  • total_count (int32) Required

    Total counts of queried Notification Usage.


Calendar May 17, 2024
Edit Edit this page