DescribeFlowlogs - 查询流日志 - 云企业网

查询流日志。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
cen:DescribeFlowlogs	get	Flowlog `acs:cbn:{#regionId}:{#accountId}:flowlog/` *Flowlog `acs:cbn:{#regionId}:{#accountId}:flowlog/{#FlowLogId}`	无	无

请求参数

名称	类型	必填	描述	示例值
ClientToken	string	否	客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。说明若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。	123e4567-e89b-12d3-a456-42665544****
RegionId	string	否	流日志所属地域 ID。您可以通过调用 DescribeChildInstanceRegions 接口获取地域 ID。	cn-hangzhou
FlowLogName	string	否	流日志的名称。名称可以为空或长度为 1～128 个字符，不能以 http://或 https://开头。	myFlowlog
FlowLogId	string	否	流日志 ID。	flowlog-m5evbtbpt****
Description	string	否	流日志的描述信息。描述可以为空或长度为 1～256 个字符，不能以 http://或 https://开头。	myFlowlog
CenId	string	否	云企业网实例 ID。	cen-7qthudw0ll6jmc****
ProjectName	string	否	存储捕获流量的 Project 名称。 Project 名称长度为 3~63 字符，必须以小写字母或者数字开头和结尾，只能包括小写字母、数字和短划线（-）。	FlowLogProject
LogStoreName	string	否	存储捕获流量的 LogStore 名称。 Logstore 名称长度为 3~63 字符，必须以小写字母或者数字开头和结尾，只能包括小写字母、数字、短划线（-）和下划线（_）。	FlowLogStore
Status	string	否	流日志的状态。取值： Active：已启动。 Inactive：未启动。	Active
PageNumber	integer	否	列表的页码。默认值：1。	1
PageSize	integer	否	分页查询时每页的条目数。最小值：1。默认值：20。	20
Tag	array<object>	否	标签信息。一次最多支持输入 20 个标签信息。
	object	否
Key	string	否	资源的标签键。一旦传入该值，则不允许为空字符串。最多支持 64 个字符，不能以`aliyun`或者`acs:`开头，不能包含`http://`或者`https://` 。一次最多支持输入 20 个标签的标签键。	TagKey
Value	string	否	资源的标签值。标签值可以为空或输入不超过 128 个字符的字符串，不能以`aliyun`或者`acs:`开头，不能包含`http://`或者`https://` 。每一个标签键对应一个标签值，一次最多支持输入 20 个标签键对应的标签值。	TagValue
TransitRouterAttachmentId	string	否	网络实例连接 ID。	tr-attach-qieks13jnt1cchy***
TransitRouterId	string	否	转发路由器实例 ID。	tr-uf654ttymmljlvh2x****
Interval	integer	否	流日志捕获流量的捕获窗口时长。单位：秒。取值：60 或 600。默认值：600。	600
FlowLogVersion	string	否	流日志的版本。创建流日志时自动使用系统支持的最新版本，当前为 3。	3

返回参数

名称	类型	描述	示例值
	object	返回结果。
PageSize	string	分页查询时每页的条目数。	20
PageNumber	string	列表的页码。	1
RequestId	string	请求 ID。	F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1
TotalCount	string	列表条目数。	1
Success	string	当前接口调用是否成功。 true：成功。 false：失败。	true
FlowLogs	array<object>	流日志信息列表。
FlowLog	object	流日志的信息。
Status	string	流日志的状态。 Active：已启动。 Inactive：未启动。	Active
CreationTime	string	流日志的创建时间。时间按照 ISO8601 标准表示，并使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。	2021-07-24T13:00:52Z
FlowLogName	string	流日志的名称。	myFlowlog
Description	string	流日志的描述信息。	myFlowlog
ProjectName	string	存储捕获流量的 Project 名称。	FlowLogProject
CenId	string	云企业网实例 ID。	cen-7qthudw0ll6jmc****
LogStoreName	string	存储捕获流量的 LogStore 名称。	FlowLogStore
RegionId	string	流日志所属地域 ID。	cn-hangzhou
FlowLogId	string	流日志 ID。	flowlog-m5evbtbpt****
TransitRouterAttachmentId	string	网络实例连接 ID。	tr-attach-5x4o4ynzuqbv6g****
TransitRouterId	string	转发路由器实例 ID。	tr-bp1g9313sx675zr1lajmj
LogFormatString	string	自定义流日志记录格式的字符串。格式定义为： `${字段 1}${字段 2}${字段 3}`	${srcaddr}${dstaddr}${bytes}
FlowLogVersion	string	流日志的版本。创建流日志时自动使用系统支持的最新版本，当前为 3。	3
Interval	long	流日志捕获流量的捕获窗口时长。单位：秒。取值：60 或 600。默认值：600。	60
Tags	array<object>	标签列表。
Tag	object	标签列表。
Key	string	标签键。	TagKey
Value	string	标签值。	TagValue

示例

正常返回示例

JSON格式

{
  "PageSize": "20",
  "PageNumber": "1",
  "RequestId": "F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1",
  "TotalCount": "1",
  "Success": "true",
  "FlowLogs": {
    "FlowLog": [
      {
        "Status": "Active",
        "CreationTime": "2021-07-24T13:00:52Z",
        "FlowLogName": "myFlowlog",
        "Description": "myFlowlog",
        "ProjectName": "FlowLogProject",
        "CenId": "cen-7qthudw0ll6jmc****",
        "LogStoreName": "FlowLogStore",
        "RegionId": "cn-hangzhou",
        "FlowLogId": "flowlog-m5evbtbpt****",
        "TransitRouterAttachmentId": "tr-attach-5x4o4ynzuqbv6g****",
        "TransitRouterId": "tr-bp1g9313sx675zr1lajmj",
        "LogFormatString": "${srcaddr}${dstaddr}${bytes}",
        "FlowLogVersion": "3",
        "Interval": 60,
        "Tags": {
          "Tag": [
            {
              "Key": "TagKey",
              "Value": "TagValue"
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	OperationUnsupported.action	This action is not support.	当前地域不支持该操作。
400	InvalidFlowlogId.NotFound	The specified flowlog id does not exist or does not match the cen Id.	参数中指定的flowlog不存在。
400	IllegalParam.TagValue	The tag values are not valid.	参数中指定的tag value不合法。
400	IllegalParam.TagKey	The tag keys are not valid.	参数中指定的tag key不合法。
400	InvalidDescription	Description is invalid.	描述不合法。
400	InvalidName	Name is invalid.	name不合法。
400	InvalidParameter.Interval	Interval is invalid.	指定的采样频率不合法。
400	InvalidParameter.FlowLogVersion	Flowlog version is invalid.	指定的flowlog版本不合法。
400	InvalidParameter	Invalid parameter.	参数不合法。
400	Unauthorized	The AccessKeyId is unauthorized.	账号无权限操作。

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

变更历史

变更时间	变更内容概要	操作
2024-11-14	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2024-05-22	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-12-13	OpenAPI 错误码发生变更	查看变更详情
2023-01-09	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2022-12-02	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2022-09-14	OpenAPI 错误码发生变更	查看变更详情
2022-09-14	OpenAPI 错误码发生变更	查看变更详情