All Products
Search
Document Center

Smart Access Gateway:DescribeBindableSmartAccessGateways

Last Updated:Mar 03, 2024

Queries the Smart Access Gateway (SAG) instances in a region that can be associated with 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:DescribeBindableSmartAccessGatewaysRead
  • CloudConnectNetwork
    acs:smartag:{#regionId}:{#accountId}:ccn/{#CcnId}
  • 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
CcnIdstringYes

The ID of the CCN instance.

ccn-fu75a6m4clv7ai****
CrossAccountbooleanNo

Specifies whether to query only the SAG instances that belong to another Alibaba Cloud account. Valid values:

  • false (default): no
  • true: yes
false
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
SmartAGIdstringNo

The ID of the SAG instance.

sag-00uc4vgxch1zsu****
NamestringNo

The name of the SAG instance.

The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.

sdggd111

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of SAG instances.

2
PageSizeinteger

The number of entries returned on each page.

10
RequestIdstring

The ID of the request.

9731C2F5-B9A4-42FD-AFD2-361A403E6E85
PageNumberinteger

The page number of the returned page.

1
SmartAccessGatewaysobject []

The information about the SAG instance.

SmartAGIdstring

The ID of the SAG instance.

sag-00uc4vgxch1zsu****
Namestring

The name of the SAG instance.

sdggd111
SmartAGUidlong

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

168840159596****

Examples

Sample success responses

JSONformat

{
  "TotalCount": 2,
  "PageSize": 10,
  "RequestId": "9731C2F5-B9A4-42FD-AFD2-361A403E6E85",
  "PageNumber": 1,
  "SmartAccessGateways": {
    "SmartAccessGateway": [
      {
        "SmartAGId": "sag-00uc4vgxch1zsu****",
        "Name": "sdggd111",
        "SmartAGUid": 0
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400CCN.InvalidIdYou must specify the CCN instance ID.You must specify the CCN instance ID.
400InvalidRegionIDThe specified regionId does not exist.The specified region ID does not exist.

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