全部产品
Search
文档中心

智能接入网关:DescribeFlowLogs - DescribeFlowLogs

更新时间:Mar 29, 2024

调用DescribeFlowLogs查询指定地域下流日志实例信息。

调试

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

授权信息

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

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

请求参数

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

流日志实例所属地域 ID。

cn-shanghai
FlowLogIdstring

流日志实例 ID。

fl-7a56mar1kfw9vj****
FlowLogNamestring

流日志实例名称。

DDE
Descriptionstring

流日志实例描述。

desc
Statusstring

流日志实例状态,取值:

  • Active:已启动。

  • Inactive:未启动。

Active
OutputTypestring

流日志输出类型,取值:

  • sls:流日志存储在阿里云日志服务中。

  • netflow:流日志存储在您配置的 NetFlow 服务器上。

  • all:流日志同时存储在阿里云日志服务和您配置的 NetFlow 服务器上。

all
PageSizeinteger

分页查询时每页的条目数,默认值为 10

10
PageNumberinteger

查询页码,默认值为 1

1

返回参数

名称类型描述示例值
object

查询结果。

TotalCountinteger

总条目数。

5
FlowLogsobject []

流日志实例信息列表。

Statusstring

流日志实例的状态:

  • Active:已启动。

  • Inactive:未启动。

Active
TotalSagNuminteger

流日志实例关联的智能接入网关实例数目。

2
NetflowServerIpstring

存储流日志的 Netflow 服务器地址。

192.168.0.1
ProjectNamestring

日志服务的 Project 名称。

sag-flowlog-shanghai
SlsRegionIdstring

日志服务的地域 ID。

cn-shanghai
ActiveAginginteger

活跃流输出间隔。单位:秒。

300
OutputTypestring

流日志输出类型。

  • sls:流日志存储在阿里云日志服务中。

  • netflow:流日志存储在您配置的 Netflow 服务器上。

  • all:流日志同时存储在阿里云日志服务和您配置的 Netflow 服务器上。

sls
Descriptionstring

流日志实例描述。

aaa
NetflowVersionstring

存储流日志的 Netflow 协议版本号,默认值为 V9

V9
InactiveAginginteger

非活跃流输出间隔。单位:秒。

15
NetflowServerPortstring

存储流日志的 Netflow 服务器端口,默认值为 9995

9995
Namestring

流日志实例名称。

DDE
FlowLogIdstring

流日志实例 ID。

fl-7a56mar1kfw9vj****
LogstoreNamestring

日志服务的日志库名称。

config-operation-log
ResourceGroupIdstring

流日志实例所属的资源组 ID。

rg-acfm2iu4fnc****
PageSizeinteger

分页查询时每页的条目数。

10
RequestIdstring

请求 ID。

44F4E2D0-77F7-4DEC-969B-061688946143
PageNumberinteger

查询页码。

1

示例

正常返回示例

JSON格式

{
  "TotalCount": 5,
  "FlowLogs": {
    "FlowLogSetType": [
      {
        "Status": "Active",
        "TotalSagNum": 2,
        "NetflowServerIp": "192.168.0.1",
        "ProjectName": "sag-flowlog-shanghai",
        "SlsRegionId": "cn-shanghai",
        "ActiveAging": 300,
        "OutputType": "sls",
        "Description": "aaa",
        "NetflowVersion": "V9",
        "InactiveAging": 15,
        "NetflowServerPort": "9995",
        "Name": "DDE",
        "FlowLogId": "fl-7a56mar1kfw9vj****",
        "LogstoreName": "config-operation-log",
        "ResourceGroupId": "rg-acfm2iu4fnc****"
      }
    ]
  },
  "PageSize": 10,
  "RequestId": "44F4E2D0-77F7-4DEC-969B-061688946143",
  "PageNumber": 1
}

错误码

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