You need to enable JavaScript to run this app.
导航
中转路由器
  • 文档首页
    • /中转路由器/API参考/路由策略/CreateTransitRouterRoutePolicyEntry
CreateTransitRouterRoutePolicyEntry
最近更新时间：2024.11.15 10:03:42首次发布时间：2024.03.26 10:24:48
我的收藏

调用CreateTransitRouterRoutePolicyEntry接口，为指定的路由策略添加路由策略条目。

使用说明

  • 单个路由策略中最多可添加20个路由策略条目。
  • 路由策略已绑定TR路由表时，添加策略条目可能影响业务流量转发，请谨慎操作。

调试

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

请求参数

名称类型是否必选示例值描述
ActionString是CreateTransitRouterRoutePolicyEntry要执行的操作，取值为CreateTransitRouterRoutePolicyEntry。
VersionString是2020-04-01API版本信息，当前版本为2020-04-01。
TransitRouterRoutePolicyTableIdString是tr-rpt-1i5i8khf9m58gae5kcx6****路由策略的ID。您可以调用DescribeTransitRouterRoutePolicyTables接口获取路由策略的ID。

Priority

Integer

是

100

路由策略条目的优先级，默认为空。取值范围为1～10000。数字越小则优先级越高。
同一路由策略中不能存在优先级重复的路由策略条目。

IpPrefixes.N

String

否

IpPrefixes.1=192.168.XX.XX/24&IpPrefixes.2=172.16.XX.XX/24

路由策略条目的路由前缀。

  • 仅支持精确匹配，即访问请求的目标网段与路由前缀完全相同时匹配成功。
  • 支持传入IPv4网段。
  • N：表示路由前缀的序号，取值范围 1～200。多个路由前缀之间使用&分隔。
  • 不传入该参数或该参数不传入数值时，默认为空字符串。

SourceResourceTypes.N

String

否

SourceResourceTypes.1=VPC&SourceResourceTypes.2=DirectConnectGateway

路由策略条目的源实例类型。取值如下：

  • VPC：私有网络。
  • DirectConnectGateway：专线网关。
  • TransitRouter：跨地域TR。

说明

N：表示源实例类型的序号，取值范围 1～10。多个源实例类型之间使用&分隔。
不传入该参数或该参数不传入数值时，默认为空字符串。

SourceResourceIds.N

String

否

SourceResourceIds.1=vpc-bp1aevy8sofi8mh1****&SourceResourceIds.2=dcg-3tex2x1cwd4c6c0v****

路由策略条目的源实例ID。

说明

  • N：表示源实例ID的序号，取值范围 1～10。多个源实例ID之间使用&分隔。
  • 参数SourceResourceTypes.N传入数值后，该参数为必填。

DestinationResourceTypes.N

String

否

DestinationResourceTypes.1=VPC&DestinationResourceTypes.2=DirectConnectGateway

路由策略条目的目的实例类型。取值如下：

  • VPC：私有网络。
  • DirectConnectGateway：专线网关。
  • TransitRouter：跨地域TR。

说明

  • N：表示目的实例类型的序号，取值范围 1～10。多个目的实例类型之间使用&分隔。
  • 指定的路由策略的作用方向为“In”时，不允许传入该字段。

DestinationResourceIds.N

String

否

DestinationResourceIds.1=vpc-bp1aevy8sofi8mh1****&DestinationResourceIds.2=dcg-3tex2x1cwd4c6c0v****

路由策略条目的目的实例ID。

说明

  • N：表示目的实例ID的序号，取值范围 1～10。多个目的实例ID之间使用&分隔。
  • 参数DestinationResourceIds.N传入数值后，该参数为必填。
  • 指定的路由策略的作用方向为“In”时，不允许传入该字段。

ActionResult

String

是

Permit

路由策略条目的策略行为。取值如下：

  • Permit：允许。指允许匹配该路由策略条目的路由通过。
  • Deny：拒绝。指拒绝匹配该路由策略条目的路由通过。

AsPathOperateMode

String

否

Additive

路由策略条目的AsPath设置方式。取值如下：

  • Additive：追加AsPath。指在允许通过的路由的AsPath最前面追加指定的AsPath。
  • Replace：替换AsPath。指使用指定的AsPath替换允许通过的路由的AsPath。

说明

ActionResult取值为“Permit”时，该参数生效。

ApplyAsPathValues.N

String

否

ApplyAsPathValues.1=1234&ApplyAsPathValues.2=112

路由策略条目设置的路由AsPath。取值范围为1～4294967295。

  • N：表示路由属性的序号，取值范围 1～10。
  • 多个路由属性之间使用&分隔。

说明

ActionResult取值为“Permit”时，该参数生效。

Description

String

否

for test

路由策略条目的描述信息。

  • 必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。
  • 长度限制为0 ~ 255个字符。
  • 不传入该参数或该参数不传入数值时，默认为空字符串。

ClientToken

String

否

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

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

  • 该参数值由客户端自动生成，确保不同请求的取值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。
  • 取值仅支持ASCII字符，最大不超过64个字符。
  • 未指定该参数值时，不进行幂等校验。

返回参数

名称类型示例值描述
TransitRouterRoutePolicyEntryIdStringtr-rpe-13f1fdx5l****路由策略条目的ID。

