1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. getGaapListenerStatistics
tencentcloud 1.81.182 published on Monday, Apr 14, 2025 by tencentcloudstack

tencentcloud.getGaapListenerStatistics

Explore with Pulumi AI

Use this data source to query detailed information of gaap listener statistics

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";

const listenerStatistics = tencentcloud.getGaapListenerStatistics({
    endTime: "2023-10-19 23:59:59",
    granularity: 300,
    listenerId: "listener-xxxxxx",
    metricNames: [
        "InBandwidth",
        "OutBandwidth",
        "InPackets",
        "OutPackets",
        "Concurrent",
    ],
    startTime: "2023-10-19 00:00:00",
});
Copy
import pulumi
import pulumi_tencentcloud as tencentcloud

listener_statistics = tencentcloud.get_gaap_listener_statistics(end_time="2023-10-19 23:59:59",
    granularity=300,
    listener_id="listener-xxxxxx",
    metric_names=[
        "InBandwidth",
        "OutBandwidth",
        "InPackets",
        "OutPackets",
        "Concurrent",
    ],
    start_time="2023-10-19 00:00:00")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.GetGaapListenerStatistics(ctx, &tencentcloud.GetGaapListenerStatisticsArgs{
			EndTime:     "2023-10-19 23:59:59",
			Granularity: 300,
			ListenerId:  "listener-xxxxxx",
			MetricNames: []string{
				"InBandwidth",
				"OutBandwidth",
				"InPackets",
				"OutPackets",
				"Concurrent",
			},
			StartTime: "2023-10-19 00:00:00",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

return await Deployment.RunAsync(() => 
{
    var listenerStatistics = Tencentcloud.GetGaapListenerStatistics.Invoke(new()
    {
        EndTime = "2023-10-19 23:59:59",
        Granularity = 300,
        ListenerId = "listener-xxxxxx",
        MetricNames = new[]
        {
            "InBandwidth",
            "OutBandwidth",
            "InPackets",
            "OutPackets",
            "Concurrent",
        },
        StartTime = "2023-10-19 00:00:00",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetGaapListenerStatisticsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var listenerStatistics = TencentcloudFunctions.getGaapListenerStatistics(GetGaapListenerStatisticsArgs.builder()
            .endTime("2023-10-19 23:59:59")
            .granularity(300)
            .listenerId("listener-xxxxxx")
            .metricNames(            
                "InBandwidth",
                "OutBandwidth",
                "InPackets",
                "OutPackets",
                "Concurrent")
            .startTime("2023-10-19 00:00:00")
            .build());

    }
}
Copy
variables:
  listenerStatistics:
    fn::invoke:
      function: tencentcloud:getGaapListenerStatistics
      arguments:
        endTime: 2023-10-19 23:59:59
        granularity: 300
        listenerId: listener-xxxxxx
        metricNames:
          - InBandwidth
          - OutBandwidth
          - InPackets
          - OutPackets
          - Concurrent
        startTime: 2023-10-19 00:00:00
Copy

Using getGaapListenerStatistics

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 getGaapListenerStatistics(args: GetGaapListenerStatisticsArgs, opts?: InvokeOptions): Promise<GetGaapListenerStatisticsResult>
function getGaapListenerStatisticsOutput(args: GetGaapListenerStatisticsOutputArgs, opts?: InvokeOptions): Output<GetGaapListenerStatisticsResult>
Copy
def get_gaap_listener_statistics(end_time: Optional[str] = None,
                                 granularity: Optional[float] = None,
                                 id: Optional[str] = None,
                                 listener_id: Optional[str] = None,
                                 metric_names: Optional[Sequence[str]] = None,
                                 result_output_file: Optional[str] = None,
                                 start_time: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetGaapListenerStatisticsResult
def get_gaap_listener_statistics_output(end_time: Optional[pulumi.Input[str]] = None,
                                 granularity: Optional[pulumi.Input[float]] = None,
                                 id: Optional[pulumi.Input[str]] = None,
                                 listener_id: Optional[pulumi.Input[str]] = None,
                                 metric_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                 result_output_file: Optional[pulumi.Input[str]] = None,
                                 start_time: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetGaapListenerStatisticsResult]
Copy
func GetGaapListenerStatistics(ctx *Context, args *GetGaapListenerStatisticsArgs, opts ...InvokeOption) (*GetGaapListenerStatisticsResult, error)
func GetGaapListenerStatisticsOutput(ctx *Context, args *GetGaapListenerStatisticsOutputArgs, opts ...InvokeOption) GetGaapListenerStatisticsResultOutput
Copy

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

public static class GetGaapListenerStatistics 
{
    public static Task<GetGaapListenerStatisticsResult> InvokeAsync(GetGaapListenerStatisticsArgs args, InvokeOptions? opts = null)
    public static Output<GetGaapListenerStatisticsResult> Invoke(GetGaapListenerStatisticsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGaapListenerStatisticsResult> getGaapListenerStatistics(GetGaapListenerStatisticsArgs args, InvokeOptions options)
public static Output<GetGaapListenerStatisticsResult> getGaapListenerStatistics(GetGaapListenerStatisticsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: tencentcloud:index/getGaapListenerStatistics:getGaapListenerStatistics
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

EndTime This property is required. string
End Time.
Granularity This property is required. double
Monitoring granularity, currently supporting 300 3600 86400, in seconds.The query time range does not exceed 1 day and supports a minimum granularity of 300 seconds;The query interval should not exceed 7 days and support a minimum granularity of 3600 seconds;The query interval exceeds 7 days and supports a minimum granularity of 86400 seconds.
ListenerId This property is required. string
Listener Id.
MetricNames This property is required. List<string>
List of statistical indicator names. Supporting: InBandwidth, OutBandwidth, Concurrent, InPackets, OutPackets.
StartTime This property is required. string
Start Time.
Id string
ResultOutputFile string
Used to save results.
EndTime This property is required. string
End Time.
Granularity This property is required. float64
Monitoring granularity, currently supporting 300 3600 86400, in seconds.The query time range does not exceed 1 day and supports a minimum granularity of 300 seconds;The query interval should not exceed 7 days and support a minimum granularity of 3600 seconds;The query interval exceeds 7 days and supports a minimum granularity of 86400 seconds.
ListenerId This property is required. string
Listener Id.
MetricNames This property is required. []string
List of statistical indicator names. Supporting: InBandwidth, OutBandwidth, Concurrent, InPackets, OutPackets.
StartTime This property is required. string
Start Time.
Id string
ResultOutputFile string
Used to save results.
endTime This property is required. String
End Time.
granularity This property is required. Double
Monitoring granularity, currently supporting 300 3600 86400, in seconds.The query time range does not exceed 1 day and supports a minimum granularity of 300 seconds;The query interval should not exceed 7 days and support a minimum granularity of 3600 seconds;The query interval exceeds 7 days and supports a minimum granularity of 86400 seconds.
listenerId This property is required. String
Listener Id.
metricNames This property is required. List<String>
List of statistical indicator names. Supporting: InBandwidth, OutBandwidth, Concurrent, InPackets, OutPackets.
startTime This property is required. String
Start Time.
id String
resultOutputFile String
Used to save results.
endTime This property is required. string
End Time.
granularity This property is required. number
Monitoring granularity, currently supporting 300 3600 86400, in seconds.The query time range does not exceed 1 day and supports a minimum granularity of 300 seconds;The query interval should not exceed 7 days and support a minimum granularity of 3600 seconds;The query interval exceeds 7 days and supports a minimum granularity of 86400 seconds.
listenerId This property is required. string
Listener Id.
metricNames This property is required. string[]
List of statistical indicator names. Supporting: InBandwidth, OutBandwidth, Concurrent, InPackets, OutPackets.
startTime This property is required. string
Start Time.
id string
resultOutputFile string
Used to save results.
end_time This property is required. str
End Time.
granularity This property is required. float
Monitoring granularity, currently supporting 300 3600 86400, in seconds.The query time range does not exceed 1 day and supports a minimum granularity of 300 seconds;The query interval should not exceed 7 days and support a minimum granularity of 3600 seconds;The query interval exceeds 7 days and supports a minimum granularity of 86400 seconds.
listener_id This property is required. str
Listener Id.
metric_names This property is required. Sequence[str]
List of statistical indicator names. Supporting: InBandwidth, OutBandwidth, Concurrent, InPackets, OutPackets.
start_time This property is required. str
Start Time.
id str
result_output_file str
Used to save results.
endTime This property is required. String
End Time.
granularity This property is required. Number
Monitoring granularity, currently supporting 300 3600 86400, in seconds.The query time range does not exceed 1 day and supports a minimum granularity of 300 seconds;The query interval should not exceed 7 days and support a minimum granularity of 3600 seconds;The query interval exceeds 7 days and supports a minimum granularity of 86400 seconds.
listenerId This property is required. String
Listener Id.
metricNames This property is required. List<String>
List of statistical indicator names. Supporting: InBandwidth, OutBandwidth, Concurrent, InPackets, OutPackets.
startTime This property is required. String
Start Time.
id String
resultOutputFile String
Used to save results.

getGaapListenerStatistics Result

The following output properties are available:

endTime String
granularity Number
id String
listenerId String
metricNames List<String>
startTime String
statisticsDatas List<Property Map>
Channel Group Statistics.
resultOutputFile String

Supporting Types

GetGaapListenerStatisticsStatisticsData

MetricDatas This property is required. List<GetGaapListenerStatisticsStatisticsDataMetricData>
Metric Data.
MetricName This property is required. string
Metric Name.
MetricDatas This property is required. []GetGaapListenerStatisticsStatisticsDataMetricData
Metric Data.
MetricName This property is required. string
Metric Name.
metricDatas This property is required. List<GetGaapListenerStatisticsStatisticsDataMetricData>
Metric Data.
metricName This property is required. String
Metric Name.
metricDatas This property is required. GetGaapListenerStatisticsStatisticsDataMetricData[]
Metric Data.
metricName This property is required. string
Metric Name.
metric_datas This property is required. Sequence[GetGaapListenerStatisticsStatisticsDataMetricData]
Metric Data.
metric_name This property is required. str
Metric Name.
metricDatas This property is required. List<Property Map>
Metric Data.
metricName This property is required. String
Metric Name.

GetGaapListenerStatisticsStatisticsDataMetricData

Data This property is required. double
Statistical data valueNote: This field may return null, indicating that a valid value cannot be obtained.
Time This property is required. double
Time.
Data This property is required. float64
Statistical data valueNote: This field may return null, indicating that a valid value cannot be obtained.
Time This property is required. float64
Time.
data This property is required. Double
Statistical data valueNote: This field may return null, indicating that a valid value cannot be obtained.
time This property is required. Double
Time.
data This property is required. number
Statistical data valueNote: This field may return null, indicating that a valid value cannot be obtained.
time This property is required. number
Time.
data This property is required. float
Statistical data valueNote: This field may return null, indicating that a valid value cannot be obtained.
time This property is required. float
Time.
data This property is required. Number
Statistical data valueNote: This field may return null, indicating that a valid value cannot be obtained.
time This property is required. Number
Time.

Package Details

Repository
tencentcloud tencentcloudstack/terraform-provider-tencentcloud
License
Notes
This Pulumi package is based on the tencentcloud Terraform Provider.