使用DescribeFlowLogs查询专线网关的流日志-高速通道-阿里云

查询流日志。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

expressconnectrouter:DescribeFlowLogs

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
EcrId	string	是	专线网关实例 ID。	ecr-a5xqrgbeidz1w8****
DryRun	boolean	否	是否只预检此次请求。取值： true：发送检查请求，不会修改服务资源。 false（默认值）：发送正常请求。	true
ClientToken	string	否	客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。说明若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。	02fb3da4-130e-11e9-8e44-00****
Tag	array<object>	否	标签。最多可以绑定 20 个标签。
	object	否	标签列表。
Key	string	否	资源的标签键。一旦传入该值，则不允许为空字符串。最多支持 128 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或者 https://。	TestKey
Value	string	否	监听的标签值。N 的取值范围：1~20。一旦传入该值，可以为空字符串。最多支持 128 个字符，不能以 acs:开头，不能包含 http://或者 https://。	TestValue
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	gAAAAABkWw*******
MaxResults	integer	否	本次读取的最大数据量。取值范围：1～2147483647。默认值：10。	10
FlowLogId	string	否	流日志实例 ID。	ecr-flog-jqnr0veifo5d****
FlowLogName	string	否	流日志名称。长度为 0～128 个字符。	same-flowlog
ProjectName	string	否	存储捕获流量的 Project。如果您已经在当前地域创建了 Project，您可以输入已创建的 Project 的名称。如果您未在当前地域创建 Project，您可以为 Project 自定义名称，系统会帮您自动创建 Project。 Project 名称在阿里云地域内全局唯一，创建后不可修改。其命名规则如下： Project 名称必须全局唯一。只能包括小写字母、数字和短划线（-）。必须以小写字母或者数字开头和结尾。长度为 3~63 字符。	myFlowlog
LogStoreName	string	否	存储捕获流量的 Logstore。如果您已经在当前地域创建了 Logstore，您可以输入已创建的 Logstore 的名称。如果您未在当前地域创建 Logstore，您可以为 Logstore 自定义名称，系统会帮您自动创建 Logstore。 Logstore 名称。其命名规则如下：同一个 Project 下，Logstore 名称不可重复。只能包括小写字母、数字、短划线（-）和下划线（_）。必须以小写字母或者数字开头和结尾。长度为 3~63 字符。	myFlowlog
InstanceId	string	否	专线网关加载的 VBR 实例 ID。	vbr-j6cwxhgg0s5nuephp****
ResourceGroupId	string	否	流日志实例所属资源组的 ID。	rg-aek2aq7f4va****
Version	string	否

返回参数

名称	类型	描述	示例值
	object	RpcResponse
RequestId	string	请求 ID。	6FABF516-FED3-5697-BDA2-B18C5D9A****
Success	boolean	是否调用成功。取值： True：成功。 False：失败。	True
Code	string	判断调用是否成功。返回值为 200 表示加载成功，返回其他值表示加载失败，失败原因参见错误码。	200
Message	string	操作返回信息。	OK
HttpStatusCode	integer	HTTP 状态码。	200
DynamicCode	string	动态错误码。	IllegalParamFormat.EcrId
DynamicMessage	string	动态错误信息，用于替换返回参数 ErrMessage 错误信息中的`%s`。说明如果 ErrMessage 返回The Value of Input Parameter %s is not valid，且 DynamicMessage 返回 DtsJobId，则代表所传入的请求参数 DtsJobId 不合法。	The param format of EcrId **** is illegal.
AccessDeniedDetail	string	访问被拒绝详细信息。	Authentication is failed for ****
TotalCount	integer	符合查询条件的记录总数。	11
MaxResults	integer	本次读取的最大数据量。取值范围：1~2147483647。默认值为 10。	10
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	AAAAAYws9fJ0Ur4MGm/5OkDoW/Zn0J0/sCjivzwX9oBcwFnWaaas/kSG+J/WzLOxJHS4****
FlowLogs	array<object>	流日志信息列表。
	object	流日志信息。
