You need to enable JavaScript to run this app.
文档中心
中转路由器

中转路由器

复制全文
下载 pdf
流日志
DescribeTransitRouterFlowLogs-查询流日志列表
复制全文
下载 pdf
DescribeTransitRouterFlowLogs-查询流日志列表
调用 DescribeTransitRouterFlowLogs 接口,查询满足指定条件的TR流日志。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action String 必选 示例值:DescribeTransitRouterFlowLogs​
接口名称。当前 API 的名称为DescribeTransitRouterFlowLogs。​
​
Version String 必选 示例值:2020-04-01​
接口版本。当前 API 的版本为2020-04-01。​
​
TransitRouterFlowLogName String 可选 示例值:tr-fl-name​
流日志的名称。​
  • 必须以字母、数字或中文开头,可包含字母、数字、中文和以下特殊字符:点号(.)、下划线(_)和短横线(-)。​
  • 长度限制为1 ~ 128个字符。​
​
TransitRouterFlowLogIds.N String 可选 示例值:tr-fl-12321shagg91​
流日志的ID。​
  • N:表示流日志ID的序号,取值范围为1~100。​
  • 多个流日志ID之间使用&分隔。​
​
ResourceType String 可选 示例值:PeerAttachment​
流日志绑定的资源类型。​
  • PeerAttachment:跨地域连接。​
​
ResourceId String 可选 示例值:tr-peer-aa1etq18ertf****​
流日志绑定的资源ID。​
​
TlsProjectId String 可选 示例值:tls-project-1252ajgbx****​
日志项目的ID。​
​
TlsTopicId String 可选 示例值:tls-topic-12skahxa09****​
日志主题的ID。​
​
Status String 可选 示例值:Pending​
流日志的状态。​
  • Active:已启用。​
  • Inactive:已停止。​
  • Creating:创建中。​
  • Pending:配置中。​
  • Deleting:删除中。​
​
PageNumber Integer 可选 示例值:1​
列表的页码,默认值为1。​
​
PageSize Integer 可选 示例值:20​
分页查询时每页的行数,取值范围为1 ~ 100,默认值为20。​
​
TransitRouterId String 必选 示例值:tr-7qthudw0ll6jmc****​
中转路由器实例的ID。您可以调用DescribeTransitRouters接口获取中转路由器实例ID。​
​
TagFilters.N.Key String 可选 示例值:k1​
标签的标签键。​
  • N:表示标签键的序号,取值范围1~10。多个标签键之间使用&分隔。​
  • 指定多个标签键时,表示查询同时包含所有指定标签键的流日志。​
​
TagFilters.N.Values.N String 可选 示例值:v1​
标签的标签值。​
  • 第一个N:表示标签键的序号,取值范围1~10。​
  • 第二个N:表示标签值的序号,取值范围1~3。同一标签键多个标签值之间的关系为逻辑“或(OR)”,即查询同一标签键下添加其中一个标签值的资源。​
  • 多个标签值之间使用&分隔。​
说明​
  • 如果传入该参数,则必须先传入TagFilters.N.Key。​
  • 该参数传入空值时,表示查询指定标签键下标签值为空的资源。​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
TransitRouterFlowLogs Object[] 示例值:--​
流日志的详细信息。​
Status String 示例值:Active​
流日志实例状态​
​
AggregationInterval Integer 示例值:1​
流日志的采集周期,也是TR聚合日志数据并上报给TLS的周期,单位为分钟。​
​
CreatedAt String 示例值:2021-08-05T21:46:55+08:00​
流日志的创建时间。​
​
Description String 示例值:tr-fl-desc​
流日志的描述。​
​
LogFormatString String 示例值:${srcaddr}${dstaddr}${srcport}${dstport}${protocol}${bytes}​
流日志的日志格式。​
​
TransitRouterFlowLogId String 示例值:tr-fl-12aseg282acgqa​
流日志的ID。​
​
ResourceType String 示例值:PeerAttachment​
流日志绑定的资源类型。​
  • PeerAttachment:跨地域连接。​
