All Products
Search

This Product

    Cloud Enterprise Network:CreateTransitRouterPrefixListAssociation

    Document Center

    Cloud Enterprise Network:CreateTransitRouterPrefixListAssociation

    Last Updated:Mar 25, 2024

    Associates the route table of an Enterprise Edition transit router with a prefix list.

    Operation description

    • Only the route tables of Enterprise Edition transit routers can be associated with prefix lists.
    • A prefix list can be associated only with one route table of an Enterprise Edition.
    • The CIDR blocks in the prefix list cannot overlap with those in the route table of the Enterprise Edition transit router. Otherwise, the prefix list fails to be associated with the route table.
    • If the route table of an Enterprise Edition transit router needs to be associated with multiple prefix lists, make sure that the CIDR blocks in the prefix lists do not overlap. Otherwise, the route table fails to be associated with the prefix lists.

    Prerequisites

    • A prefix list is created. For more information, see CreateVpcPrefixList .
    • The prefix list is shared with the Alibaba Cloud account that owns the Enterprise Edition transit router if the prefix list and the Enterprise Edition transit router belong to different Alibaba Cloud accounts. For more information about how to share a prefix list with another Alibaba Cloud account, see Resource sharing overview and API reference for resource sharing.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    cen:CreateTransitRouterPrefixListAssociationWrite
    • TransitRouterRouteEntry
      acs:cen:*:{#accountId}:centransitrouterroutentry/*
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request.

    You can use the client to generate the token, but you must make sure that the token is unique among all requests. The token can contain only ASCII characters.

    Note If you do not set this parameter, ClientToken is set to the value of RequestId. The value of RequestId for each API request may be different.
    		123e4567-e89b-12d3-a456-4266****
    RegionIdstringYes

    The ID of the region where the transit router is deployed.

    You can call the DescribeChildInstanceRegions operation to query the most recent region list.

    		cn-hangzhou
    TransitRouterIdstringYes

    The ID of the transit router.

    		tr-6ehx7q2jze8ch5ji0****
    NextHopTypestringNo

    The type of the next hop. Valid values:

    • BlackHole: specifies that all the CIDR blocks in the prefix list are blackhole routes. Packets destined for the CIDR blocks are dropped.
    • VPC: specifies that the next hop of the CIDR blocks in the prefix list is a virtual private cloud (VPC) connection.
    • VBR: specifies that the next hop of the CIDR blocks in the prefix list is a virtual border router (VBR) connection.
    • TR: specifies that the next hop of the CIDR blocks in the prefix list is an inter-region connection.
    		VPC
    PrefixListIdstringYes

    The ID of the prefix list.

    		pl-6ehtn5kqxgeyy08fi****
    TransitRouterTableIdstringYes

    The ID of the route table of the transit router.

    		vtb-6ehgc262hr170qgyc****
    NextHopstringYes

    The ID of the next hop.

    Note If NextHopType is set to BlackHole, you must set this parameter to BlackHole.
    		tr-attach-flbq507rg2ckrj****
    OwnerUidlongNo

    The ID of the Alibaba Cloud account to which the prefix list belongs.

    		1210123456123456
    DryRunbooleanNo

    Specifies whether to perform a dry run. Valid values:

    • true: performs a dry run. The system checks the required parameters, request syntax, and limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
    • false (default): performs a dry run and sends the request.
    		false

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response.

    RequestIdstring

    The ID of the request.

    		0C2EE7A8-74D4-4081-8236-CEBDE3BBCF50

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400NoPermission.AliyunServiceRolePolicyForCENYou 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.The error message returned because you do not have the permissions to create the service-linked role whose role name is AliyunServiceRolePolicyForCEN and service name is cen.aliyuncs.com. You must acquire the ram:CreateServiceLinkedRole permission before you can create the service-linked role.
    400ResourceNotSupport.CCNCCN not support prefix list.The error message returned because prefix lists are not supported by CCN instances.
    400ResourceNotFound.PrefixlistCidrsCan not find any cidr of specified prefix list.The error message returned because the specified prefix list does not contain a CIDR block.
    400ResourceNotFound.NexthopThe specified nexthop instance is not exsit.The error message returned because the specified next hop does not exist.
    400ResourceExisted.PrefixlistAssociationThe prefix list has been already associated with this route table.The error message returned because the specified prefix list is already associated with a route table.
    400ResourceNotFound.PrefixlistAssociationThe prefix list is not associated with this route table. The error message returned because the specified prefix list is not associated with a route table.
    400ResourceConflict.RouteSome of the prefixes of the prefix list are conflicted with exsited routes. The error message returned because the specified prefix list conflicts with an existing route.
    400MultipleFound.PrefixlistAssociationmultiple same prefix association record found.The error message returned because multiple configuration duplicates exist in the system.
    400QuotaReached.RouteThe quota of the route table is not enough for the request prefix list. The error message returned because the number of routes has reached the upper limit.
    400InvalidStatus.PrefixlistAssociationThe prefix list association is not in a valid state for the operation.The error message returned because the status of the specified prefix list does not support this operation. Try again later.
    400NotSupport.TrTypeThe basic tr type is not support for this operation.The error message returned because this operation is not supported by Basic Edition transit routers.
    400InvalidValue.PrefixlistCidrInvalid cidr exist in the specified prefixlist.The error message returned because the specified prefix list contains an invalid CIDR block.
    400ResourceNotSupport.NexthopThe specified nexthop instance type is not support for the operation.The error message returned because this operation is not supported by the specified next hop.
    400ResourceMismatch.NexthopThe specified nexthop and nexthop type mismatched.The error message returned because the specified next hop or next hop type is invalid.
    400ResourceNotFound.PrefixListThe specified prefixlist does not found.The error message returned because the specified prefix list does not exist.
    400OperationDenied.SystemPrefixListSystemPrefixList can not be operated.The error message returned because this operation is not supported by the system prefix list.
    400OperationFailed.OperateShareResourceOperate share prefixlist failed.The error message returned because the specified prefix list failed to be shared.
    400InvalidStatus.PrefixlistPrefixlist is not in a operate status.The error message returned because the status of the specified prefix list does not support this operation.
    400RegionNotSupport.PrefixlistPrefixlist association are not supported in this region.The error message returned because the feature is not supported in the specified region.
    400OperationFailed.TransitRouterNotExistOperation failed because transit router not exist.The error message returned because the specified transit router does not exist.
    400IncorrectStatus.RouteTableRouteTable status is invalid.The error message returned because the operation is not supported when the specified route table is in an unstable state.
    400IllegalParam.TransitRouterTableIdThe specified Route Table ID is invalid.The Route Table ID is invalid.
    400InvalidParameterInvalid parameter.The error message returned because the parameter is set to an invalid value.
    400UnauthorizedThe AccessKeyId is unauthorized.The error message returned because you do not have the permissions to perform this operation.
    404InvalidRouteTableId.NotFoundThe specified RouteTableId is not found.The specified route table ID does not exist.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-11-22The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 404
    2022-08-25The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change