FlowLogId	string	流日志实例 ID。	ecr-flog-leypqehtgtia2*****
EcrId	string	专线网关实例 ID。	ecr-h4cop1khw98*****
RegionId	string	ECR 所属的地域 ID。	cn-shanghai
Status	string	流日志的状态。 Active：已启动。 Inactive：未启动。	Active
FlowLogName	string	流日志的名称。	myFlowlog
Description	string	专线网关实例的描述信息。	myFlowlog
Interval	integer	流日志捕获流量的捕获窗口时长。单位：秒。取值： 60 600 默认值：600。	600
SamplingRate	string	采样比例。取值 1:4096 1:2048 1:1024 默认值：1:4096。	1:4096
LogStoreName	string	存储捕获流量的 LogStore 名称。	FlowLogStore
ProjectName	string	存储捕获流量的 Project 名称。	FlowLogProject
InstanceType	string	网络实例的类型。取值： VBR：边界路由器实例。	VBR
ResourceGroupId	string	专线网关实例所属资源组的 ID。	rg-aekzb3xwrexc4ry
Tags	array<object>	专线网关实例的标签键。
	object	专线网关实例的标签键。
Key	string	实例的标签键。一旦传入该值，则不允许为空字符串。说明最多支持 64 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	TagKey
Value	string	标签值。说明最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。一旦输入该值，可以为空字符串。	TagValue
InstanceId	string	授权实例的 ID。	vbr-9dpty76irpf4u15*****
CreationTime	string	流日志的创建时间。时间按照 ISO8601 标准表示，并使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。	2023-09-21T04:20Z
SlsRegionId	string	日志服务的地域 ID。	cn-hangzhou

示例

正常返回示例

JSON格式

{
  "RequestId": "6FABF516-FED3-5697-BDA2-B18C5D9A****",
  "Success": true,
  "Code": "200",
  "Message": "OK",
  "HttpStatusCode": 200,
  "DynamicCode": "IllegalParamFormat.EcrId",
  "DynamicMessage": "The param format of EcrId **** is illegal.",
  "AccessDeniedDetail": "Authentication is failed for ****\n",
  "TotalCount": 11,
  "MaxResults": 10,
  "NextToken": "AAAAAYws9fJ0Ur4MGm/5OkDoW/Zn0J0/sCjivzwX9oBcwFnWaaas/kSG+J/WzLOxJHS4****",
  "FlowLogs": [
    {
      "FlowLogId": "ecr-flog-leypqehtgtia2*****",
      "EcrId": "ecr-h4cop1khw98*****",
      "RegionId": "cn-shanghai",
      "Status": "Active",
      "FlowLogName": "myFlowlog",
      "Description": "myFlowlog",
      "Interval": 600,
      "SamplingRate": "1:4096 ",
      "LogStoreName": "FlowLogStore",
      "ProjectName": "FlowLogProject",
      "InstanceType": "VBR",
      "ResourceGroupId": "rg-aekzb3xwrexc4ry",
      "Tags": [
        {
          "Key": "TagKey",
          "Value": "TagValue"
        }
      ],
      "InstanceId": "vbr-9dpty76irpf4u15*****",
      "CreationTime": "2023-09-21T04:20Z",
      "SlsRegionId": "cn-hangzhou"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	IncorrectStatus.Ecr	Ecr Status does not allow current operation.	专线网关实例状态不允许当前操作。目前有其它操作正在执行或者专线网关实例正在被删除，请求稍后再试
400	OperationDenied.ForceDeleting	The current instance is being deleted.	您当前操作被拒绝，专线网关实例正在被强制删除，请稍后再试
400	UnsupportedRegion	Feature not supported in specified region.	指定的地域当前不支持专线网关功能。
400	IllegalParamFormat.%s	The param format of %s is illegal.	参数格式非法

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

变更历史

更多信息，参考变更详情。