GrantInstanceToExpressConnectRouter - Express Connect - Alibaba Cloud Documentation Center

Grants a virtual private cloud (VPC) or a virtual border router (VBR) from another account to an Express Connect Router (ECR).

Operation description

An authorization is required to associate a network instance owned by a different account with an ECR. The permission must be granted by the network instance's account.

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:GrantInstanceToExpressConnectRouter

create

VPC

acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}

VirtualBorderRouter

acs:expressconnect:{#regionId}:{#accountId}:virtualborderrouter/{#VbrId}

InstanceType

None

Request parameters

Parameter	Type	Required	Description	Example
EcrId	string	Yes	The ID of the associated ECR.	ecr-mezk2idmsd0vx2****
EcrOwnerAliUid	integer	Yes	The ID of the Alibaba Cloud account to which the ECR instance belongs.	121012345612****
InstanceId	string	Yes	The ID of the network instance.	vbr-j6cwxhgg0s5nuephp****
InstanceType	string	Yes	The type of the network instance. Valid values: VBR VPC	VBR
InstanceRegionId	string	Yes	The region ID of the network instance.	cn-hangzhou
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: Performs a dry run without modifying the service resource. false (default): Sends a normal request.	true
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Generate a unique token from your client. The 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 may be different for each request.	02fb3da4-130e-11e9-8e44-00****

Response parameters

Parameter	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	The response code. A value of 200 indicates that the call was successful. For information about other response codes, 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 errorMessage parameter. Note For example, if the value of errorMessage 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 of 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\n",
  "DynamicMessage": "The param format of EcrId **** is illegal.\n",
  "AccessDeniedDetail": "Authentication is failed for ****\n"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.EcrOwnerAliUid	The Ecr instance account parameter is invalid.	The account number of the leased line gateway instance is invalid, please check and enter again.
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	IllegalParam.InstanceOwnerId	Specified parameter InstanceOwnerId is not valid.	The instance account is invalid. Please check and enter the parameter again.
404	ResourceNotFound.EcrId	EcrId not found.	ECR instance does not exist

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.