Skip to content

Commit 7135fc5

Browse files
committed
feedback
1 parent 84a595b commit 7135fc5

File tree

2 files changed

+29
-14
lines changed

2 files changed

+29
-14
lines changed

content/vault/v1.18.x/content/api-docs/system/internal-counters.mdx

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -366,9 +366,15 @@ is unknown.
366366

367367
### Parameters
368368

369-
- `start_time` `(string, optional)` - An RFC3339 timestamp or Unix epoch time. Specifies the start of the
370-
period for which client counts will be reported. If no start time is specified, the billing start date will be used.
371-
The [billing start date](/vault/docs/concepts/billing-start-date) automatically rolls over to the latest billing year at the end of the last cycle.
369+
- `start_time` `(string, optional)` - An RFC3339 timestamp or Unix epoch time.
370+
Specifies the start of the period for which client counts will be reported.
371+
Vault uses the [billing start date](/vault/docs/concepts/billing-start-date)
372+
by default, which automatically rolls over to the latest billing year at the
373+
end of the last cycle. Vault Community **requires** `start_time`, but Vault
374+
Enterprise uses the billing start date as defined by the cluster license by
375+
default. Vault Community does not have a billing start time, so ommitting
376+
`start_time` can lead to undefined behavior. We recommend setting an explicit
377+
start time to ensure reliable behavior in all Vault versions.
372378

373379

374380
- `end_time` `(string, optional)` - An RFC3339 timestamp or Unix epoch time. Specifies the end of the period

content/vault/v1.19.x/content/api-docs/system/internal-counters.mdx

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -366,18 +366,27 @@ is unknown.
366366

367367
### Parameters
368368

369-
- `start_time` `(string, optional)` - An RFC3339 timestamp or Unix epoch time. Specifies the start of the
370-
period for which client counts will be reported. If no start time is specified, the billing start date will be used.
371-
The [billing start date](/vault/docs/concepts/billing-start-date) automatically rolls over to the latest billing year at the end of the last cycle.
372-
- `end_time` `(string, optional)` - An RFC3339 timestamp or Unix epoch time. Specifies the end of the period
373-
for which client counts will be reported. If no end time is specified, the end of the current month will be used.
374-
- `limit_namespaces` `(int, optional)` - Controls the total number of by_namespace data returned. This can
375-
be used to return the client counts for the specified number of namespaces having highest activity.
376-
If no `limit_namespaces` parameter is specified, client counts for all namespaces in specified usage period is returned.
377-
- `current_billing_period` `(bool, optional)` - **DEPRECATED** Uses the builtin billing start
378-
timestamp as `start_time` and the current time as the `end_time`, returning a
369+
- `start_time` `(string, optional)` - An RFC3339 timestamp or Unix epoch time.
370+
Specifies the start of the period for which client counts will be reported.
371+
Vault uses the [billing start date](/vault/docs/concepts/billing-start-date)
372+
by default, which automatically rolls over to the latest billing year at the
373+
end of the last cycle. Vault Community **requires** `start_time`, but Vault
374+
Enterprise uses the billing start date as defined by the cluster license by
375+
default. Vault Community does not have a billing start time, so ommitting
376+
`start_time` can lead to undefined behavior. We recommend setting an explicit
377+
start time to ensure reliable behavior in all Vault versions.
378+
- `end_time` `(string, optional)` - An RFC3339 timestamp or Unix epoch time.
379+
Specifies the end of the period for which client counts will be reported. If
380+
no end time is specified, the end of the current month will be used.
381+
- `limit_namespaces` `(int, optional)` - Controls the total number of by_namespace
382+
data returned. This can be used to return the client counts for the specified number
383+
of namespaces having highest activity. If no `limit_namespaces` parameter is
384+
specified, client counts for all namespaces in specified usage period is returned.
385+
- `current_billing_period` `(bool, optional)` - **DEPRECATED** Uses the builtin billing
386+
start timestamp as `start_time` and the current time as the `end_time`, returning a
379387
response with the current billing period information without having to
380-
explicitly provide a start and end time. This parameter is deprecated, as this option is now the default, so no parameter is needed to specify.
388+
explicitly provide a start and end time. This parameter is deprecated, as this option
389+
is now the default, so no parameter is needed to specify.
381390

382391

383392
### Sample request

0 commit comments

Comments
 (0)