All Products
Search

This Product

    Cloud Enterprise Network:CreateTransitRouterVbrAttachment

    Document Center

    Cloud Enterprise Network:CreateTransitRouterVbrAttachment

    Last Updated:Jan 11, 2023

    Creates a virtual border router (VBR) connection on an Enterprise Edition transit router.

    Operation Description

    • For more information about the regions and zones that support Enterprise Edition transit routers, see What is CEN?

    • You can use the following methods to create a VBR connection on an Enterprise Edition transit router:

      • If an Enterprise Edition transit router is already created in the region where you want to create a VBR connection, set the VbrId and TransitRouterId parameters.
      • If no Enterprise Edition transit router is created in the region where you want to create a VBR connection, set the VbrId, CenId, and RegionId parameters. Then, the system automatically creates an Enterprise Edition transit router in the specified region.

    • CreateTransitRouterVbrAttachment is an asynchronous operation. After you send a request, the ID of the VBR connection is returned but the operation is still being performed in the system background. You can call ListTransitRouterVbrAttachments to query the status of a VBR connection.

      • If a VBR is in the Attaching state, the VBR connection is being created. You can query the VBR connection but cannot perform other operations.
      • If a VBR connection is in the Attached state, the VBR connection is created.

    Authorization information

    The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

    • 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 keyword: refers to the condition keyword defined by the cloud product itself.
    • 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.
    Operate access level Resource type conditional keyword Association operation
    cen:CreateTransitRouterVbrAttachment Write
    • CEN
      acs:cen:*:{#accountId}:ceninstance/*
    • CEN
      acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}
    • CEN
      acs:cen:*:{#accountId}:centransitrouterattachment/*
      without
    		without

    Request parameters

    Parameter Type Required Description Example
    ClientToken string No

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

    You can use the client to generate the value, but you must make sure that it is unique among different requests. ClientToken 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 of each API request may be different.
    		02fb3da4-130e-11e9-8e44-001****
    CenId string No

    The ID of the Cloud Enterprise Network (CEN) instance.

    		 cen-j3jzhw1zpau2km****
    TransitRouterId string No

    The ID of the Enterprise Edition transit router.

    		 tr-bp1su1ytdxtataupl****
    RegionId string No

    The ID of the region where the VBR is deployed.

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

    		 cn-hangzhou
    TransitRouterAttachmentName string No

    The name of the VBR connection.

    The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). It must start with a letter.

    		 testname
    TransitRouterAttachmentDescription string No

    The description of the VBR connection.

    The description must be 2 to 256 characters in length. The description must start with a letter but cannot start with http:// or https://.

    		 testdesc
    VbrId string Yes

    The ID of the VBR.

    		 vbr-bp1svadp4lq38janc****
    VbrOwnerId long No

    The ID of the Alibaba Cloud account to which the VBR belongs. The default value is the ID of the current Alibaba Cloud account.

    Note If you want to connect to a network instance that belongs to another account, this parameter is required.
    		1250123456123456
    AutoPublishRouteEnabled boolean No

    Specifies whether to enable the Enterprise Edition transit router to automatically advertise routes to the VBR. Valid values:

    • false (default): no.
    • true: yes.
    		 false
    DryRun boolean No

    Specifies whether to perform a precheck to check information such as the permissions and instance status. Valid values:

    • false (default): sends the request. If the request passes the precheck, the VBR connection is created.
    • true: sends a precheck request. No VBR connection is created after the request passes the precheck. If you use this value, the system checks the required parameters and the request syntax. If the request fails to pass the precheck, an error message is returned. If the request passes the check, the system returns the ID of the request.
    		 false
    Tag array No

    The tags of the resources.
    object No
    Key string No

    The tag keys of the resources.

    The tag keys cannot be an empty string. The tag keys can be up to 64 characters in length and cannot start with acs: or aliyun. It cannot contain http:// or https://.

    You can specify at most 20 tag keys.

    		 TagKey
    Value string No

    The tag values of the resources.

    The tag values can be 0 to 128 characters in length, and cannot start with aliyun or acs:. It cannot contain http:// or https://.

    Each tag key has a unique tag value. You can specify at most 20 tag values in each call.

    		 TagValue

    Response parameters

    Parameter Type Description Example
    object
    TransitRouterAttachmentId string

    The ID of the VBR connection.

    		 tr-attach-ia340z7xis7t5s****
    RequestId string

    The ID of the request.

    		 C087A369-82B9-43EF-91F4-4B63A9C6E6B6

    Example

    Normal return example

    JSONFormat

    {
  "TransitRouterAttachmentId": "tr-attach-ia340z7xis7t5s****",
  "RequestId": "C087A369-82B9-43EF-91F4-4B63A9C6E6B6"
}

    Error codes

    Http code Error code Error message
    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.
    400 OperationUnsupported.TransitRouterRegionId The specified TransitRouterRegion does not support the operation.
    400 InvalidCenId.NotFound CenId is not found.
    400 InvalidStatus.ResourceStatus The resource is not in a valid state for the attachment operation.
    400 InvalidTransitRouterId.NotFound TransitRouterId is not found.
    400 Forbbiden.TransitRouterServiceNotOpen The user has not open transit router service.
    400 OperationUnsupported.TransitRouterType The specified TransitRouterType does not support the operation.
    400 MissingParam.CenIdOrRegionId Either CenId or RegionId must be specified.
    400 IncorrectStatus.Vpc The resource is not in a valid state for the attachment operation.
    400 Forbidden.VbrDeviceModel Attach VBR on some access device models are forbidden.
    403 Forbidden.VbrDeviceModel The attached VBR on some access device models are not supported. Please submit a ticket to continue using this VBR on CEN.

    For a list of error codes, visit the API error center.

    Change history

    Change time Summary of changes Operate
    2023-01-04 The error codes of the API operation has changed
    Change item Change content
    Error Codes The error codes of the API operation has changed
      delete Error Codes: 400
      delete Error Codes: 403
    2022-12-22 The error codes of the API operation has changed
    Change item Change content
    Error Codes The error codes of the API operation has changed
      Error Codes400 change
      delete Error Codes: 403