All Products
Search
Document Center

Smart Access Gateway:DescribeSagVbrRelations

Last Updated:Jul 31, 2025

Queries whether a specified virtual border router (VBR) is associated with a Smart Access Gateway (SAG) instance.

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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • 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:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • 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.
OperationAccess levelResource typeCondition keyAssociated operation
smartag:DescribeSagVbrRelationsget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The ID of the region where the SAG instance is deployed.

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

cn-shanghai
VbrRegionIdstringYes

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
VbrInstanceIdsarrayYes

The IDs of the VBRs.

stringYes

The ID of the VBR.

vbr-bp15ihkk93ezxppk****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

17D79124-104A-42DB-8FCA-CE2957CD1723
SagVbrRelationsarray<object>

Indicates whether the specified VBR is associated with an SAG instance.

SagVbrRelationobject
VbrInstanceIdstring

The ID of the VBR.

vbr-bp15ihkk93ezxppk****
SagUidstring

The ID of the Alibaba Cloud account to which the SAG instance belongs.

16884015121212****
SagInstanceIdstring

The ID of the SAG instance.

sag-0nnteglltw6z4b****

Examples

Sample success responses

JSONformat

{
  "RequestId": "17D79124-104A-42DB-8FCA-CE2957CD1723",
  "SagVbrRelations": [
    {
      "VbrInstanceId": "vbr-bp15ihkk93ezxppk****",
      "SagUid": "16884015121212****",
      "SagInstanceId": "sag-0nnteglltw6z4b****"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400Param.InvalidVersionComparatorThe specified version comparison operator is invalid.The specified version comparison operator is invalid.
400InvalidRegionIDThe specified regionId does not exist.The specified region ID does not exist.
403ForbiddenUser not authorized to operate on the specified resource.You do not have permissions to manage the specified resource.

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

Change history

Change timeSummary of changesOperation
No change history