All Products
Search
Document Center

Smart Access Gateway:DescribeGrantSagRules

Last Updated:Mar 03, 2024

Queries the permission information about 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

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:DescribeGrantSagRulesRead
  • 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-hangzhou
SmartAGIdstringYes

The ID of the SAG instance.

sag-hdg*************
PageNumberintegerNo

The page number of the returned page.

Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page.

Default value: 10. Maximum value: 50.

10

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of entries returned.

2
PageSizeinteger

The number of entries to return on each page.

10
RequestIdstring

The ID of the request.

6E1674AC-083C-4031-B047-7A66E418E0C6
PageNumberinteger

The page number of the returned page.

2
GrantRulesobject []

The information about the permissions that the SAG instance grants to the CCN instance of another Alibaba Cloud account.

CreateTimelong

The timestamp when the permissions were granted.

156576751700
SmartAGIdstring

The ID of the SAG instance.

sag-hdhgn*****
GrantTrafficServiceboolean

Indicates whether the CCN instance is granted permissions to manage network traffic from the SAG instance.

  • true: granted.
  • false: not granted.
false
InstanceIdstring

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

123455
CcnUidlong

The user ID (UID) of the Alibaba Cloud account to which the CCN instance belongs.

123456
CcnInstanceIdstring

The ID of the CCN instance.

ccn-hd**********

Examples

Sample success responses

JSONformat

{
  "TotalCount": 2,
  "PageSize": 10,
  "RequestId": "6E1674AC-083C-4031-B047-7A66E418E0C6",
  "PageNumber": 2,
  "GrantRules": {
    "GrantRule": [
      {
        "CreateTime": 156576751700,
        "SmartAGId": "sag-hdhgn*****",
        "GrantTrafficService": false,
        "InstanceId": "123455",
        "CcnUid": 123456,
        "CcnInstanceId": "ccn-hd**********"
      }
    ]
  }
}

Error codes

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