全部产品
Search

搜索本产品

    网络智能服务：GetNatTopN - 获取NAT网关SNAT转发实时数据排名

    文档中心

    网络智能服务：GetNatTopN - 获取NAT网关SNAT转发实时数据排名

    更新时间：Sep 13, 2024
    目前该API接口已标记为弃用，推荐使用替代API：nis(2021-12-16) - GetNisNetworkRanking。

    调用GetNatTopN接口，获取NAT网关的SNAT转发实时数据排名。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    nis:GetNatTopNlist
    • 全部资源
      *
      无
    		无

    请求参数

    名称类型必填描述示例值
    RegionIdstring否

    NAT 网关实例所属地域 ID。

    		cn-shanghai
    NatGatewayIdstring是

    NAT 网关实例 ID。

    		ngw-sample***
    BeginTimelong是

    查询指标的开始毫秒时间戳。如果不指定 EndTime，则查询的是 BeginTime 指定的时间点的情况。

    		1638239092000
    EndTimelong否

    查询指标的结束毫秒时间戳。BeginTime 和 EndTime 的最大差距不能超过 24 小时，即 86400000。

    		1638239093000
    OrderBystring否

    对 NAT 网关进行 SNAT 转发实时数据排名的指标。取值：

    • InBps：入方向流量。单位：bps。
    • OutBps：出方向流量。单位：bps。
    • InPps：入方向包速率。单位：个/秒。
    • OutPps：出方向包速率。单位：个/秒。
    • NewSessionPerSecond：新建连接数。单位：个/秒。
    • ActiveSessionCount：并发连接数。单位：个。
    		InBps
    TopNinteger否

    查询 NAT 网关的 SNAT 转发实时数据排名的条目数。取值范围：1~100。默认值：10。

    		10
    Ipstring否

    查询指定 IP 地址的监控指标。当输入 Ip 参数时，无需输入 TopN 和 OrderBy。

    		192.168.156.101

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    		77C512B5-12f3-f892-BD94-88A98271C1A0
    NatGatewayTopNarray<object>

    NAT 网关 SNAT 转发实时数据排名数组。

    object

    NAT 网关 SNAT 转发实时数据排名对象。以下指标取 BeginTime 到 EndTime 的均值。

    Ipstring

    IP 地址。

    		192.168.156.101
    InBpsfloat

    入方向流量。单位：bps。

    		100
    OutBpsfloat

    出方向流量。单位：bps。

    		200
    InPpsfloat

    入方向包速率。单位：个/秒。

    		10
    OutPpsfloat

    出方向包速率。单位：个/秒。

    		20
    InFlowPerMinutefloat

    保留字段，暂未使用。

    		10
    OutFlowPerMinutefloat

    保留字段，暂未使用。

    		10
    NewSessionPerSecondfloat

    新建连接数。单位：个/秒。

    		2
    ActiveSessionCountfloat

    并发连接数。单位：个。

    		8
    IsTopNOpenboolean

    是否已开通网络智能服务(NIS)功能，未开通时 NatGatewayTopN 返回空。

    • true：已开通。
    • false：未开通。
    		true

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "77C512B5-12f3-f892-BD94-88A98271C1A0",
  "NatGatewayTopN": [
    {
      "Ip": "192.168.156.101",
      "InBps": 100,
      "OutBps": 200,
      "InPps": 10,
      "OutPps": 20,
      "InFlowPerMinute": 10,
      "OutFlowPerMinute": 10,
      "NewSessionPerSecond": 2,
      "ActiveSessionCount": 8
    }
  ],
  "IsTopNOpen": true
}

    错误码

    HTTP status code错误码错误信息描述
    400IllegalParam.TopNThe TopN(%s) should not greater than 100.最大仅支持Top 100，实际传入为(%s)。
    400IllegalParam.BeginTimeAndEndTimeIt only supports querying data for up to 7 days: %s.最大仅支持查询7天的数据：%s。
    400IllegalParam.ResourceIdThe specified resourceId (%s) may be not exist.指定的实例(%s)可能不存在，请检查是否拼写错误。
    400IllegalParam.OrderByThe specified param of orderBy (%s) is invalid.指定的排序字段(%s)不合法。

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2024-07-10OpenAPI 变更为 deprecated，即将下线、OpenAPI 错误码发生变更查看变更详情
    2023-04-27OpenAPI 错误码发生变更查看变更详情