​
UpdatedAt String 示例值:2021-08-05T21:46:55+08:00​
流日志最近更新时间。​
​
TransitRouterFlowLogName String 示例值:tr-fl-name​
流日志的名称。​
​
ResourceId String 示例值:tr-peer-123456****​
流日志绑定的资源ID。​
​
TlsProjectId String 示例值:fc69****​
日志项目的ID。​
​
TlsProjectName String 示例值:tls-project-name​
日志项目的名称。​
​
TlsTopicId String 示例值:b***********​
日志主题的ID。​
​
TlsTopicName String 示例值:tls-topic-name​
日志主题的名称。​
​
TransitRouterId String 示例值:tr-1hr3ty5rst****​
流日志所属中转路由器实例的ID。​
​
Tags Object[] 示例值:--​
流日志的标签信息。​
Key String 示例值:k1​
标签的标签键。​
​
Value String 示例值:v1​
标签的标签值。​
​
​
AccountId String 示例值:20****0957​
流日志所属的账号ID。​
​
​
PageNumber Integer 示例值:1​
当前页码。​
​
PageSize Integer 示例值:10​
当前分页的行数。​
​
TotalCount Integer 示例值:2​
符合条件的流日志总数。​
​
​
请求示例​
​
GET /?Action=DescribeTransitRouterFlowLogs&Version=2020-04-01&ResourceType=PeerAttachment&ResourceId=tr-peer-aa1etq18ertf****&TransitRouterId=tr-7qthudw0ll6jmc**** HTTP/1.1​
Host: transitrouter.cn-beijing.volcengineapi.com​
X-Date: 20250731T104808Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250731/cn-beijing/transitrouter/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "DescribeTransitRouterFlowLogs",​
"Version": "2020-04-01",​
"Service": "transitrouter",​
"Region": "cn-beijing"​
},​
"Result": {​
"PageNumber": 1,​
"PageSize": 10,​
"TotalCount": 2,​
"TransitRouterFlowLogs": [​
{​
"Tags": [​
{​
"Key": "k1",​
"Value": "v1"​
}​
],​
"Status": "Active",​
"AccountId": "20****0957",​
"CreatedAt": "2021-08-05T21:46:55+08:00",​
"UpdatedAt": "2021-08-05T21:46:55+08:00",​
"ResourceId": "tr-peer-123456****",​
"TlsTopicId": "b***********",​
"Description": "tr-fl-desc",​
"ResourceType": "PeerAttachment",​
"TlsProjectId": "fc69****",​
"TlsTopicName": "tls-topic-name",​
"TlsProjectName": "tls-project-name",​
"LogFormatString": "${srcaddr}${dstaddr}${srcport}${dstport}${protocol}${bytes}",​
"TransitRouterId": "tr-1hr3ty5rst****",​
"AggregationInterval": 1,​
"TransitRouterFlowLogId": "tr-fl-12aseg282acgqa",​
"TransitRouterFlowLogName": "tr-fl-name"​
}​
]​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidPage.Malformed​
The specified page is malformed.​
指定的分页参数不合法。​
400​
InvalidTagFilter.Disorder​
The specified index order of tag filter is malformed.​
指定标签过滤项的索引顺序参数格式不合法。​
400​
InvalidTagFilterKey.Malformed​
The specified parameter tag filter key is invalid.​
过滤标签键不合法。​
400​
InvalidTagFilterValue.Malformed​
The specified parameter tag filter value is invalid.​
过滤标签值不合法。​
400​
LimitExceeded.ResourceIds​
You've reached the limit of 100 resource IDs that can be specified in this request.​
该请求传入了非法或不支持的参数。资源查询数目最大限制100。​
400​
LimitExceeded.TagFilterKey​
You've reached the limit on the number of tag keys that you can filter.​
已达到单次可指定过滤标签键数量的上限。​
400​
LimitExceeded.TagFilterValue​
You've reached the limit on the number of tag values that you can filter.​
已达到单次可指定过滤标签值数量的上限。​
​
最近更新时间:2026.03.23 19:11:38
这个页面对您有帮助吗?
有用
有用
无用
无用