请求示例

GET /?Action=CreateTransitRouterRoutePolicyEntry&Version=2020-04-01&TransitRouterRoutePolicyTableId=tr-rpt-1i5i8khf9m58gae5kcx6****&Priority=100 HTTP/1.1
Host: open.volcengineapi.com
Service: transitrouter
Region: cn-guangzhou

返回示例

{
    "ResponseMetadata": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "Action": "CreateTransitRouterRoutePolicyEntry",
        "Version": "2020-04-01",
        "Service": "transitrouter",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "TransitRouterRoutePolicyEntryId": "tr-rpe-13f1fdx5l****"
    }
}

错误码

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

HttpCode错误码错误信息描述
400IdempotentParameterMismatchArguments on this idempotent request are inconsistent with arguments used in previous request(s).此幂等请求的参数与前一个请求中使用的参数不一致。
400InvalidCidr.MalformedThe specified cidr block is malformed.指定的网段格式不合法。
400InvalidDescription.MalformedThe specified description is malformed.指定的描述格式不合法。请修复描述格式后重试。
400InvalidDescription.TooLongThe specified description is malformed. Ensure the maximum length of description is 255.指定的描述格式不合法。描述长度不能超过255个字符。
400InvalidParameter.ClientTokenMalformedThe specified parameter ClientToken is malformed.指定的参数ClientToken格式不合法，长度不能超过64个ASCII字符。
400InvalidTransitRouter.InvalidBusinessStatusThe request is denied because the specified Transit Router is shut down due to arrears.指定的中转路由器欠费关停，不支持当前操作。
400InvalidTransitRouter.InvalidStatusThe specified Transit Router is not in the correct status for the request.指定的中转路由器所处状态无法响应该请求。
400InvalidTransitRouterRoutePolicyEntry.ActionResultInvalidThe specified Transit Router route policy entry action result is invalid. A route policy action result must be Permit or Deny.指定的策略行为不支持，仅支持允许和拒绝。
400InvalidTransitRouterRoutePolicyEntry.AsPathInvalidThe specified AsPath is invalid.指定的AsPath值不合法。
400InvalidTransitRouterRoutePolicyEntry.AsPathOperateModeInvalidThe specified AsPath operate mode of the route policy entry is invalid, only Additive and Replace are supported.指定的策略条目的AsPath操作不支持，仅支持添加和替换。
400InvalidTransitRouterRoutePolicyEntry.MatchConditionMissingThe specified Transit Router route policy entry must have at least one match condition.指定的路由策略条目至少需配置一个匹配条件。
400InvalidTransitRouterRoutePolicyEntry.PriorityInvalidThe specified priority of the Transit Router route policy entry is invalid.指定的路由策略条目优先级不合法。
400InvalidTransitRouterRoutePolicyEntry.ResourceTypeInvalidThe specified resource type of the Transit Router route policy entry is invalid.指定的路由策略匹配条件的实例类型不合法。
400LimitExceeded.RoutePolicyEntryApplyAsPathYou've reached the limit on the number of AsPath that can be applied.已达到路由策略条目可支持配置的AsPath长度上限。
400LimitExceeded.RoutePolicyEntryMatchConditionYou've reached the limit on the number of match conditions that one route policy entry can have.已达到单路由策略条目的匹配条件数目上限。
400QuotaExceeded.TransitRouterRoutePolicyEntryYou've reached the limit on the number of route policy entries that one Transit Router route policy can have.已达到单个路由策略的策略条目数上限。
403Forbidden.CreateRoutePolicyEntryWithVpnAttachmentYou are not authorized to create route policy entry with vpn attachment on Transit Router.无权限创建关联VPN网络实例连接的路由策略条目，请在中转路由器上开通BGP路由类型的VPN网络实例连接白名单。
403Forbidden.CreateTransitRouterBgpVpnAttachmentYou are not authorized to create BGP vpn attachment on Transit Router.无权限创建BGP类型的VPN网络实例连接，请在中转路由器产品开通对应的白名单。
404InvalidProject.NotFoundThe specified Project does not exist.指定的项目不存在。
404InvalidTransitRouterRoutePolicy.NotFoundThe specified Transit Router route policy does not exist.指定的路由策略不存在。
404InvalidTransitRouterRoutePolicyEntry.ResourceIdNotFoundThe specified Resource does not exist or is not attached to this Transit Router.指定的网络实例不存在或者没有关联到该中转路由器。
409InvalidTransitRouterRoutePolicyEntry.ActionResultConflictThe specified route attributes operation conflicts with the action result of route policy entry.指定的配置路由属性操作和路由策略的策略行为冲突，仅策略行为是允许的支持配置路由属性。
409InvalidTransitRouterRoutePolicyEntry.DirectionConflictThe route policy direction is In, destination resource types and ids are not supported.入方向路由策略，匹配条件不支持指定目的实例类型和目的实例列表。
409InvalidTransitRouterRoutePolicyEntry.PriorityConflictThe specified priority of the Transit Router route policy entry is conflict with another entry.指定的路由策略条目优先级和其它条目冲突。
412IdempotentProcessingThe request uses the same client token as a previous one that is still in process.幂等请求处理中。