All Products
Search
Document Center

Smart Access Gateway:DescribeGrantRules

Last Updated:Mar 29, 2024

Queries the authorization information about a Cloud Connect Network (CCN) 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:DescribeGrantRulesRead
  • CloudConnectNetwork
    acs:smartag:{#regionId}:{#accountId}:ccn/{#AssociatedCcnId}
  • CloudConnectNetwork
    acs:smartag:{#regionId}:{#accountId}:ccn/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-shanghai
AssociatedCcnIdstringNo

The ID of the CCN instance.

ccn-n2935s1mnwv8i*****
PageSizeintegerNo

The number of entries to return on each page.

Default value: 10. Maximum value: 50.

10
PageNumberintegerNo

The number of the page to return.

Default value: 1.

1

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of entries returned.

1
PageSizeinteger

The number of entries returned on each page.

10
RequestIdstring

The ID of the request.

FA579C2D-84A0-4BA1-B9C3-1E5A3B15F1B6
PageNumberinteger

The page number of the returned page.

1
GrantRulesobject []

The permissions that are granted.

CenInstanceIdstring

The ID of the Cloud Enterprise Network (CEN) instance.

cen-0jtu0bcbika5b5****
CenUidlong

The UID of the Alibaba Cloud account to which the CEN instance belongs.

1250123456123456
GmtCreatelong

The timestamp when the permissions are granted.

1563439920000
GrantRuleIdstring

The ID of the authorization rule.

18313265-d988-406c-965d-3e110ff*****
GrantTrafficServiceboolean

Indicates whether the permissions to manage network traffic from the CCN instance are granted to a CEN instance that belongs to another account. Valid values:

  • true: yes
  • false: no
false
GmtModifiedlong

The timestamp when the permissions are modified.

1563439920000
CcnUidlong

The UID of the Alibaba Cloud account to which the CCN instance belongs.

1220123456123456
RegionIdstring

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

cn-shanghai
CcnInstanceIdstring

The ID of the CCN instance.

ccn-n2935s1mnwv8i*****

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "FA579C2D-84A0-4BA1-B9C3-1E5A3B15F1B6",
  "PageNumber": 1,
  "GrantRules": {
    "GrantRule": [
      {
        "CenInstanceId": "cen-0jtu0bcbika5b5****",
        "CenUid": 1250123456123456,
        "GmtCreate": 1563439920000,
        "GrantRuleId": "18313265-d988-406c-965d-3e110ff*****",
        "GrantTrafficService": false,
        "GmtModified": 1563439920000,
        "CcnUid": 1220123456123456,
        "RegionId": "cn-shanghai",
        "CcnInstanceId": "ccn-n2935s1mnwv8i*****"
      }
    ]
  }
}

Error codes

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