Call the GetNetworkTrafficMetrics API to get network traffic metric trends. ## Debug [去调试](https://api.volcengine.com/api-explorer/?action=GetNetworkTrafficMetrics&groupName=%E6%B5%81%E9%87%8F%E5%88%86%E6%9E%90&serviceCode=na&version=2020-04-01) ## Request parameters The following only details request parameters specific to this API and key common parameters. More information can be found in [Common parameters](https://www.volcengine.com/docs/6369/67268). **Action ** string 必选 `Example: GetNetworkTrafficMetrics` Action to execute. Set the value to GetNetworkTrafficMetrics. **Version ** string 必选 `Example: 2020-04-01` The API version. Value: 2020\-04\-01. **Region ** string 必选 `Example: cn-beijing` Region of the resource. **EndTime ** long `optional` `Example: 1764042944000` End timestamp, in milliseconds. **Filters ** object[] `optional` `Example: --` Filter condition. **Name ** string 必选 `Example: SourceIp` Filter condition names, with values as follows: * Internet Traffic Analysis: * InstanceId: EIP instance ID. * BandwidthPackageId: The instance ID of the bandwidth package. * SourceIp: Source IP. * DestinationIp: Destination IP. * SourcePort: Source port. * DestinationPort: Destination port. * Protocol: Protocol (supports TCP, UDP, ICMP, ICMPv6). * Country: Country of the client. * City: City of the client. * ISP: Line operator of the client. * Cross Region Traffic Analysis: * InstanceId: CEN or TR instance ID. * SourceIp: Source IP. * DestinationIp: Destination IP. * PeerRegion: Peer Region. * Hybird Cloud Traffic Analysis: * InstanceId: Direct Connect Gateway instance ID. * SourceIp: Source IP. * DestinationIp: Destination IP. > * The **SourcePort**, **DestinationPort**, and **Protocol** filter conditions can be specified only when the **GroupBy** parameter is **Tuple5**, **Protocol**, **SourcePort**, or **DestinationPort**. > * Duplicate filter conditions are not allowed. **Value ** string 必选 `Example: 101.XX.XX.223` Filter condition value. **BeginTime ** long `optional` `Example: 1764042943000` Start timestamp, in milliseconds Default time span is 5 minutes; maximum time span is 24 hours **Direction ** string 必选 `Example: out` Network traffic direction. Valid values: * in: Inbound. * out: Outbound. > When ResourceType is CEN or TR, fill in "out". **MetricName ** string 必选 `Example: bps` Metric name. Valid values: * bps: Bits per second. * pps: Packets per second. **ResourceType ** string 必选 `Example: EIP` The resource type. Valid values: * EIP: EIP traffic. * CEN: Cloud Enterprise Network traffic. * TR: Transit Router traffic. * DCG: Direct Connect Gateway traffic. ## Response parameters Only the response parameters specific to this API are listed below. More information, see [Response structure](https://www.volcengine.com/docs/6369/80336). **Data ** object `Example: --` Metric trend data. **Metrics ** object[] `Example: --` Set of metric trend data. **Time ** string `Example: 2025-12-23 18:27:00` Data timestamp. **Value ** float `Example: 130.6666717529297` Metric value. ## Request example ```text POST /?Action=GetNetworkTrafficMetrics&Version=2020-04-01 { "Region": "cn-beijing", "EndTime": 1764042944000, "Filters": [ { "Name": "InstanceId", "Value": "eip-12345678" } ], "BeginTime": 1764042943000, "Direction": "out", "MetricName": "bps", "ResourceType": "EIP" } ``` ## Response examples ```json { "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "GetNetworkTrafficMetrics", "Version": "2020-04-01", "Service": "na", "Region": "cn-beijing" }, "Result": { "Data": { "Metrics": [ { "Time": "2025-12-23 18:27:00", "Value": 130.6666717529297 } ] } } } ``` ## Error codes The following table lists the error codes related to the business logic for this API. For details, see [Common error codes](https://www.volcengine.com/docs/6369/68677). |Status code |Error codes |Error message |Notes | |---|---|---|---| |400 |DataUnmarshalFailed |Data unmarshal failed. |Failed to parse the request. | |400 |DuplicateFilters |Filters with same Name are not allowed. |Filter conditions cannot be duplicated. | |400 |InvalidDirection |The specified Direction is invalid. |The specified traffic direction is invalid. | |400 |InvalidIPInFilters |There exists invalid IP address in Filters. |Filter condition contains invalid IP address. | |400 |InvalidMetricName |The specified MetricName is invalid. |The specified metric name is invalid. | |400 |InvalidPortInFilters |There exists invalid port in Filters. |Filter condition contains invalid ports. | |400 |InvalidQueryDuration |query duration invalid duration must less than 24H five tuple duration must less than 5Min. |The query time range is invalid. The query range must be less than 24 hours; for quintuple queries, the range must be less than 5 minutes. | |400 |InvalidRegion |The specified Region is invalid. |The specified region is invalid. | |400 |InvalidResourceType |The specified ResourceType is invalid. |The specified resource type is invalid. | |400 |MissingParameter |The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request, for example, the ''. |This request does not contain the required parameter. Ensure the request includes all required parameters, such as . | |400 |RegionNotOpen |Traffic analysis is not enabled in the current region. Please enable traffic analysis first. |Traffic analysis is not enabled in the current region. Please enable traffic analysis first. | |400 |RegionNotSupported |Current region is not support. |The current region is not yet supported. Supported regions: %s | |401 |ServiceRoleUnauthorized |service role is unauthorized |Role not authorized. Please visit the IAM console to grant the required permissions first | |500 |InternalError |An internal error has occurred. |An internal error occurred. |

Network Advisor