NotificationUsage
Last updated
Last updated
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 Methods:
| Method | Request | Response |
|---|---|---|
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
{{< tabs " list " >}}
{{< tab "Request Example" >}}
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.
{{< highlight json >}} { "query": {} } {{< /highlight >}} {{< /tab >}}
{{< tab "Response Example" >}}
results (NotificationUsageInfo) Repeated Required
List of queried Notification Usage.
total_count (int32) Required
Total counts of queried Notification Usage.
{{< highlight json >}} { "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 } {{< /highlight >}} {{< /tab >}}
{{< /tabs >}}
POST /notification/v1/notification-usage/stat
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
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 (StatisticsQuery) Required
Statistics Query format provided by SpaceONE. Please check the link for more information.
domain_id (string) Required
The ID of domain.
results (NotificationUsageInfo) Repeated Required
List of queried Notification Usage.
total_count (int32) Required
Total counts of queried Notification Usage.