Queries 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. 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 to query only the SAG instances that cross Alibaba Cloud accounts. Default value: false. Valid values:

  • false: queries all the SAG instances no matter whether the SAG instances cross Alibaba Cloud accounts.
  • true: queries only the SAG instances that cross Alibaba Cloud accounts.
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 128 characters in length and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.

Response parameters

Parameter Type Example Description
TotalCount Integer 2

The total number of SAG instances.

PageSize Integer 10

The number of entries returned per page.

RequestId String 9731C2F5-B9A4-42FD-AFD2-361A403E6E85

The ID of the request.

PageNumber Integer 1

The page number of the returned page.

SmartAccessGateways Array of SmartAccessGateway

The list of SAG instances.

SmartAccessGateway
SmartAGId String sag-00uc4vgxch1zsu****

The ID of the SAG instance.

Name String sdggd111

The name of the SAG instance.

SmartAGUid Long 168840159596****

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

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeBindableSmartAccessGateways
&RegionId=cn-shanghai
&CcnId=ccn-fu75a6m4clv7ai****
&CrossAccount=false
&PageSize=10
&PageNumber=1
&SmartAGId=sag-00uc4vgxch1zsu****
&Name=sdggd111
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<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 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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

HTTP status code Error code Error message Description
400 CCN.InvalidId You must specify the CCN instance ID. The error message returned because the specified CCN instance ID does not exist.
400 InvalidRegionID The specified regionId does not exist. The error message returned because the specified region ID does not exist.

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