GetNisNetworkMetrics

Parameter

Type

Required

Description

RegionNo

string

Yes

The region where the network resource resides.

ResourceType

string

Yes

The type of the network resource. Set the value to NAT, which indicates the monitoring trend data of source network address translation (SNAT) IP addresses of NAT gateways are queried.

MetricName

string

Yes

The metric whose trend data you want to query. Valid values:

• bps: bits per second

• pps: packets per second

• ActiveSessionCount: the number of concurrent sessions

• NewSessionPerSecond: the number of newly created sessions per second

Dimensions

object[]

Yes

The filter information.

-Name

string

Yes

The key of the filter condition. Valid values:

• Direction: the direction of the traffic of Alibaba Cloud resources. You must specify this parameter.

• InstanceId: the NAT gateway ID. You must specify this parameter.

• Ip: the IP address of the network interface card (NIC). You must specify this parameter.

-Value

string

Yes

The value of the filter condition.

Parameter

Type

Description

RequestId

string

The request ID.

Data

object

The trend data of cloud network metrics.

Metrics

array

The trend data of metrics.

-TimeStamp

long

The timestamp in milliseconds.

-Value

double

The value of the metric that is specified by the MetricName parameter.

Unit

String

The unit of the Value parameter.

Parameter

Type

Required

Description

RegionNo

string

Yes

The region where the network resource resides.

ResourceType

string

Yes

The type of the network resource. Valid values:

• AccessInternetIpV4: all Internet-facing IPv4 addresses of Alibaba Cloud

• AccessInternetIpV4Limited: all Internet-facing IPv4 addresses of Alibaba Cloud whose bandwidth is limited based on regions

• ElasticIP: the elastic IPv4 address

• PublicIPEcs: the static public IPv4 address of the Elastic Compute Service (ECS) instance

• PublicIPClb: the static public IPv4 address of the Classic Load Balancer (CLB) instance

• GA: Global Accelerator

MetricName

string

Yes

The metric whose trend data you want to query. Valid values:

• bps: bits per second

• pps: packets per second

• rtt: the round-trip time (RTT) when connections are established over Transmission Control Protocol (TCP)

• RetransmitRate: the retransmission rate

Dimensions

object[]

Yes

The filter information.

-Name

string

Yes

The key of the filter condition. Valid values:

• Direction: the direction of the traffic of Alibaba Cloud resources. You must specify this parameter.

• InstanceId: the Internet-facing instance ID, such as the ID of the elastic IP address (EIP), the ID of the CLB instance, the ID of the ECS instance, and the ID of the GA instance

• Product: the Internet-facing service, such as EIP, CLB, ECS, GA, and VPN Gateway

• VpcId: the ID of the virtual private cloud (VPC)

• SourceSubnet: the source CIDR block. Only 32-bit CIDR blocks are supported.

• DestinationSubnet: the destination CIDR block. Only 32-bit CIDR blocks are supported.

• SourcePort: the source port

• DestinationPort: the destination port

• Protocol: the protocol

• Country: the country where the client resides

• Province: the province where the client resides

• City: the city where the client resides

• Isp: the Internet service provider (ISP) to which the client belongs

• Asn: the autonomous system number (ASN) of the ISP to which the client belongs

-Value

string

No

The value of the filter condition.

Parameter

Type

Description

RequestId

string

The request ID.

Data

object

The trend data of cloud network metrics.

Metrics

array

The trend data of metrics.

-TimeStamp

long

The timestamp in milliseconds.

-Value

double

The value of the metric that is specified by the MetricName parameter.

Unit

String

The unit of the Value parameter.

Parameter

Type

Required

Description

RegionNo

string

Yes

The region where the transit router resides.

ResourceType

string

Yes

The type of the network resource. Set the value to TR, which indicates that the inter-region traffic trend data is queried.

MetricName

string

Yes

The metric whose trend data you want to query. Valid values:

• bps: bits per second

• pps: packets per second

Dimensions

object[]

Yes

The filter information.

-Name

string

Yes

The key of the filter condition. Valid values:

• InstanceId: the ID of the Cloud Enterprise Network (CEN) instance

• BandwidthPackageId: the ID of the CEN bandwidth plan

• DestinationRegionNo: the destination region

• SourceIp: the source IP address

• DestinationIp: the destination IP address

• SourcePort: the source port

• DestinationPort: the destination port

• Protocol: the protocol

-Value

string

Yes

The value of the filter condition.

Parameter

Type

Description

RequestId

string

The request ID.

Data

object

The trend data of cloud network metrics.

Metrics

array

The trend data of metrics.

-TimeStamp

long

The timestamp in milliseconds.

-Value

double

The value of the metric that is specified by the MetricName parameter.

Unit

String

The unit of the Value parameter.

Parameter

Type

Required

Description

RegionNo

string

Yes

The region where the virtual border router (VBR) resides.

ResourceType

string

Yes

The type of the network resource. Set the value to VBR, which indicates that the hybrid cloud traffic trend data is queried.

MetricName

string

Yes

The metric whose trend data you want to query. Valid values:

