All Products
Search
Document Center

Virtual Private Cloud:GrantInstanceToVbr

Last Updated:Dec 06, 2023

Grants a virtual border router (VBR) the permissions to connect to a virtual private cloud (VPC) that belongs to another Alibaba Cloud account.

Operation Description

Usage notes

When you connect a VBR to a VPC that belongs to another Alibaba Cloud account, the VBR must acquire the required permissions from the VPC.

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the VPC is deployed.

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

cn-hangzhou
VbrOwnerUidlongYes

The ID of the Alibaba Cloud account to which the VBR belongs.

1210123456123456
VbrInstanceIdsarrayNo

The information about the VBRs.

stringNo

The VBR that needs to acquire permissions on the VPC. You can specify multiple VBRs and separate them with commas (,).

  • When GrantType is set to All, permissions on the VPC are granted to all VBRs that belong to the specified region and Alibaba Cloud account. In this case, you can leave this parameter empty.
  • If you set GrantType to Specify, you must set VbrInstanceIds to specify the VBRs to which the permissions are granted.
vbr-m5ex0xf63xk8s5bob****,vbr-bp1h6efd7a5g66xxd****
InstanceIdstringYes

The ID of the VPC.

vpc-bp1lqhq93q8evjpky****
GrantTypestringYes

The VBRs that need to acquire permissions on the VPC. Valid values:

  • All: Permissions on the VPC are granted to all VBRs that belong to the specified region and Alibaba Cloud account. In this case, you can leave VbrInstanceIds empty.
  • Specify: Permissions on the VPC are granted to the specified VBRs. VbrInstanceIds must be assigned a value.
All
VbrRegionNostringYes

The ID of the region where the VBR is deployed.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

RequestIdstring

The request ID.

F99F13AE-D733-5856-AB97-80CC88B1D5A8

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidParam.NotNullThe parameter must not be null.A required parameter is not specified.
400Parameter.IllegalThe parameter is illegal.The parameter is invalid.
400Instance.StatusErrorThe status of instance error.The status of the instance is invalid.
404Instance.NotExistThe instance not exist.-

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

Change history

Change timeSummary of changesOperation
2023-09-21API Description Update,The error codes of the API operation change.see changesets
Change itemChange content
API DescriptionAPI Description Update
Error CodesThe error codes of the API operation change.
    delete Error Codes: 400
    delete Error Codes: 404