All Products
Search
Document Center

Smart Access Gateway:DescribeGrantSagVbrRules

Last Updated:Mar 29, 2024

Queries authorization information about Smart Access Gateway (SAG) instances and cross-account virtual border routers (VBRs).

Debugging

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

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:
    • The required resource types are displayed in bold characters.
    • 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:DescribeGrantSagVbrRulesRead
  • SmartAccessGateway
    acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-shanghai
SmartAGIdstringNo

The ID of the SAG instance.

sag-0nnteglltw6z4b****
VbrInstanceIdstringNo

The ID of the VBR.

vbr-bp13gtbhdp0pfqg6s****
PageNumberintegerNo

The number of the page to return. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Default value:10.

10

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries returned per page.

10
RequestIdstring

The ID of the request.

46E98E69-FBA2-423E-9E5A-A3C6D843FED1
PageNumberinteger

The page number of the returned page.

1
TotalCountinteger

The total number of authorization rules.

1
GrantRulesobject []

The information about the authorization rule.

VbrInstanceIdstring

The ID of the VBR.

vbr-bp13gtbhdp0pfqg6s****
VbrUidlong

The user ID (UID) of the VBR.

1231571212121212
VbrRegionIdstring

The ID of the region where the VBR is deployed.

cn-hangzhou
CreateTimelong

The time when the rule was created.

1600743723000
SmartAGIdstring

The ID of the SAG instance.

sag-0nnteglltw6z4b****
Boundboolean

Indicates whether the SAG instance is associated with the VBR. Valid values:

  • false: not associated.
  • true: associated.
false
InstanceIdstring

The ID of the authorization rule.

sgv-3x8djyem7vqh70****
SmartAGUidlong

The user ID (UID) of the account to which the SAG instance belongs.

1231571212121212

Examples

Sample success responses

JSONformat

{
  "PageSize": 10,
  "RequestId": "46E98E69-FBA2-423E-9E5A-A3C6D843FED1",
  "PageNumber": 1,
  "TotalCount": 1,
  "GrantRules": {
    "GrantRule": [
      {
        "VbrInstanceId": "vbr-bp13gtbhdp0pfqg6s****",
        "VbrUid": 1231571212121212,
        "VbrRegionId": "cn-hangzhou",
        "CreateTime": 1600743723000,
        "SmartAGId": "sag-0nnteglltw6z4b****",
        "Bound": false,
        "InstanceId": "sgv-3x8djyem7vqh70****",
        "SmartAGUid": 1231571212121212
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400SAG.InstanceIdEmptyYou must specify the SAG instance ID.You must specify the SAG instance ID.
400SAG.InstanceNoFoundThe specified SAG instance does not exist.The specified SAG instance does not exist.

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

Change history

Change timeSummary of changesOperation
No change history