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

中转路由器

复制全文
下载 pdf
流日志
CreateTransitRouterFlowLog-创建TR流日志实例
复制全文
下载 pdf
CreateTransitRouterFlowLog-创建TR流日志实例
调用CreateTransitRouterFlowLog接口,创建一个TR流日志。​
使用说明​
Tags.N.a类型请求参数中,“N”表示标签信息的序号,需按照数字顺序从1开始填写,取值范围为1~50。多个标签之间使用&分隔。每个标签键对应一个标签值。​
注意事项​
日志服务中日志项目和日志主题的配额超限,会导致无法创建TR流日志,具体配额请参见日志服务配额。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action String 必选 示例值:CreateTransitRouterFlowLog​
接口名称。当前 API 的名称为CreateTransitRouterFlowLog。​
​
Version String 必选 示例值:2020-04-01​
接口版本。当前 API 的版本为2020-04-01。​
​
TransitRouterFlowLogName String 可选 示例值:tr-fl-name​
流日志的名称。​
  • 必须以字母、数字或中文开头,可包含字母、数字、中文和以下特殊字符:点号(.)、下划线(_)和短横线(-)。​
  • 长度限制为1 ~ 128个字符。​
  • 不传入该参数或该参数不传入数值时,默认为流日志的ID。​
​
ResourceType String 必选 示例值:PeerAttachment​
流日志绑定的资源类型。​
  • PeerAttachment:跨地域连接。​
​
ResourceId String 必选 示例值:tr-attach-aa1etq182fdt****​
流日志绑定的资源ID。​
​
Description String 可选 示例值:test​
流日志的描述信息。​
  • 必须以字母、数字或中文开头,可包含字母、数字、中文和以下特殊字符:英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。)。​
  • 长度限制为0 ~ 255个字符。​
  • 不传入该参数或该参数不传入数值时,默认为空字符串。​
