调用CreateTransitRouterPrefixListAssociation接口为企业版转发路由器路由表绑定前缀列表。

使用说明

在绑定前缀列表前,建议您先了解前缀列表的使用限制、路由兼容性说明和路由传播范围。更多信息,请参见前缀列表

前提条件

  • 您已经创建了前缀列表。具体操作,请参见CreateVpcPrefixList
  • 如果企业版转发路由器路由表需要绑定跨账号的前缀列表,请确保待绑定的前缀列表已被共享给企业版转发路由器路由表所属的阿里云账号(主账号)。关于如何共享前缀列表资源,请参见资源共享概述API参考(资源共享)

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateTransitRouterPrefixListAssociation

系统规定参数。取值:CreateTransitRouterPrefixListAssociation

ClientToken String 123e4567-e89b-12d3-a456-4266****

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

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
RegionId String cn-hangzhou

转发路由器实例所属的地域ID。

您可以通过调用DescribeChildInstanceRegions接口获取地域ID。

TransitRouterId String tr-6ehx7q2jze8ch5ji0****

转发路由器实例ID。

NextHopType String VPC

下一跳类型。取值:

  • BlackHole:表示指定前缀列表下的网段均为黑洞路由,所有去往前缀列表下网段的流量均会被丢弃。
  • VPC:表示指定前缀列表下网段的下一跳为专有网络VPC(Virtual Private Cloud)连接。
  • VBR:表示指定前缀列表下网段的下一跳为边界路由器VBR(Virtual Border Router)连接。
  • TR:表示指定前缀列表下网段的下一跳为跨地域连接。
PrefixListId String pl-6ehtn5kqxgeyy08fi****

前缀列表ID。

TransitRouterTableId String vtb-6ehgc262hr170qgyc****

转发路由器路由表ID。

NextHop String tr-attach-flbq507rg2ckrj****

下一跳连接ID。

说明 如果NextHopType的取值为BlackHole,本参数需输入BlackHole
OwnerUid Long 1210123456123456

前缀列表所属的阿里云账号(主账号)ID。

  • 如果前缀列表和转发路由器路由表属于同一个账号,本参数可不填。
  • 如果前缀列表和转发路由器路由表属于不同的账号,本参数必填。
DryRun Boolean false

是否只预检此次请求。取值:

  • true:发送检查请求,不会创建绑定关系。检查项包括是否填写了必需参数、请求格式、业务限制等。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后直接创建绑定关系。

返回数据

名称 类型 示例值 描述
RequestId String 0C2EE7A8-74D4-4081-8236-CEBDE3BBCF50

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateTransitRouterPrefixListAssociation
&ClientToken=123e4567-e89b-12d3-a456-4266****
&RegionId=cn-hangzhou
&TransitRouterId=tr-6ehx7q2jze8ch5ji0****
&NextHopType=VPC
&PrefixListId=pl-6ehtn5kqxgeyy08fi****
&TransitRouterTableId=vtb-6ehgc262hr170qgyc****
&NextHop=tr-attach-flbq507rg2ckrj****
&OwnerUid=1210123456123456
&DryRun=false
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateTransitRouterPrefixListAssociationResponse>
    <RequestId>0C2EE7A8-74D4-4081-8236-CEBDE3BBCF50</RequestId>
</CreateTransitRouterPrefixListAssociationResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "0C2EE7A8-74D4-4081-8236-CEBDE3BBCF50"
}

错误码

HttpCode 错误码 错误信息 描述
400 NoPermission.AliyunServiceRolePolicyForCEN You are not authorized to create the service linked role. Role Name: AliyunServiceRolePolicyForCEN. Service Name: cen.aliyuncs.com. Make sure that the user has been granted the ram:CreateServiceLinkedRole permission. 您没有权限创建服务关联角色,角色名:AliyunServiceRolePolicyForCEN,服务名:cen.aliyuncs.com。请确保已授予当前用户ram:CreateServiceLinkedRole权限。
400 ResourceNotSupport.CCN CCN not support prefix list. CCN类型的TR不支持prefixlist,请检查您当前配置的TR或您关联的下一跳为CCN类型的TR。
400 ResourceNotFound.PrefixlistCidrs Can not find any cidr of specified prefix list. 当前绑定prefixlist中未找到任何cidr,请检查您的prefixlist配置。
400 ResourceNotFound.Nexthop The specified nexthop instance is not exsit. 您当前关联的下一跳实例不存在,请检查您的参数是否正确。
400 ResourceExisted.PrefixlistAssociation The prefix list has been already associated with this route table. 当前关联关系已存在。
400 MultipleFound.PrefixlistAssociation multiple same prefix association record found. 系统异常,系统中存在多个相同的记录。
400 InvalidStatus.PrefixlistAssociation The prefix list association is not in a valid state for the operation. 当前关联关系处于中间状态,请稍后重试。
400 NotSupport.TrType The basic tr type is not support for this operation. 基础版TR不支持prefixlist操作,请您升级后重试。
400 InvalidValue.PrefixlistCidr Invalid cidr exist in the specified prefixlist. 您当前关联的prefixlist中存在不合法的cidr,请您确保prefixlist中的所有cidr都是标准格式。
400 ResourceNotSupport.Nexthop The specified nexthop instance type is not support for the operation. prefixlist路由不支持指向当前下一跳类型,请查看API文档说明并检查您的下一跳实例类型。
400 ResourceMismatch.Nexthop The specified nexthop and nexthop type mismatched. 您当前指定的下一跳类型和您指定的下一跳实例类型不匹配。请检查您的输入参数。
400 ResourceNotFound.PrefixList The specified prefixlist does not found. 当前关联指定的prefixlist在系统中未找到,请确保当前prefixlist资源已创建。
400 OperationDenied.SystemPrefixList SystemPrefixList can not be operated. prefixlist不可操作。
400 OperationFailed.OperateShareResource Operate share prefixlist failed. prefixlist不可操作。
400 InvalidStatus.Prefixlist Prefixlist is not in a operate status. 当前prefixlist状态处于中间状态,请您稍后重试。
400 RegionNotSupport.Prefixlist Prefixlist association are not supported in this region. 当前地域暂不支持关联prefixlist。

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