AttachExpressConnectRouterChildInstance-阿里云帮助中心

Attaches a child instance (VBR) to an Express Connect Router (ECR).

Operation description

Before you call the AttachExpressConnectRouterChildInstance operation to attach a child instance (VBR) to an ECR, make sure that the ECR is in the Active state.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

expressconnectrouter:AttachExpressConnectRouterChildInstance

create

*ExpressConnectRouter

acs:expressconnectrouter::{#accountId}:expressconnectrouter/{#EcrId}

None

Request parameters

Parameter	Type	Required	Description	Example
EcrId	string	Yes	The ID of the ECR instance.	ecr-a5xqrgbeidz1w8****
ChildInstanceId	string	Yes	The ID of the virtual border router (VBR) instance.	vbr-j6cwxhgg0s5nuephp****
ChildInstanceType	string	Yes	The type of the network instance. Set the value to VBR. VBR specifies a virtual border router.	VBR
ChildInstanceRegionId	string	Yes	The region where the VBR instance is located.	cn-hangzhou
ChildInstanceOwnerId	integer	No	The ID of the Alibaba Cloud account to which the VBR instance belongs. Note This parameter is required if you attach a network instance that belongs to another Alibaba Cloud account.	1905501448682345
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: Performs a dry run to check the request without modifying service resources. false (default): Sends the request.	true
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Generate a unique parameter value from your client for each request. The client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the request as the ClientToken. The RequestId of each request is different.	02fb3da4-130e-11e9-8e44-00****
Description	string	No	The description of the child instance. The description must be 0 to 128 characters in length.	test

Response elements

Element	Type	Description	Example
	object	RpcResponse
RequestId	string	The request ID.	6FABF516-FED3-5697-BDA2-B18C5D9A****
Success	boolean	Indicates whether the call was successful. Valid values: True: The call was successful. False: The call failed.	True
Code	string	Indicates whether the call was successful. A value of 200 indicates that the call was successful. Other values indicate that the call failed. For more information, see the "Error codes" section.	200
Message	string	The returned message.	OK
HttpStatusCode	integer	The HTTP status code.	200
DynamicCode	string	The dynamic error code.	IllegalParamFormat.EcrId
DynamicMessage	string	The dynamic error message that is used to replace the `%s` placeholder in the ErrMessage parameter. Note For example, if the value of ErrMessage is The Value of Input Parameter %s is not valid and the value of DynamicMessage is DtsJobId, the specified DtsJobId parameter is invalid.	The param format of EcrId **** is illegal.
AccessDeniedDetail	string	The details about the access denial.	Authentication is failed for ****

Examples

Success response

JSON format

{
  "RequestId": "6FABF516-FED3-5697-BDA2-B18C5D9A****",
  "Success": true,
  "Code": "200",
  "Message": "OK",
  "HttpStatusCode": 200,
  "DynamicCode": "IllegalParamFormat.EcrId",
  "DynamicMessage": "The param format of EcrId **** is illegal.",
  "AccessDeniedDetail": "Authentication is failed for ****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectStatus.Ecr	Ecr Status does not allow current operation.	The status of the express connect gateway instance does not allow the current operation. Currently, other operations are being performed or the express connect gateway instance is being deleted. Please try again later.
400	IncorrectStatus.EcrAssociation	Ecr Association Status does not allow current operation.	The ECR Association instance does not allow the current operation. Please try again after the operation in progress completes
400	OperationDenied.ForceDeleting	The current instance is being deleted.	Your current operation is rejected and the leased line gateway instance is being forcibly deleted. Please try again later.
400	OperationDenied.CrossAccountDisassociating	Unbind cross-account.	The current operation is rejected, you need to unbind the cross-account page before performing this operation.
400	OperationDenied.EcrAttachmentExisted	Ecr and TR have been linked.	The current operation is rejected. The connection between the leased line gateway instance and the TR has been established. Dismiss the connection before performing this operation.
400	OperationDenied.VbrDoesNotSupportMpbgp	The VBR does not support Mpbgp configuration.	The operation is rejected. VBR does not support Mpbgp,
400	UnsupportedRegion	Feature not supported in specified region.	The specified region does not support the leased line gateway function.
400	MissingParam.%s	The param of %s is missing.	The request parameters are not specified. Please check the corresponding parameters and try again.
400	IllegalParamFormat.%s	The param format of %s is illegal.	Illegal parameter format
400	IllegalParam.%s	The param of %s is illegal.	Illegal parameter
400	Conflict.Lock	There are other unfinished operations.	You currently have other unfinished operations, please try again later
400	Conflict.ASNOfVBR	ASN already used by other VBR.	The current VBR BgpGroup localAsn is inconsistent with the ECR asn. Adjust the consistency and rebind.
400	OperationDenied.VbrHasRouteEntryInMiddleStatus	The operation is not allowed because of VBR has route entry in middle status.	The current operation cannot be executed normally. There is a routing entry in the border router and the configuration is taking effect. Please wait for it to take effect and try again.
400	OperationDenied.VbrHasBgpGroupInMiddleStatus	The operation is not allowed because of VBR has BGP group in middle status.	The current operation cannot be performed normally. The configuration of the BGP group in the border router is in effect. Please wait for it to take effect and try again.
400	OperationDenied.VbrAlreadyAttachedToCen	VBR has already attached to CEN.	The VBR has been bound to the CEN. Delete the VBR from the CEN and try again.
400	OperationDenied.VbrAlreadyAttachedToEcr	VBR has already attached to ECR.	The VBR has been associated with a leased line gateway. Delete the VBR from the leased line gateway and try again.
400	ResourceAlreadyExist.ChildInstanceId	The specified resource of ChildInstanceId already exists.	The specified resource has been associated with the leased line gateway ECR. Please check and try again.
400	UnsupportedFeature.JumboFrame	The region where the sub-instance is located does not support the jumbo frame feature and cannot be attached to the express connect router.
400	InternalErrorTemp	The request processing has failed due to some unknown error.	The request processing has failed due to some unknown error.
404	ResourceNotFound.EcrId	EcrId not found.	ECR instance does not exist
404	ResourceNotFound.AssociationId	EcrAssociationId not found.	ECR Association instance does not exist

See for a complete list.

Release notes

See Release Notes for a complete list.