​
LogFormatString String 可选 示例值:${srcaddr}${dstaddr}${srcport}${dstport}${protocol}${bytes}​
流日志记录的日志字段。默认值为${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个字段为必选,自定义日志字段时必须包含必选字段。​
​
TlsProjectName String 必选 示例值:tls-project​
流日志项目的名称。​
  • 长度为 3~64 个字符。​
  • 只支持包含中文、小写字母、数字、下划线(_)和连字符(-)。​
  • 不支持以下划线(_)和连字符(-)开头或结尾。​
  • 不支持以tls_、tos_、tls-、volc_等预留字段开头。​
​
TlsTopicName String 必选 示例值:tls-topic​
流日志主题的名称。​
  • 长度为 3~64 个字符。​
  • 只支持包含中文、小写字母、数字、下划线(_)和连字符(-)。​
  • 不支持以下划线(_)和连字符(-)开头或结尾。​
  • 不支持以tls_、tos_、tls-、volc_等预留字段开头。​
​
AggregationInterval Integer 可选 示例值:1​
流日志的采集周期,也是TR聚合日志数据并上报给TLS的周期。支持传入1和10,默认值为10,单位为分钟。​
​
ClientToken String 可选 示例值:test-123​
客户端Token,用于保证请求幂等性。​
  • 该参数值由客户端自动生成,确保不同请求的取值唯一,避免当调用API超时或服务器内部错误时,客户端多次重试导致重复性操作。​
  • 取值仅支持ASCII字符,最大不超过64个字符。​
  • 未指定该参数值时,不进行幂等校验。​
​
Tags.N.Key String 可选 示例值:k1​
用户标签的标签键。​
  • 长度限制为1~128个字符。​
  • 大小写敏感,不能以volc:或sys:的任意大小写组合开头。​
  • 不能以空格开头或结尾。​
  • 允许包含字母、数字、空格()、下划线(_)、点号(.)、半角冒号(:)、斜杠(/)、等号(=)、加号(+)、减号(-)和@。​
说明​
  • 同一资源的标签键不允许重复。​
  • 不传入该参数或该参数不传入数值时,默认为空。​
​
Tags.N.Value String 可选 示例值:v1​
用户标签的标签值。​
  • 长度限制为0~255个字符。​
  • 大小写敏感,不能以空格开头或结尾。​
  • 允许包含字母、数字、空格()、下划线(_)、点号(.)、半角冒号(:)、斜杠(/)、等号(=)、加号(+)、减号(-)和@。​
说明​
如果传入该参数,则必须先传入Tags.N.Key。​
​
TransitRouterId String 必选 示例值:tr-7qthudw0ll6jmc****​
中转路由器实例的ID。您可以调用DescribeTransitRouters接口获取中转路由器实例的ID。​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
TransitRouterFlowLogId String 示例值:tr-fl-12agba4521****​
流日志实例的ID。​
​
​
请求示例​
​
GET /?Action=CreateTransitRouterFlowLog&Version=2020-04-01&ResourceType=PeerAttachment&ResourceId=tr-attach-aa1etq182fdt****&TlsProjectName=tls-project&TlsTopicName=tls-topic&TransitRouterId=tr-7qthudw0ll6jmc**** HTTP/1.1 ​
Host: transitrouter.cn-beijing.volcengineapi.com​
X-Date: 20250731T093343Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250731/cn-beijing/transitrouter/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20250731173345117221159091A8EA51",​
"Action": "CreateTransitRouterFlowLog",​
"Version": "2020-04-01",​
"Service": "transitrouter",​
"Region": "cn-beijing"​
},​
"Result": {​
"TransitRouterFlowLogId": "tr-fl-12agba4521****"​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
IdempotentParameterMismatch​
Arguments on this idempotent request are inconsistent with arguments used in previous request(s).​
此幂等请求的参数与前一个请求中使用的参数不一致。​
400​
InvalidDescription.Malformed​
The specified description is malformed.​
指定的描述格式不合法。请修复描述格式后重试。​
400​
InvalidDescription.TooLong​
The specified description is malformed. Ensure the maximum length of description is 255.​
指定的描述格式不合法。描述长度不能超过255个字符。​
400​
InvalidName.Malformed​
The specified name is malformed.​
指定的名称格式不合法。请修复名称格式后重试。​
400​
InvalidName.Malformed​
The specified name is malformed. Ensure the length should be 3 to 64.​
指定的名称格式不合法。名称长度应为3到63。​
400​
InvalidName.TooLong​
The specified name is malformed. Ensure the maximum length of name is 128.​
指定的名称格式不合法。名称长度不能超过128个字符。​
400​
InvalidParameter.ClientTokenMalformed​
The specified parameter ClientToken is malformed.​
指定的参数ClientToken格式不合法,长度不能超过64个ASCII字符。​
400​
InvalidResourceType.Malformed​
The specified parameter resource type is invalid.​
资源类型不合法。​
400​
InvalidTag.Disorder​
The specified index order of tag is malformed.​
指定标签的索引顺序参数格式不合法。​
400​
InvalidTagKey.Malformed​
The specified parameter tag key is invalid.​
标签键不合法。​
400​
InvalidTagValue.Malformed​
The specified parameter tag value is invalid.​
标签值不合法。​
400​
InvalidTransitRouter.InterRegionFlowLogNotSupported​
The specified Transit Router does not support the inter region flow log feature.​
指定的中转路由器实例不支持跨地域流日志功能。​
400​
InvalidTransitRouter.InvalidStatus​
The specified Transit Router is not in the correct status for the request.​
指定的中转路由器所处状态无法响应该请求。​
400​
InvalidTransitRouterAttachment.InvalidStatus​
The specified Transit Router Attachment is not in the correct status for the request.​
指定的网络实例连接所处状态无法响应该请求。​
400​
InvalidTransitRouterFlowLog.AggregationIntervalMalformed​
The specified aggregation interval is malformed.​
指定的流日志采集周期不合法。​
400​
InvalidTransitRouterFlowLog.LogFieldNotSupport​
There are log filed strings that are not supported.​
日志格式中指定的字段不在支持的范围内。​
400​
InvalidTransitRouterFlowLog.LogFormatMalformed​
The specified log format is malformed, and its format is ${field1}${field2}${fieldn}​
指定的日志字符串格式不合法,正确格式应为${字段1}${字段2}${字段n}。​
400​
InvalidTransitRouterFlowLog.RequiredFieldMissing​
The required log field string is missing.​
日志格式中缺少必选字段。​
400​
InvalidTransitRouterFlowLog.ServicePolicyNotAuthorized​
The service policy for Transit Router Access TLS has not been authorized.​
当前账号尚未授权中转路由器访问TLS的服务策略。​
400​
InvalidTransitRouterFlowLog.TLSNotSupport​
TLS service in this region is not supported for this account.​
当前账号在此地域不支持TLS服务。​
400​
InvalidTransitRouterFlowLog.TLSProjectExists​
The specified TLS project name already exists.​
指定的日志项目名称已存在,无法新建。​
400​
InvalidTransitRouterFlowLog.TLSProjectInUse​
The specified TLS project already has been used by another service.​
指定的日志项目已经被其他服务使用。​
400​
InvalidTransitRouterFlowLog.TLSTopicExists​
The specified TLS topic name already exists.​
指定的日志主题名称已存在,无法新建。​
400​
InvalidTransitRouterFlowLog.TLSTopicInUse​
The specified TLS topic already has been used by another service.​
指定的日志主题已经被其他服务使用。​
400​
InvalidTransitRouterFlowLog.TransitRouterMismatch​
The specified peer attachment does not belong to specified Transit Router.​
指定的跨地域连接不属于指定的中转路由器。​
400​
LimitExceeded.TLSProject​
You've reached the limit on the number of TLS projects per region that you can create.​
已达到当前账户在单一地域下可创建的TLS日志项目数量上限。​
400​
LimitExceeded.TLSTopic​
You've reached the limit on the number of TLS topics per project that you can create.​
已达到当前账户在单个TLS日志项目下可创建的TLS日志主题数量上限。​
400​
LimitExceeded.Tags​
You'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.​
无权限创建流日志。​
403​
InvalidTransitRouterFlowLog.TLSAccessDenied​
TLS service has not been enabled for this account.​
当前账号未开通日志服务。​
404​
InvalidProject.NotFound​
The specified Project does not exist.​
指定的项目不存在。​
404​
InvalidTransitRouter.NotFound​
The specified Transit Router does not exist.​
指定的中转路由器不存在。​
404​
InvalidTransitRouterAttachment.NotFound​
The specified Transit Router attachment does not exist.​
指定的网络实例连接不存在。​
409​
InvalidTransitRouterFlowLog.ResourceDuplicateConfigured​
The specified resource has already been configured with a flow log.​
指定的网络实例已配置流日志实例,请勿重复配置。​
412​
IdempotentProcessing​
The request uses the same client token as a previous one that is still in process.​
幂等请求处理中。​
​
最近更新时间:2026.03.23 19:11:38
这个页面对您有帮助吗?
有用
有用
无用
无用