• bps: bits per second

• pps: packets per second

Dimensions

object[]

Yes

The filter information.

-Name

string

Yes

The key of the filter condition. Valid values:

• Direction: the direction of the traffic of Alibaba Cloud resources. You must specify this parameter.

• InstanceId: the ID of the CEN instance

• VbrId: the VBR ID

• AttachmentId: the ID of the network instance connection

• SourceIp: the source IP address

• DestinationIp: the destination IP address

• SourcePort: the source port

• DestinationPort: the destination port

• Protocol: the protocol

-Value

string

Yes

The value of the filter condition.

Parameter

Type

Description

RequestId

string

The request ID.

Data

object

The trend data of cloud network metrics.

Metrics

array

The trend data of metrics.

-TimeStamp

long

The timestamp in milliseconds.

-Value

double

The value of the metric that is specified by the MetricName parameter.

Unit

String

The unit of the Value parameter.

Parameter

Type

Required

Description

RegionNo

string

Yes

The region ID of the detection source.

ResourceType

string

Yes

The type of the network resource. Set the value to InternetProbing, which indicates that the monitoring trend data of Internet performance is queried.

MetricName

string

Yes

The metric whose trend data you want to query. Set the value to rtt, which means the detection RTT.

Dimensions

object[]

Yes

The filter information.

-Name

string

Yes

The key of the filter condition. Valid values:

• Country: the country where the detection destination resides

• Province: the province where the detection destination resides

• Isp: the ISP of the detection destination

-Value

string

Yes

The value of the filter condition.

Parameter

Type

Description

RequestId

string

The request ID.

Data

object

The trend data of cloud network metrics.

Metrics

array

The trend data of metrics.

-TimeStamp

long

The timestamp in milliseconds.

-Value

double

The value of the metric that is specified by the MetricName parameter.

Unit

String

The unit of the Value parameter.

Parameter

Type

Required

Description

RegionNo

string

Yes

The region ID.

ResourceType

string

Yes

The type of the network resource. Set the value to IntranetProbing, which indicates that the cross-zone performance monitoring trend data is queried.

MetricName

string

Yes

The metric whose trend data you want to query. Set the value to rtt, which means the detection RTT.

Dimensions

object[]

Yes

The filter information.

-Name

string

Yes

The key of the filter condition. Valid values:

• SourceZone: the source zone of the detection. You must specify this parameter.

• DestinationZone: the destination zone of the detection. You must specify this parameter.

-Value

string

Yes

The value of the filter condition.

Parameter

Type

Description

RequestId

string

The request ID.

Data

object

The trend data of cloud network metrics.

Metrics

array

The trend data of metrics.

-TimeStamp

long

The timestamp in milliseconds.

-Value

double

The value of the metric that is specified by the MetricName parameter.

Unit

String

The unit of the Value parameter.

Parameter

Type

Required

Description

RegionNo

string

Yes

The region ID.

ResourceType

string

Yes

The type of the network resource. Set the value to IntranetProbing, which indicates that the ranking data of inter-region internal network performance is queried.

Direction

string

Yes

The detection direction. Valid values:

• in: If you specify this value, the region specified by the RegionNo parameter is the destination region for detection.

• out: If you specify this value, the region specified by the RegionNo parameter is the source region for detection.

MetricName

string

Yes

The metric whose trend data you want to query. Set the value to rtt, which means the detection RTT.

Dimensions

object[]

No

The filter information.

-Name

string

No

The filter condition. Set the value to DestinationRegionNo. The DestinationRegionNo parameter is required and specifies the destination region of the detection.

-Value

string

No

The ID of the destination region.

Parameter

Type

Description

RequestId

string

The request ID.

Data

object

The trend data of cloud network metrics.

Metrics

array

The trend data of metrics.

-TimeStamp

long

The timestamp in milliseconds.

-Value

double

The value of the metric that is specified by the MetricName parameter.

Unit

String

The unit of the Value parameter.

Parameter

Type

Required

Description

RegionNo

string

Yes

The region ID.

ResourceType

string

Yes

The type of the network resource. Set the value to AccessInternetIpV4Limited, which indicates that the monitoring trend data of Internet-facing IPv4 addresses whose bandwidth is limited based on regions is queried.

MetricName

string

Yes

The metric whose trend data you want to query. Valid values:

• RatelimitDropPps: the rate at which packets are dropped due to throttling

• bps: bits per second

• pps: packets per second

Dimensions

object[]

Yes

The filter information.

-Name

string

Yes

The filter condition. Set the value to direction. It means that filtering is performed based on the direction of the traffic of Alibaba Cloud resources.

-Value

string

Yes

The value of the filter condition. Valid values:

• in: inbound traffic in the current region

• out: outbound traffic in the current region

Parameter

Type

Description

RequestId

string

The request ID.

Data

object

The trend data of cloud network metrics.

Metrics

array

The trend data of metrics.

-TimeStamp

long

The timestamp in milliseconds.

-Value

double

The value of the metric that is specified by the MetricName parameter.

Unit

String

The unit of the Value parameter.