DocsICP FilingConsole
官方文档
首页

DescribeInternetTimeTop

更新时间：
复制 MD 格式
产品详情
我的收藏

This operation queries the Top-N internet traffic over time.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-cloudfirewall:DescribeInternetTimeTop

get

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
SourceIp

string

No

The source IP address.

60.179.179.XXX
Lang

string

No

The language of the response.

Valid values:

  • en :

    English

  • zh :

    Chinese

zh
Lang

string

No

The language of the response.

Valid values:

  • en :

    English

  • zh :

    Chinese

zh
Direction

string

Yes

The direction of the traffic.

Valid values:

  • in :

    inbound

  • out :

    outbound

out
SourceCode

string

Yes

The identifier for the trace source.

yundun
Sort

string

No

The metric by which to sort the results.

Valid values:

  • out_pps :

    out_pps

  • in_bps :

    in_bps

  • out_bps :

    out_bps

  • in_pps :

    in_pps

in_bps
TrafficTime

string

No

The traffic timestamp to query, specified as a Unix timestamp in seconds.

1745222880
Limit

string

No

The maximum number of entries to return. The value must be between 1 and 50. Default value: 50.

5
SrcIP

string

No

The source IP address.

8.153.18.XX
NatIP

string

No

The NAT public IP address. If omitted, traffic data for all assets is returned.

47.97.66.XXX
Order

string

No

The sort order.

Valid values:

  • asc :

    ascending

  • desc :

    descending

desc
StartTime

string

No

The start of the query time range, specified as a Unix timestamp in seconds.

1749434787
EndTime

string

No

The end of the query time range, specified as a Unix timestamp in seconds.

1733796528
TrafficType

string

No

The traffic type.

EIP_TRAFFIC
IPType

string

No

The network type of the IP address.

Valid values:

  • Private :

    Virtual Private Cloud

  • Public :

    public network

Public
Interval

integer

No

The time interval in seconds.

60

Response elements

Element

Type

Description

Example

object

TrafficTime

integer

The timestamp of the traffic data. Unit: seconds.

1734399660
RequestId

string

The request ID.

7F2D5C04-731F-50B0-ADE1-01637B3C****
DataCount

integer

The number of entries returned.

19
DataList

array<object>

The list of data entries.

object

The data entry.

ResourceInstanceName

string

The name of the asset.

test
InBps

integer

The inbound bandwidth. Unit: bit/s.

187
ResourceInstanceId

string

The ID of the asset instance.

lb-bp14ue2rgktunncq****
NewConn

integer

The number of new connections.

27
RegionNo

string

The region ID.

cn-shenzhen
OutPps

integer

The outbound packet forwarding rate. Unit: pps.

2
IP

string

The public IP address.

183.60.164.XXX
OutBps

integer

The outbound traffic. Unit: bit/s.

45
PrivateIP

string

The private IP address.

10.21.186.XXX
SessionCount

integer

The number of sessions.

27
ResourceType

string

The type of the public IP address.

Valid values:

  • EcsEIP :

    EcsEIP

  • EcsPublicIP :

    EcsPublicIP

  • NatPublicIP :

    NatPublicIP

  • NatEIP :

    NatEIP

EcsPublicIP
InPps

integer

The inbound packet forwarding rate. Unit: pps.

2
TotalPps

integer

The total number of packets.

88
TotalBps

integer

The total bandwidth. Unit: bit/s.

232
VpcId

string

The ID of the virtual private cloud (VPC) instance.

vpc-wz9o0uzfjuj81fx7m****
NatGatewayId

string

The ID of the NAT gateway.

ngw-wz98eedr5l5hkb8****e7
NatGatewayName

string

The name of the NAT gateway.

ngw-test
NatIP

string

The public IP address of the NAT gateway.

47.97.66.XXX

Examples

Success response

JSON format

{
  "TrafficTime": 1734399660,
  "RequestId": "7F2D5C04-731F-50B0-ADE1-01637B3C****",
  "DataCount": 19,
  "DataList": [
    {
      "ResourceInstanceName": "test",
      "InBps": 187,
      "ResourceInstanceId": "lb-bp14ue2rgktunncq****",
      "NewConn": 27,
      "RegionNo": "cn-shenzhen",
      "OutPps": 2,
      "IP": "183.60.164.XXX",
      "OutBps": 45,
      "PrivateIP": "10.21.186.XXX",
      "SessionCount": 27,
      "ResourceType": "EcsPublicIP",
      "InPps": 2,
      "TotalPps": 88,
      "TotalBps": 232,
      "VpcId": "vpc-wz9o0uzfjuj81fx7m****",
      "NatGatewayId": "ngw-wz98eedr5l5hkb8****e7",
      "NatGatewayName": "ngw-test",
      "NatIP": "47.97.66.XXX"
    }
  ]
}

Error codes

HTTP status code

Error code

Error message

Description
400 ErrorSourceCodeError The source code is invalid. The source code is invalid.
400 ErrorDirectionError The direction is invalid. The direction is invalid.
400 ErrorTimeError The time is invalid. The time is invalid.
400 ErrorIpFormat The IP address is invalid. The IP address is invalid.
400 ErrorParameters A parameter error occurred. A parameter error occurred.
400 ErrorDBSelectError A database select error occurred. The error message returned because an internal error has occurred in querying the database.
400 ErrorTrafficType The traffic type is invalid. The traffic type is invalid.
400 ErrorSortError The sort is invalid. The sort is invalid.
400 ErrorLimitFailed The limit is invalid. The limit count is invalid.
400 ErrorOrderFailed The order is invalid. The order is invalid.
400 ErrorMarshalJSON internal error. Internal error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.