Call GrantInstanceToVbr to grant a VBR permissions to connect to a cross-account VPC - Virtual Private Cloud - Alibaba Cloud - Virtual Private Cloud

Operation description

This operation is used for cross-account scenarios. Before calling this operation, ensure that the following resources are ready:

Account A (VPC owner, the caller of this operation):

A VPC has been created and is in the Available state (CreateVpc).

Account B (VBR owner, the account specified by VbrOwnerUid): When GrantType=Specify, the VBRs specified in VbrInstanceIds must already be created. Creating a VBR depends on the complete Express Connect circuit lifecycle:

Call CreatePhysicalConnection to create an Express Connect circuit.
Apply for a Letter of Authorization (LOA) and complete the construction (ApplyPhysicalConnectionLOA → CompletePhysicalConnectionLOA). The Express Connect circuit enters the Confirmed state.
Call EnablePhysicalConnection to enable the Express Connect circuit (the circuit must be in the Confirmed state).
Call CreateVirtualBorderRouter to create a VBR (the Express Connect circuit must be in the Enabled state. Otherwise, the error InvalidPhysicalConnectionId.NotEnabled is returned).

After the preceding preparations are complete, Account A calls this operation to grant the VPC to the VBR of Account B:

GrantType=All: Grants authorization to all VBRs under Account B (only the validity of VbrOwnerUid is verified. The VBRs do not need to be created yet).
GrantType=Specify: Grants authorization to specified VBRs. The instances in VbrInstanceIds must already exist in the region specified by VbrRegionNo under the account specified by VbrOwnerUid. Otherwise, the error Instance.NotExist is returned.

Note: VbrOwnerUid cannot be the same as the caller's account. Otherwise, the error Parameter.Illegal is returned.

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

vpc:GrantInstanceToVbr

update

*VPC

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the VPC-connected instance for which authorization is to be granted. You can invoke the DescribeRegions operation to query the region ID.	cn-hangzhou
VbrOwnerUid	integer	Yes	The ID of the Alibaba Cloud account that owns the VBR instance to be authorized. This account must be different from the caller's account. You cannot specify the caller's own account ID. This operation is used for cross-account authorization.	1210123456123456
VbrInstanceIds	array	No	The list of VBR instances to be authorized.
	string	No	The VBR instances that receive the authorization. Separate multiple VBR instances with commas (,). If GrantType is set to All, this parameter can be left empty, which indicates that authorization of the VPC-connected instance is granted to all VBR instances in the specified region under the specified Alibaba Cloud account. If GrantType is set to Specify, this parameter is required, which indicates that authorization of the VPC-connected instance is granted to the specified VBR instances.	vbr-m5ex0xf63xk8s5bob**,vbr-bp1h6efd7a5g66xxd**
InstanceId	string	Yes	The ID of the VPC-connected instance for which authorization is to be granted.	vpc-bp1lqhq93q8evjpky****
GrantType	string	Yes	The scope of VBR instances to be authorized. Valid values: All: Grants authorization of the VPC-connected instance to all VBR instances in the specified region under the specified Alibaba Cloud account. In this case, the VbrInstanceIds parameter can be left empty. Specify: Grants authorization of the VPC-connected instance to specified VBR instances. In this case, the VbrInstanceIds parameter is required.	All
VbrRegionNo	string	Yes	The region ID of the VBR instance to be authorized.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The response struct.
RequestId	string	The request ID.	F99F13AE-D733-5856-AB97-80CC88B1D5A8

Examples

Success response

JSON format

{
  "RequestId": "F99F13AE-D733-5856-AB97-80CC88B1D5A8"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParam.NotNull	The parameter must not be null.
400	Parameter.Illegal	The parameter is illegal.	The parameter is invalid.
400	Instance.StatusError	The status of instance error.	The status of the instance is invalid.
404	Instance.NotExist	The instance not exist.	The instance does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.