You can call this operation to query Smart Access Gateway (SAG) instances that can be associated with a specific 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeBindableSmartAccessGateways

The operation that you want to perform.

Set the value to DescribeBindableSmartAccessGateways.

RegionId String Yes cn-shanghai

The ID of the region where the SAG instances are deployed.
CcnId String No ccn-fu75a6m4clv7ai****

The ID of the CCN instance.
CrossAccount Boolean No false

Specifies whether the SAG instance is under another Alibaba Cloud account. Valid values:

  • false: under the current Alibaba Cloud account.
  • true: under another Alibaba Cloud account.
PageSize Integer No 10

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

PageNumber Integer No 1

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

SmartAGId String No sag-00uc4vgxch1zsu****

The ID of the SAG instance.
Name String No sdggd111

The name of the SAG instance.

The name must be 2 to 100 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter or Chinese character.

Response parameters

Parameter Type Example Description
PageNumber Integer 1

The page number of the returned page.
PageSize Integer 10

The number of entries returned per page.
RequestId String 9731C2F5-B9A4-42FD-AFD2-361A403E6E85

The ID of the request.
SmartAccessGateways Array

The ID of the SAG instance.
SmartAccessGateway
Name String sdggd111

The name of the SAG instance.
SmartAGId String sag-00uc4vgxch1zsu****

The ID of the SAG instance.
SmartAGUid Long 1688401595963333

The UID of the Alibaba Cloud account that owns the SAG instance.
TotalCount Integer 2

The total number of SAG instances returned.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeBindableSmartAccessGateways
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format 

<DescribeBindableSmartAccessGatewaysResponse>
  <PageNumber>1</PageNumber>
  <PageSize>10</PageSize>
  <RequestId>9731C2F5-B9A4-42FD-AFD2-361A403E6E85</RequestId>
  <SmartAccessGateways>
        <SmartAccessGateway>
              <Name>zhen****-for-acl-performance-sag-154381343****</Name>
              <SmartAGId>sag-00uc4vgxch1zsu****</SmartAGId>
              <SmartAGUid>168840159596****</SmartAGUid>
        </SmartAccessGateway>
        <SmartAccessGateway>
              <Name>zhen****-for-acl-performance-sag-154383278****</Name>
              <SmartAGId>sag-0bs2aephgv7zfo****</SmartAGId>
              <SmartAGUid>168840159596****</SmartAGUid>
        </SmartAccessGateway>
  </SmartAccessGateways>
  <TotalCount>2</TotalCount>
</DescribeBindableSmartAccessGatewaysResponse>

JSON format 

{
    "PageNumber":1,
    "PageSize":10,
    "RequestId":"9731C2F5-B9A4-42FD-AFD2-361A403E6E85",
    "SmartAccessGateways":{
        "SmartAccessGateway":[
            {
                "Name":"zhen****-for-acl-performance-sag-154381343****",
                "SmartAGId":"sag-00uc4vgxch1zsu****",
                "SmartAGUid":"168840159596****"
            },
            {
                "Name":"zhen****-for-acl-performance-sag-154383278****",
                "SmartAGId":"sag-0bs2aephgv7zfo****",
                "SmartAGUid":"168840159596*****"
            }
        ]
    },
    "TotalCount":2
}

Error codes

HttpCode Error code Error message Description
400 CCN.InvalidId You must specify the CCN instance ID. The error message returned because the specified SAG instance ID does not exist.
400 InvalidRegionID The specified regionId does not exist. The error message returned because the specified region ID (RegionId) does not exist.

For a list of error codes, visit the API Error Center.