You need to enable JavaScript to run this app.
导航
中转路由器
  • 文档首页
    • /中转路由器/API参考/流日志/CreateTransitRouterFlowLog
CreateTransitRouterFlowLog
最近更新时间：2025.05.13 08:43:10首次发布时间：2025.05.13 08:43:10
我的收藏
有用
有用
无用
无用

调用CreateTransitRouterFlowLog接口，创建一个TR流日志。

注意事项

日志服务中日志项目和日志主题的配额超限，会导致无法创建TR流日志，具体配额请参见日志服务配额。

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

下表中，Tags.N.a类型参数中的“N”表示标签信息的序号，需按照数字顺序从1开始填写，取值范围为1～50。多个标签之间使用&分隔。每个标签键对应一个标签值。

名称类型是否必选示例值描述
ActionString是CreateTransitRouterFlowLog要执行的操作，取值为CreateTransitRouterFlowLog。
VersionString是2020-04-01API版本信息，当前版本为2020-04-01。
TransitRouterIdString是tr-7qthudw0ll6jmc****中转路由器实例的ID。您可以调用DescribeTransitRouters接口获取中转路由器实例的ID。

TransitRouterFlowLogName

String

否

tr-flowlog

TR流日志的名称。

  • 必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：点号（.）、下划线（_）和短横线（-）。

  • 长度限制为1 ~ 128个字符。

  • 不传入该参数或该参数不传入数值时，默认为TR流日志的ID。

Description

String

否

This tr flow log is used for test.

TR流日志的描述信息。

  • 必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。

  • 长度限制为0 ~ 255个字符。

  • 不传入该参数或该参数不传入数值时，默认为空字符串。

TlsProjectName

String

是

tr-fl-project

日志项目的名称。

  • 长度为 3～64 个字符。

  • 只支持包含中文、小写字母、数字、下划线（_）和连字符（-）。

  • 不支持以下划线（_）和连字符（-）开头或结尾。

  • 不支持以tls_、tos_、tls-、volc_等预留字段开头。

TlsTopicName

String

是

tr-fl-topic

日志主题的名称。

  • 长度为 3～64 个字符。

  • 只支持包含中文、小写字母、数字、下划线（_）和连字符（-）。

  • 不支持以下划线（_）和连字符（-）开头或结尾。

  • 不支持以tls_、tos_、tls-、volc_等预留字段开头。

AggregationIntervalInteger否10TR流日志的采集周期，也是TR聚合日志数据并上报给TLS的周期。支持传入1和10，默认值为10，单位为分钟。

LogFormatString

String

否

${srcaddr}${dstaddr}${srcport}${dstport}${protocol}${bytes}${tr-id}${src-region-id}${dst-region-id}${attachment-id}${packets}${start}${end}${packets-lost-no-route}${packets-lost-blackhole}${direction}

TR流日志记录的日志字段。默认值为${srcaddr}${dstaddr}${srcport}${dstport}${protocol}${bytes}${tr-id}${src-region-id}${dst-region-id}${attachment-id}${packets}${start}${end}${packets-lost-no-route}${packets-lost-blackhole}${direction}。
其中，${srcaddr}${dstaddr}${srcport}${dstport}${protocol}${bytes}中的6个字段为必选，自定义日志字段时必须包含必选字段。

ResourceType

String

是

PeerAttachment

TR流日志绑定的资源类型。

  • PeerAttachment：跨地域连接。
ResourceIdString是tr-attach-12w7hruhlhlrd****TR流日志绑定资源的ID。

Tags.N.Key

String

否

Tags.1.Key=k1&Tags.2.Key=k2

用户标签的标签键。

  • 长度限制为1～128个字符。

  • 大小写敏感，不能以volc:或sys:的任意大小写组合开头。

  • 不能以空格开头或结尾。

  • 允许包含字母、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。

  • 同一资源的标签键不允许重复。

  • 不传入该参数或该参数不传入数值时，默认为空。

Tags.N.Value

String

否

Tags.1.Value=v1&Tags.2.Value=v2

用户标签的标签值。

  • 长度限制为0～255个字符。

  • 大小写敏感，不能以空格开头或结尾。

  • 允许包含字母、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。

如果传入该参数，则必须先传入Tags.N.Key。

ClientToken

String

否

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

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

  • 该参数值由客户端自动生成，确保不同请求的取值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。

  • 取值仅支持ASCII字符，最大不超过64个字符。

  • 未指定该参数值时，不进行幂等校验。

返回参数

名称类型示例值描述
TransitRouterFlowLogIdStringtr-fl-372whz43lbwnb28twj****TR流日志的ID。

请求示例

