调用DescribeFlowlogs接口查询流日志的配置信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeFlowlogs

系统规定参数。取值:DescribeFlowlogs

ClientToken String 123e4567-e89b-12d3-a456-42665544****

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

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

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
RegionId String cn-hangzhou

流日志所属地域ID。

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

FlowLogName String myFlowlog

流日志的名称。

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

FlowLogId String flowlog-m5evbtbpt****

流日志ID。

Description String myFlowlog

流日志的描述信息。

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

CenId String cen-7qthudw0ll6jmc****

云企业网实例ID。

ProjectName String FlowLogProject

存储捕获流量的Project名称。

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

LogStoreName String FlowLogStore

存储捕获流量的LogStore名称。

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

Status String Active

流日志的状态。取值:

  • Active:已启动。
  • Inactive:未启动。
PageNumber Integer 1

列表的页码。默认值:1

PageSize Integer 20

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

返回数据

名称 类型 示例值 描述
PageSize String 20

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

PageNumber String 1

列表的页码。

RequestId String F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1

请求ID。

TotalCount String 1

列表条目数。

Success String true

当前接口调用是否成功。

  • true:成功。
  • false:失败。
FlowLogs Array of FlowLog

流日志信息列表。

FlowLog
Status String Active

流日志的状态。

  • Active:已启动。
  • Inactive:未启动。
CreationTime String 2021-07-24T13:00:52Z

流日志的创建时间。

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

FlowLogName String myFlowlog

流日志的名称。

Description String myFlowlog

流日志的描述信息。

ProjectName String FlowLogProject

存储捕获流量的Project名称。

CenId String cen-7qthudw0ll6jmc****

云企业网实例ID。

LogStoreName String FlowLogStore

存储捕获流量的LogStore名称。

RegionId String cn-hangzhou

流日志所属地域ID。

FlowLogId String flowlog-m5evbtbpt****

流日志ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeFlowlogs
&ClientToken=123e4567-e89b-12d3-a456-42665544****
&RegionId=cn-hangzhou
&FlowLogName=myFlowlog
&FlowLogId=flowlog-m5evbtbpt****
&Description=myFlowlog
&CenId=cen-7qthudw0ll6jmc****
&ProjectName=FlowLogProject
&LogStoreName=FlowLogStore
&Status=Active
&PageNumber=1
&PageSize=20
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeFlowlogsResponse>
    <PageSize>20</PageSize>
    <PageNumber>1</PageNumber>
    <RequestId>F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1</RequestId>
    <TotalCount>1</TotalCount>
    <Success>true</Success>
    <FlowLogs>
        <Status>Active</Status>
        <CreationTime>2021-07-24T13:00:52Z</CreationTime>
        <FlowLogName>myFlowlog</FlowLogName>
        <Description>myFlowlog</Description>
        <ProjectName>FlowLogProject</ProjectName>
        <CenId>cen-7qthudw0ll6jmc****</CenId>
        <LogStoreName>FlowLogStore</LogStoreName>
        <RegionId>cn-hangzhou</RegionId>
        <FlowLogId>flowlog-m5evbtbpt****</FlowLogId>
    </FlowLogs>
</DescribeFlowlogsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : "20",
  "PageNumber" : "1",
  "RequestId" : "F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1",
  "TotalCount" : "1",
  "Success" : "true",
  "FlowLogs" : [ {
    "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****"
  } ]
}

错误码

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