Queries created Smart Access Gateway instances.

Debug

Use OpenAPI Explorer to perform debug operations and generate SDK code examples.

Request parameters

Parameter Type Required? Example value Description
AclIds String No acl-xhwhyuo43l0n******

The access control list (ACL) associated with the Smart Access Gateway instance.

Action String No DescribeSmartAccessGateways

The name of this action.

Value: DescribeSmartAccessGateways.

AssociatedCcnId String No ccn-bxuau4ezctt******

The ID of the Cloud Connect Network (CCN) instance attached to the Smart Access Gateway instance.

InstanceType String No sag-100wm

The instance type.

Name String No sag

The name of the Smart Access Gateway instance.

PageNumber String No 2

The number of pages to return. Default value: 1.

PageSize String No 1

The number of rows per page. Maximum value: 50. Default value: 10.

RegionId String No cn-hangzhou

The area to which the Smart Access Gateway instance belongs.

SerialNumber String No sag32a30121

The serial number of the Smart Access Gateway instance.

SmartAGId String No sag-c3m3n1khz58l******

The ID of the Smart Access Gateway instance.

Status String No Ordered

The status of the Smart Access Gateway instance. Valid values:

  • Ordered: The Smart Access Gateway device has been ordered.
  • Delivered: The Smart Access Gateway device has been delivered.
  • Received: The Smart Access Gateway device has been received.
  • Returning: The Smart Access Gateway device is being returned.
  • ACTIVE: The Smart Access Gateway device is active.
  • Init: The Smart Access Gateway device is being initiated.
UnboundAclIds String No acl-sjfbgngj***************

The ACL is not associated with the Smart Access Gateway instance. Separate multiple IDs with commas.

Response parameters

Parameter Type Example value Description
PageNumber Integer 2

The current page number.

PageSize Integer 2

The number of entries on the current page.

RequestId String 7F26258D-8BDE-4EC4-BB4D-4DDC64F64F77

The ID of the request.

SmartAccessGateways

A list of Smart Access Gateway instances.

└AclIds String acl-shfhfhhfbnvkdg******

The ACLs associated with the Smart Access Gateway instance.

└AssociatedCcnId String ccn-bxuau4ezctts******

The ID of the CCN instance attached to the Smart Access Gateway instance.

└AssociatedCcnName String ccn

The name of the CCN instance attached to the Smart Access Gateway instance.

└CidrBlock String 192.168.0.1/24

The CIDR block used by the on-premises client for communication.

└City String Hangzhou

The city.

└CreateTime Long 1523604565000

The time when the Smart Access Gateway instance was created.

└DataPlan Long 5

Traffic contained in the data plan.

└Description String sag description

The description of the Smart Access Gateway instance.

└EndTime Long 1526227200000

The time when the Smart Access Gateway instance expires.

└HardwareVersion String sag-100wm

The instance type. Valid values: sag-1000, sag-100wm.

└MaxBandwidth String 3

The bandwidth of the Smart Access Gateway instance.

└Name String sag

The name of the Smart Access Gateway instance.

└SecurityLockThreshold Integer 3600

The threshold value set by the user for offline locking. It must be greater than or equal to 0.

Unit: seconds.

└SerialNumber String sag32a9034958a

The serial number of the Smart Access Gateway instance.

└SmartAGId String sag-v0fkpk4akfz5******

The ID of the Smart Access Gateway instance.

└SnatEntries

The SNAT entries.

└CidrBlock String 10.10.10.1

The private CIDR block.

└SnatIp String 10.10.10.5

An IP address in the SNAT CIDR block of the CCN instance. If you do not specify this parameter, the system automatically specifies an IP address.

└SoftwareVersion String 1.0.0

The software version of the Smart Access Gateway instance.

└Status String Init

The status of the Smart Access Gateway instance.

└UserCount Integer 12

The number of user accounts.

TotalCount Integer 2

The number of queried entries.

Examples

Request example


http(s)://[Endpoint]/? Action=DescribeSmartAccessGateways
&<CommonParameters>

Response examples

XML format

<DescribeSmartAccessGatewaysResponse>
  <PageNumber>1</PageNumber>
  <SmartAccessGateways>
    <SmartAccessGateway>
      <Name>Test</Name>
      <SmartAGId>sag-v0fkpk4akfz5hebved</SmartAGId>
      <Status>Init</Status>
      <AssociatedCcnName>xuehao</AssociatedCcnName>
      <AssociatedCcnId>ccn-bxuau4ezctts2kfxyr</AssociatedCcnId>
      <CreateTime>1523604565000</CreateTime>
      <EndTime>1526227200000</EndTime>
      <SoftwareVersion>1.0.0</SoftwareVersion>
      <MaxBandwidth>1M</MaxBandwidth>
    </SmartAccessGateway>
    <SmartAccessGateway>
      <Name>xuehao</Name>
      <SmartAGId>sag-c3m3n1khz58lbfhfw1</SmartAGId>
      <CidrBlock>0.0.0.0/0</CidrBlock>
      <Status>Init</Status>
      <AssociatedCcnName>TEST</AssociatedCcnName>
      <AssociatedCcnId>ccn-kygbldwikzdg2g9b8e</AssociatedCcnId>
      <CreateTime>1523597460000</CreateTime>
      <EndTime>1526227200000</EndTime>
      <SoftwareVersion>1.0.0</SoftwareVersion>
      <MaxBandwidth>3M</MaxBandwidth>
    </SmartAccessGateway>
  </SmartAccessGateways>
  <TotalCount>2</TotalCount>
  <PageSize>10</PageSize>
  <RequestId>7F26258D-8BDE-4EC4-BB4D-4DDC64F64F77</RequestId>
</DescribeSmartAccessGatewaysResponse>

JSON format

{
	"PageNumber":1,
	"TotalCount":2,
	"SmartAccessGateways":{
		"SmartAccessGateway": [
			{
				"SmartAGId": "sag-v0fkpk4akfz5hebved",
				"Name": "test",
				"SoftwareVersion": "1.0.0",
				"Status": "Init",
				"AssociatedCcnName":"xuehao",
				"AssociatedCcnId":"ccn-bxuau4ezctts2kfxyr",
				"CreateTime":1523604565000,
				"EndTime":1526227200000,
				"MaxBandwidth":"1M"
			},
			{
				"SmartAGId":"sag-c3m3n1khz58lbfhfw1",
				"Name":"xuehao",
				"SoftwareVersion":"1.0.0",
				"Status":"Init",
				"CidrBlock":"0.0.0.0/0",
				"AssociatedCcnName": "test",
				"AssociatedCcnId":"ccn-kygbldwikzdg2g9b8e",
				"CreateTime":1523597460000,
				"EndTime":1526227200000,
				"MaxBandwidth":"3M"
			}
		]
	},
	"PageSize":10,
	"RequestId":"7F26258D-8BDE-4EC4-BB4D-4DDC64F64F77"
}

Error codes

HTTP status code Error code Error message Description
403 Forbidden User not authorized to operate on the specified resource. You are not authorized to operate on this resource.

See common error codes.