All Products
Search
Document Center

Smart Access Gateway:DescribeSagVbrRelations

Last Updated:Mar 29, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

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
SagVbrRelationsobject []

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

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