1. Packages
  2. Ns1 Provider
  3. API Docs
  4. getBillingUsage
NS1 v3.7.2 published on Wednesday, Oct 22, 2025 by Pulumi
pulumi/pulumi-ns1

ns1.getBillingUsage

Get Started
ns1 logo
NS1 v3.7.2 published on Wednesday, Oct 22, 2025 by Pulumi
pulumi/pulumi-ns1

    Using getBillingUsage

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getBillingUsage(args: GetBillingUsageArgs, opts?: InvokeOptions): Promise<GetBillingUsageResult>
function getBillingUsageOutput(args: GetBillingUsageOutputArgs, opts?: InvokeOptions): Output<GetBillingUsageResult>
    def get_billing_usage(from_: Optional[int] = None,
                      metric_type: Optional[str] = None,
                      to: Optional[int] = None,
                      opts: Optional[InvokeOptions] = None) -> GetBillingUsageResult
def get_billing_usage_output(from_: Optional[pulumi.Input[int]] = None,
                      metric_type: Optional[pulumi.Input[str]] = None,
                      to: Optional[pulumi.Input[int]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetBillingUsageResult]
    func GetBillingUsage(ctx *Context, args *GetBillingUsageArgs, opts ...InvokeOption) (*GetBillingUsageResult, error)
func GetBillingUsageOutput(ctx *Context, args *GetBillingUsageOutputArgs, opts ...InvokeOption) GetBillingUsageResultOutput

    > Note: This function is named GetBillingUsage in the Go SDK.

    public static class GetBillingUsage 
{
    public static Task<GetBillingUsageResult> InvokeAsync(GetBillingUsageArgs args, InvokeOptions? opts = null)
    public static Output<GetBillingUsageResult> Invoke(GetBillingUsageInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBillingUsageResult> getBillingUsage(GetBillingUsageArgs args, InvokeOptions options)
public static Output<GetBillingUsageResult> getBillingUsage(GetBillingUsageArgs args, InvokeOptions options)

    fn::invoke:
  function: ns1:index/getBillingUsage:getBillingUsage
  arguments:
    # arguments dictionary

    The following arguments are supported:

    MetricType string
    The type of billing metric to retrieve. Must be one of: queries, limits, decisions, filter-chains, monitors, records.
    From int
    The start timestamp for the data range in Unix epoch format.
    To int
    The end timestamp for the data range in Unix epoch format.
    MetricType string
    The type of billing metric to retrieve. Must be one of: queries, limits, decisions, filter-chains, monitors, records.
    From int
    The start timestamp for the data range in Unix epoch format.
    To int
    The end timestamp for the data range in Unix epoch format.
    metricType String
    The type of billing metric to retrieve. Must be one of: queries, limits, decisions, filter-chains, monitors, records.
    from Integer
    The start timestamp for the data range in Unix epoch format.
    to Integer
    The end timestamp for the data range in Unix epoch format.
    metricType string
    The type of billing metric to retrieve. Must be one of: queries, limits, decisions, filter-chains, monitors, records.
    from number
    The start timestamp for the data range in Unix epoch format.
    to number
    The end timestamp for the data range in Unix epoch format.
    metric_type str
    The type of billing metric to retrieve. Must be one of: queries, limits, decisions, filter-chains, monitors, records.
    from_ int
    The start timestamp for the data range in Unix epoch format.
    to int
    The end timestamp for the data range in Unix epoch format.
    metricType String
    The type of billing metric to retrieve. Must be one of: queries, limits, decisions, filter-chains, monitors, records.
    from Number
    The start timestamp for the data range in Unix epoch format.
    to Number
    The end timestamp for the data range in Unix epoch format.

    getBillingUsage Result

    The following output properties are available:

    ByNetworks List<GetBillingUsageByNetwork>
    (Computed) A list of network-specific query data containing:
    ChinaQueriesLimit int
    (Computed) The queries limit for the China network.
    CleanQueries int
    Clean queries for this day.
    DdosProtectionEnabled bool
    (Computed) Whether DDoS Protection is enabled.
    DdosQueries int
    DDoS queries for this day.
    DecisionsLimit int
    (Computed) The RUM decisions limit for this billing cycle.
    FilterChainsLimit int
    (Computed) The filter chains limit for this billing cycle.
    Id string
    The provider-assigned unique ID for this managed resource.
    IncludeDedicatedDnsNetworkInManagedDnsUsage bool
    (Computed) Whether dedicated DNS usage counts towards managed DNS usage.
    MetricType string
    MonitorsLimit int
    (Computed) The monitoring jobs limit for this billing cycle.
    NxdProtectionEnabled bool
    (Computed) Whether NXD Protection is enabled.
    NxdResponses int
    NXD responses for this day.
    QueriesLimit int
    (Computed) The queries limit for this billing cycle.
    RecordsLimit int
    (Computed) The records limit for this billing cycle.
    TotalUsage int
    (Computed) The total usage count for the metric. Available for decisions, filter-chains, monitors, and records metrics.
    From int
    To int
    ByNetworks []GetBillingUsageByNetwork
    (Computed) A list of network-specific query data containing:
    ChinaQueriesLimit int
    (Computed) The queries limit for the China network.
    CleanQueries int
    Clean queries for this day.
    DdosProtectionEnabled bool
    (Computed) Whether DDoS Protection is enabled.
    DdosQueries int
    DDoS queries for this day.
    DecisionsLimit int
    (Computed) The RUM decisions limit for this billing cycle.
    FilterChainsLimit int
    (Computed) The filter chains limit for this billing cycle.
    Id string
    The provider-assigned unique ID for this managed resource.
    IncludeDedicatedDnsNetworkInManagedDnsUsage bool
    (Computed) Whether dedicated DNS usage counts towards managed DNS usage.
    MetricType string
    MonitorsLimit int
    (Computed) The monitoring jobs limit for this billing cycle.
    NxdProtectionEnabled bool
    (Computed) Whether NXD Protection is enabled.
    NxdResponses int
    NXD responses for this day.
    QueriesLimit int
    (Computed) The queries limit for this billing cycle.
    RecordsLimit int
    (Computed) The records limit for this billing cycle.
    TotalUsage int
    (Computed) The total usage count for the metric. Available for decisions, filter-chains, monitors, and records metrics.
    From int
    To int
    byNetworks List<GetBillingUsageByNetwork>
    (Computed) A list of network-specific query data containing:
    chinaQueriesLimit Integer
    (Computed) The queries limit for the China network.
    cleanQueries Integer
    Clean queries for this day.
    ddosProtectionEnabled Boolean
    (Computed) Whether DDoS Protection is enabled.
    ddosQueries Integer
    DDoS queries for this day.
    decisionsLimit Integer
    (Computed) The RUM decisions limit for this billing cycle.
    filterChainsLimit Integer
    (Computed) The filter chains limit for this billing cycle.
    id String
    The provider-assigned unique ID for this managed resource.
    includeDedicatedDnsNetworkInManagedDnsUsage Boolean
    (Computed) Whether dedicated DNS usage counts towards managed DNS usage.
    metricType String
    monitorsLimit Integer
    (Computed) The monitoring jobs limit for this billing cycle.
    nxdProtectionEnabled Boolean
    (Computed) Whether NXD Protection is enabled.
    nxdResponses Integer
    NXD responses for this day.
    queriesLimit Integer
    (Computed) The queries limit for this billing cycle.
    recordsLimit Integer
    (Computed) The records limit for this billing cycle.
    totalUsage Integer
    (Computed) The total usage count for the metric. Available for decisions, filter-chains, monitors, and records metrics.
    from Integer
    to Integer
    byNetworks GetBillingUsageByNetwork[]
    (Computed) A list of network-specific query data containing:
    chinaQueriesLimit number
    (Computed) The queries limit for the China network.
    cleanQueries number
    Clean queries for this day.
    ddosProtectionEnabled boolean
    (Computed) Whether DDoS Protection is enabled.
    ddosQueries number
    DDoS queries for this day.
    decisionsLimit number
    (Computed) The RUM decisions limit for this billing cycle.
    filterChainsLimit number
    (Computed) The filter chains limit for this billing cycle.
    id string
    The provider-assigned unique ID for this managed resource.
    includeDedicatedDnsNetworkInManagedDnsUsage boolean
    (Computed) Whether dedicated DNS usage counts towards managed DNS usage.
    metricType string
    monitorsLimit number
    (Computed) The monitoring jobs limit for this billing cycle.
    nxdProtectionEnabled boolean
    (Computed) Whether NXD Protection is enabled.
    nxdResponses number
    NXD responses for this day.
    queriesLimit number
    (Computed) The queries limit for this billing cycle.
    recordsLimit number
    (Computed) The records limit for this billing cycle.
    totalUsage number
    (Computed) The total usage count for the metric. Available for decisions, filter-chains, monitors, and records metrics.
    from number
    to number
    by_networks Sequence[GetBillingUsageByNetwork]
    (Computed) A list of network-specific query data containing:
    china_queries_limit int
    (Computed) The queries limit for the China network.
    clean_queries int
    Clean queries for this day.
    ddos_protection_enabled bool
    (Computed) Whether DDoS Protection is enabled.
    ddos_queries int
    DDoS queries for this day.
    decisions_limit int
    (Computed) The RUM decisions limit for this billing cycle.
    filter_chains_limit int
    (Computed) The filter chains limit for this billing cycle.
    id str
    The provider-assigned unique ID for this managed resource.
    include_dedicated_dns_network_in_managed_dns_usage bool
    (Computed) Whether dedicated DNS usage counts towards managed DNS usage.
    metric_type str
    monitors_limit int
    (Computed) The monitoring jobs limit for this billing cycle.
    nxd_protection_enabled bool
    (Computed) Whether NXD Protection is enabled.
    nxd_responses int
    NXD responses for this day.
    queries_limit int
    (Computed) The queries limit for this billing cycle.
    records_limit int
    (Computed) The records limit for this billing cycle.
    total_usage int
    (Computed) The total usage count for the metric. Available for decisions, filter-chains, monitors, and records metrics.
    from_ int
    to int
    byNetworks List<Property Map>
    (Computed) A list of network-specific query data containing:
    chinaQueriesLimit Number
    (Computed) The queries limit for the China network.
    cleanQueries Number
    Clean queries for this day.
    ddosProtectionEnabled Boolean
    (Computed) Whether DDoS Protection is enabled.
    ddosQueries Number
    DDoS queries for this day.
    decisionsLimit Number
    (Computed) The RUM decisions limit for this billing cycle.
    filterChainsLimit Number
    (Computed) The filter chains limit for this billing cycle.
    id String
    The provider-assigned unique ID for this managed resource.
    includeDedicatedDnsNetworkInManagedDnsUsage Boolean
    (Computed) Whether dedicated DNS usage counts towards managed DNS usage.
    metricType String
    monitorsLimit Number
    (Computed) The monitoring jobs limit for this billing cycle.
    nxdProtectionEnabled Boolean
    (Computed) Whether NXD Protection is enabled.
    nxdResponses Number
    NXD responses for this day.
    queriesLimit Number
    (Computed) The queries limit for this billing cycle.
    recordsLimit Number
    (Computed) The records limit for this billing cycle.
    totalUsage Number
    (Computed) The total usage count for the metric. Available for decisions, filter-chains, monitors, and records metrics.
    from Number
    to Number

    Supporting Types

    GetBillingUsageByNetwork

    BillableQueries int
    Total billable queries for this network.
    CleanQueries int
    Clean queries for this day.
    Dailies List<GetBillingUsageByNetworkDaily>
    Daily breakdown containing:
    DdosQueries int
    DDoS queries for this day.
    Network int
    The network ID.
    NxdResponses int
    NXD responses for this day.
    BillableQueries int
    Total billable queries for this network.
    CleanQueries int
    Clean queries for this day.
    Dailies []GetBillingUsageByNetworkDaily
    Daily breakdown containing:
    DdosQueries int
    DDoS queries for this day.
    Network int
    The network ID.
    NxdResponses int
    NXD responses for this day.
    billableQueries Integer
    Total billable queries for this network.
    cleanQueries Integer
    Clean queries for this day.
    dailies List<GetBillingUsageByNetworkDaily>
    Daily breakdown containing:
    ddosQueries Integer
    DDoS queries for this day.
    network Integer
    The network ID.
    nxdResponses Integer
    NXD responses for this day.
    billableQueries number
    Total billable queries for this network.
    cleanQueries number
    Clean queries for this day.
    dailies GetBillingUsageByNetworkDaily[]
    Daily breakdown containing:
    ddosQueries number
    DDoS queries for this day.
    network number
    The network ID.
    nxdResponses number
    NXD responses for this day.
    billable_queries int
    Total billable queries for this network.
    clean_queries int
    Clean queries for this day.
    dailies Sequence[GetBillingUsageByNetworkDaily]
    Daily breakdown containing:
    ddos_queries int
    DDoS queries for this day.
    network int
    The network ID.
    nxd_responses int
    NXD responses for this day.
    billableQueries Number
    Total billable queries for this network.
    cleanQueries Number
    Clean queries for this day.
    dailies List<Property Map>
    Daily breakdown containing:
    ddosQueries Number
    DDoS queries for this day.
    network Number
    The network ID.
    nxdResponses Number
    NXD responses for this day.

    GetBillingUsageByNetworkDaily

    CleanQueries int
    Clean queries for this day.
    DdosQueries int
    DDoS queries for this day.
    NxdResponses int
    NXD responses for this day.
    Timestamp int
    The timestamp for the day.
    CleanQueries int
    Clean queries for this day.
    DdosQueries int
    DDoS queries for this day.
    NxdResponses int
    NXD responses for this day.
    Timestamp int
    The timestamp for the day.
    cleanQueries Integer
    Clean queries for this day.
    ddosQueries Integer
    DDoS queries for this day.
    nxdResponses Integer
    NXD responses for this day.
    timestamp Integer
    The timestamp for the day.
    cleanQueries number
    Clean queries for this day.
    ddosQueries number
    DDoS queries for this day.
    nxdResponses number
    NXD responses for this day.
    timestamp number
    The timestamp for the day.
    clean_queries int
    Clean queries for this day.
    ddos_queries int
    DDoS queries for this day.
    nxd_responses int
    NXD responses for this day.
    timestamp int
    The timestamp for the day.
    cleanQueries Number
    Clean queries for this day.
    ddosQueries Number
    DDoS queries for this day.
    nxdResponses Number
    NXD responses for this day.
    timestamp Number
    The timestamp for the day.

    Package Details

    Repository
    NS1 pulumi/pulumi-ns1
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ns1 Terraform Provider.
    ns1 logo
    NS1 v3.7.2 published on Wednesday, Oct 22, 2025 by Pulumi
    pulumi/pulumi-ns1
      Meet Neo: Your AI Platform Teammate