首页 云企业网 API参考 API目录 流日志 DescribeFlowlogs - 查询流日志

DescribeFlowlogs - 查询流日志

查询流日志。

调试

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

调试

授权信息

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

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

请求参数

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

客户端Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

说明若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
123e4567-e89b-12d3-a456-42665544****
RegionIdstring

流日志所属地域ID。

您可以通过调用DescribeChildInstanceRegions接口获取地域ID。

cn-hangzhou
FlowLogNamestring

流日志的名称。

长度为2~128个字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-),不能以http://https://开头。

myFlowlog
FlowLogIdstring

流日志ID。

flowlog-m5evbtbpt****
Descriptionstring

流日志的描述信息。

长度为2~256个字符,必须以字母或中文开头,但不能以http://https://开头。

myFlowlog
CenIdstring

云企业网实例ID。

cen-7qthudw0ll6jmc****
ProjectNamestring

存储捕获流量的Project名称。

Project名称长度为3~63字符,必须以小写字母或者数字开头和结尾,只能包括小写字母、数字和短划线(-)。

FlowLogProject
LogStoreNamestring

存储捕获流量的LogStore名称。

Logstore名称长度为3~63字符,必须以小写字母或者数字开头和结尾,只能包括小写字母、数字、短划线(-)和下划线(_)。

FlowLogStore
Statusstring

流日志的状态。取值:

  • Active:已启动。

  • Inactive:未启动。

Active
PageNumberinteger

列表的页码。默认值:1

1
PageSizeinteger

分页查询时每页的条目数。最小值:1。默认值:20

20
Tagarray

标签信息。

一次最多支持输入20个标签信息。

object
Keystring

资源的标签键。

一旦传入该值,则不允许为空字符串。最多支持64个字符,不能以aliyun或者acs:开头,不能包含http://或者https://

一次最多支持输入20个标签的标签键。

TagKey
Valuestring

资源的标签值。

标签值可以为空或输入不超过128个字符的字符串,不能以aliyun或者acs:开头,不能包含http://或者https://

每一个标签键对应一个标签值,一次最多支持输入20个标签键对应的标签值。

TagValue
TransitRouterAttachmentIdstring

网络实例连接ID。

tr-attach-qieks13jnt1cchy***

返回参数

名称类型描述示例值
object

返回结果。

PageSizestring

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

20
PageNumberstring

列表的页码。

1
RequestIdstring

请求ID。

F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1
TotalCountstring

列表条目数。

1
Successstring

当前接口调用是否成功。

  • true:成功。

  • false:失败。

true
FlowLogsarray

流日志信息列表。

object

流日志的信息。

Statusstring

流日志的状态。

  • Active:已启动。

  • Inactive:未启动。

Active
CreationTimestring

流日志的创建时间。

时间按照ISO8601标准表示,并使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。

2021-07-24T13:00:52Z
FlowLogNamestring

流日志的名称。

myFlowlog
Descriptionstring

流日志的描述信息。

myFlowlog
ProjectNamestring

存储捕获流量的Project名称。

FlowLogProject
CenIdstring

云企业网实例ID。

cen-7qthudw0ll6jmc****
LogStoreNamestring

存储捕获流量的LogStore名称。

FlowLogStore
RegionIdstring

流日志所属地域ID。

cn-hangzhou
FlowLogIdstring

流日志ID。

flowlog-m5evbtbpt****
TransitRouterAttachmentIdstring

网络实例连接ID。

tr-attach-5x4o4ynzuqbv6g****
Intervallong

流日志捕获流量的捕获窗口时长。单位:秒。取值:60600。默认值:600

60
Tagsarray

标签列表。

object
Keystring

标签键。

TagKey
Valuestring

标签值。

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****",
        "Interval": 60,
        "Tags": {
          "Tag": [
            {
              "Key": "TagKey",
              "Value": "TagValue"
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400OperationUnsupported.actionThis action is not support.当前地域不支持该操作。
400InvalidFlowlogId.NotFoundThe specified flowlog id does not exist or does not match the cen Id.参数中指定的flowlog不存在。
400IllegalParam.TagValueThe tag values are not valid.参数中指定的tag value不合法。
400IllegalParam.TagKeyThe tag keys are not valid.参数中指定的tag key不合法。
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。

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

变更历史

变更时间变更内容概要操作
2023-01-09OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2022-12-02OpenAPI 错误码发生变更,OpenAPI 入参发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:TransitRouterAttachmentId
2022-09-14OpenAPI 错误码发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2022-09-14OpenAPI 错误码发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
阿里云首页 云企业网 相关技术圈