GET /?Action=CreateTransitRouterFlowLog&Version=2020-04-01&TransitRouterId=tr-7qthudw0ll6jmc****&TlsProjectName=tr-fl-project&TlsTopicName=tr-fl-topic&ResourceType=PeerAttachment&ResourceId=tr-attach-12w7hruhlhlrd**** HTTP/1.1
Host: open.volcengineapi.com
ServiceName: transitrouter
Region: cn-guangzhou

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "CreateTransitRouterFlowLog",
        "Version": "2020-04-01",
        "Service": "transitrouter",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "TransitRouterFlowLogId": "tr-fl-372whz43lbwnb28twj****"
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode错误码错误信息描述
400IdempotentParameterMismatchArguments on this idempotent request are inconsistent with arguments used in previous request(s).此幂等请求的参数与前一个请求中使用的参数不一致。
400InvalidDescription.MalformedThe specified description is malformed.指定的描述格式不合法。请修复描述格式后重试。
400InvalidDescription.TooLongThe specified description is malformed. Ensure the maximum length of description is 255.指定的描述格式不合法。描述长度不能超过255个字符。
400InvalidName.MalformedThe specified name is malformed. Ensure the length should be 3 to 64.指定的名称格式不合法。名称长度应为3到63。
400InvalidName.MalformedThe specified name is malformed.指定的名称格式不合法。请修复名称格式后重试。
400InvalidName.TooLongThe specified name is malformed. Ensure the maximum length of name is 128.指定的名称格式不合法。名称长度不能超过128个字符。
400InvalidParameter.ClientTokenMalformedThe specified parameter ClientToken is malformed.指定的参数ClientToken格式不合法，长度不能超过64个ASCII字符。
400InvalidResourceType.MalformedThe specified parameter resource type is invalid.资源类型不合法。
400InvalidTag.DisorderThe specified index order of tag is malformed.指定标签的索引顺序参数格式不合法。
400InvalidTagKey.MalformedThe specified parameter tag key is invalid.标签键不合法。
400InvalidTagValue.MalformedThe specified parameter tag value is invalid.标签值不合法。
400InvalidTransitRouter.InterRegionFlowLogNotSupportedThe specified Transit Router does not support the inter region flow log feature.指定的中转路由器实例不支持跨地域流日志功能。
400InvalidTransitRouter.InvalidStatusThe specified Transit Router is not in the correct status for the request.指定的中转路由器所处状态无法响应该请求。
400InvalidTransitRouterFlowLog.AggregationIntervalMalformedThe specified aggregation interval is malformed.指定的流日志采集周期不合法。
400InvalidTransitRouterFlowLog.LogFieldNotSupportThere are log filed strings that are not supported.日志格式中指定的字段不在支持的范围内。
400InvalidTransitRouterFlowLog.LogFormatMalformedThe specified log format is malformed, and its format is ${field1}${field2}${fieldn}指定的日志字符串格式不合法，正确格式应为${字段1}${字段2}${字段n}。
400InvalidTransitRouterFlowLog.RequiredFieldMissingThe required log field string is missing.日志格式中缺少必选字段。
400InvalidTransitRouterFlowLog.ServicePolicyNotAuthorizedThe service policy for Transit Router Access TLS has not been authorized.当前账号尚未授权中转路由器访问TLS的服务策略。
400InvalidTransitRouterFlowLog.TLSNotSupportTLS service in this region is not supported for this account.当前账号在此地域不支持TLS服务。
400InvalidTransitRouterFlowLog.TLSProjectExistsThe specified TLS project name already exists.指定的日志项目名称已存在，无法新建。
400InvalidTransitRouterFlowLog.TLSProjectInUseThe specified TLS project already has been used by another service.指定的日志项目已经被其他服务使用。
400InvalidTransitRouterFlowLog.TLSTopicExistsThe specified TLS topic name already exists.指定的日志主题名称已存在，无法新建。
400InvalidTransitRouterFlowLog.TLSTopicInUseThe specified TLS topic already has been used by another service.指定的日志主题已经被其他服务使用。
400InvalidTransitRouterFlowLog.TransitRouterMismatchThe specified peer attachment does not belong to specified Transit Router.指定的跨地域连接不属于指定的中转路由器。
400LimitExceeded.TLSProjectYou've reached the limit on the number of TLS projects per region that you can create.已达到当前账户在单一地域下可创建的TLS日志项目数量上限。
400LimitExceeded.TLSTopicYou've reached the limit on the number of TLS topics per project that you can create.已达到当前账户在单个TLS日志项目下可创建的TLS日志主题数量上限。
400LimitExceeded.TagsYou've reached the limit on the number of tags that you can operate at a time.已达到单次可操作标签数量的上限。

403

Forbidden.CreateTransitRouterFlowLog
改

You are not authorized to create transit router flow log. You are not authorized to create Transit Router flow log.

无权限创建流日志，请开通流日志的白名单。 无权限创建流日志。

403InvalidTransitRouterFlowLog.TLSAccessDeniedTLS service has not been enabled for this account.当前账号未开通日志服务。
404InvalidProject.NotFoundThe specified Project does not exist.指定的项目不存在。
404InvalidTransitRouter.NotFoundThe specified Transit Router does not exist.指定的中转路由器不存在。
404InvalidTransitRouterAttachment.NotFoundThe specified Transit Router attachment does not exist.指定的网络实例连接不存在。
409InvalidTransitRouterFlowLog.ResourceDuplicateConfiguredThe specified resource has already been configured with a flow log.指定的网络实例已配置流日志实例，请勿重复配置。
412IdempotentProcessingThe request uses the same client token as a previous one that is still in process.幂等请求处理中。