# Alibaba Cloud Smart Access Gateway API

> Alibaba Cloud Smart Access Gateway API on Apizie: 206 endpoints (Activates a Smart Access Gateway (SAG) device, Enables a flow log, Adds an access control rule, Adds a destination network address translation (DNAT) entry to a Smart Access Gateway (SAG) instance, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-smartag/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-smartag`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/smartag
- Page: https://zieapi.vercel.app/api/cloud/aliyun-smartag
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-smartag/openapi.json

Alibaba Cloud OpenAPI for Smart Access Gateway (smartag, version 2018-03-13). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Activates a Smart Access Gateway (SAG) device
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/activate-smart-access-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| SmartAGId | string | yes | The ID of the SAG instance |
| RegionId | string | yes | The region ID of the SAG instance |

### Enables a flow log
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/active-flow-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region to which the flow log belongs |
| FlowLogId | string | yes | The instance ID of the flow log |

### Adds an access control rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/add-aclrule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the access control instance. You can call the https://help.aliyun.com/document_detail/69813.html operation to query the… |
| AclId | string | yes | The instance ID of the access control instance |
| Description | string | no | The description of the access control rule. The description must be 1 to 512 characters in length |
| Direction | string | yes | The direction in which the access control rule is applied. Valid values: in: inbound. Traffic from the Internet to the local branch where… |
| SourceCidr | string | yes | The source CIDR block. The source CIDR block must be in CIDR format. Example: 192.168.1.0/24 |
| DestCidr | string | yes | The destination CIDR block. The destination CIDR block must be in CIDR format. Example: 192.168.10.0/24 |
| IpProtocol | string | yes | The protocol used by the access control rule. For the protocol types supported by the access control feature, refer to the console. The… |
| SourcePortRange | string | yes | The source port range. Valid values: -1 or 1 to 65535. The source port range is in the format of X/Y, such as 1/200 or 80/80. A value of… |
| DestPortRange | string | yes | The destination port range. Valid values: -1 or 1 to 65535. The destination port range is in the format of X/Y, such as 1/200 or 80/80. A… |
| Policy | string | yes | The authorization policy of the access control rule. Valid values: accept: Allow. drop: Deny |
| Priority | integer | no | The priority of the access control rule. A smaller value indicates a higher priority. If multiple rules have the same priority, the rule… |
| Type | string | no | The type of the access control rule. Valid values: LAN: private network. This is the default value. It specifies the Settings of access… |
| Name | string | no | The name of the access control rule. The name must be 2 to 100 characters in length, and must start with a letter or a Chinese character.… |
| DpiSignatureIds | string | no | The IDs of the applications matched by the access control rule. You can call the https://help.aliyun.com/document_detail/196630.html… |
| DpiGroupIds | string | no | The IDs of the application groups matched by the access control rule. You can call the https://help.aliyun.com/document_detail/196754.html… |

### Adds a destination network address translation (DNAT) entry to a Smart Access Gateway (SAG) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/add-dnat-entry` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the SAG instance is deployed |
| SagId | string | yes | The ID of the SAG instance. Only SAG instances used to manage SAG devices support DNAT |
| Type | string | no | The type of the DNAT entry. Valid values: Intranet: translates the destination IP address to a specific internal IP address. This is the… |
| ExternalIp | string | no | The public IP address. If the DNAT entry is used to forward packets transmitted over the Internet, the DNAT entry automatically recognizes… |
| ExternalPort | string | yes | The public port. Valid values: 1 to 65535 |
| InternalIp | string | yes | The destination private IP address |
| IpProtocol | string | yes | The protocol used in DNAT. Valid values: TCP: forwards TCP packets. UDP: The NAT gateway forwards UDP packets. Any: forwards packets of… |
| InternalPort | string | yes | The destination private port. Valid values: 1 to 65535 |

### Adds DNS forwarding configurations to an SCG5000 or SCG5000-5G instance. The device version must be 3.4.2 or…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/add-smart-access-gateway-dns-forward` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| SagInsId | string | yes | The ID of the instance |
| SagSn | string | yes | The serial number (SN) of the device |
| Domain | string | yes | The domain name. Wildcard domain names are supported. You can use the wildcard character asterisk (*) to specify a wildcard domain name.… |
| MasterIp | string | yes | The primary DNS server |
| SlaveIp | string | no | The secondary DNS server |
| Mode | string | no | The forwarding mode. This parameter is not in use. Ignore this parameter |
| OutboundPortType | string | no | The type of the egress port. A value of Tunnel specifies a tunnel, and a value of PhysicalPort specifies a physical port |
| OutboundPortIndex | string | no | The number of the egress port. This parameter is optional if OutboundPortType is set to PhysicalPort. Ignore this parameter if… |
| OutboundPortName | string | no | The egress port. This parameter is optional if OutboundPortType is set to PhysicalPort. Ignore this parameter if OutboundPortType is set… |
| RegionId | string | yes | The ID of the region where the instance is deployed |

### Adds a source network address translation (SNAT) entry to a Smart Access Gateway (SAG) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/add-snat-entry` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the SAG instance is deployed |
| SmartAGId | string | yes | The ID of the SAG instance |
| CidrBlock | string | yes | The destination CIDR block |
| SnatIp | string | yes | The public IP address |

### Associates an access control list (ACL) with a Smart Access Gateway (SAG) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/associate-acl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the ACL is created. You can call the https://help.aliyun.com/document_detail/69813.html operation to query the… |
| AclId | string | yes | The ID of ACL |
| SmartAGId | string | yes | The ID of the SAG instance to be associated with the ACL |

### Associates a Smart Access Gateway instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/associate-flow-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the flow log |
| FlowLogId | string | yes | The flow log instance ID |
| SmartAGId | string | yes | The Smart Access Gateway instance ID |

### Applies a Quality of Service (QoS) policy to a Smart Access Gateway (SAG) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/associate-qos` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region to which the QoS policy belongs |
| QosId | string | yes | The instance ID of the QoS policy |
| SmartAGId | string | yes | The ID of the SAG instance to which the QoS policy is to be applied |

### Associates a bandwidth plan for application acceleration with a Smart Access Gateway (SAG) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/associate-smart-agwith-application-bandwidth-package` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| DryRun | string | no | Specifies whether to precheck the request. Check items include permissions and the status of the specified cloud resources. Valid values:… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make… |
| RegionId | string | yes | The region ID of the bandwidth plan for application acceleration. You can call the https://help.aliyun.com/document_detail/36063.html… |
| ApplicationBandwidthPackageId | string | yes | The ID of the bandwidth plan for application acceleration |
| AssociateConfigs | string | yes | The configuration of application acceleration (JSON-encoded) |

### Associates a Cloud Connect Network (CCN) instance with a Cloud Enterprise Network (CEN) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/attach-ccn-instance-to-cen` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| CcnId | string | no | The ID of the Cloud Connect Network (CCN) instance to attach |
| CenId | string | no | The ID of the CEN instance to authorize |
| RegionId | string | no | The region ID of the Cloud Connect Network (CCN) instance. You can invoke the DescribeRegions operation to query the regions supported by… |
| Subnet | string | no | The CIDR block used when the Cloud Connect Network (CCN) instance is attached to the CEN instance over the Internet |

### Binds a Smart Access Gateway device to a Smart Access Gateway instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/bind-serial-number` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the Smart Access Gateway instance |
| SmartAGId | string | yes | The instance ID of the Smart Access Gateway |
| SerialNumber | string | yes | The serial number of the Smart Access Gateway device |

### Binds a Smart Access Gateway to a specified Cloud Connect Network (CCN)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/bind-smart-access-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| CcnId | string | yes | The ID of the Cloud Connect Network (CCN) to bind |
| SmartAGId | string | yes | The ID of the Smart Access Gateway |
| RegionId | string | no | The region ID of the Smart Access Gateway |
| SmartAGUid | integer | no | The user ID of the Smart Access Gateway instance |

### Binds a virtual border router (VBR) to a Smart Access Gateway instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/bind-vbr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the Smart Access Gateway instance |
| SmartAGId | string | yes | The instance ID of the Smart Access Gateway instance |
| VbrId | string | yes | The instance ID of the virtual border routing instance to bind |
| VbrRegionId | string | yes | The region ID of the virtual border router (VBR) to bind |
| SmartAGUid | integer | no | The Alibaba Cloud account ID that owns the Smart Access Gateway instance |

### Resets the password of a virtual customer-premises equipment (vCPE) device of Smart Access Gateway (SAG)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/clear-sag-cipher` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the SAG instance is deployed |
| SagId | string | yes | The ID of the SAG instance |
| SnNumber | string | yes | The serial number of the SAG vCPE device |

### Purges the routable addresses of a Smart Access Gateway instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/clear-sag-routeable-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID of the Smart Access Gateway instance |
| SagId | string | yes | The instance ID of the Smart Access Gateway instance |

### Creates an access control instance by calling the CreateACL operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/create-acl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the access control instance. You can call the https://help.aliyun.com/document_detail/69813.html operation to query… |
| Name | string | yes | The name of the access control instance. The name must be 2 to 128 characters in length and must start with a letter or a Chinese… |
| AclType | string | no | The type of the Smart Access Gateway instance to be associated with the access control instance. Valid values: acl-hardware (default):… |

### Calls the CreateCloudConnectNetwork operation to create a Cloud Connect Network (CCN) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/create-cloud-connect-network` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID of the Cloud Connect Network (CCN) instance |
| Name | string | no | The name of the Cloud Connect Network (CCN) instance. The name must be 2 to 100 characters in length and must start with a letter or a… |
| Description | string | no | The description of the Cloud Connect Network (CCN) instance. The description must be 2 to 128 characters in length and must start with a… |
| CidrBlock | string | no | The private CIDR block |
| SnatCidrBlock | string | no | The SNAT private CIDR block |

### Creates an enterprise code by calling CreateEnterpriseCode
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/create-enterprise-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/69813.html to query the regions supported by Smart Access Gateway and… |
| EnterpriseCode | string | yes | The enterprise code. The enterprise code must be 5 characters in length and contain both letters and digits. The letters can be uppercase… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |

### Creates a flow log
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/create-flow-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region to which the flow log belongs. You can call the https://help.aliyun.com/document_detail/36063.html operation to query… |
| Description | string | no | The description of the flow log |
| Name | string | no | The name of the flow log |
| ActiveAging | integer | no | The output interval under active connections. Valid values: 60 to 6000. Unit: seconds. Default value: 300 |
| InactiveAging | integer | no | The output interval under inactive connections. Valid values: 10 to 600. Unit: seconds. Default value: 15 |
| OutputType | string | no | The type of the flow log. Valid values: sls: The flow log is stored in Log Service. netflow: The flow log is stored on a NetFlow… |
| SlsRegionId | string | no | The ID of the region where Log Service is deployed. If OutputType is set to sls or all, this parameter is required |
| ProjectName | string | no | The project in Log Service. If OutputType is set to sls or all, this parameter is required |
| LogstoreName | string | no | The Logstore in Log Service. If OutputType is set to sls or all, this parameter is required |
| NetflowServerIp | string | no | The IP address of the NetFlow collector where the flow log is stored. If OutputType is set to netflow or all, this parameter is required |
| NetflowServerPort | integer | no | The port number of the NetFlow collector where the flow log is stored. Default value: 9995. If OutputType is set to netflow or all, this… |
| NetflowVersion | string | no | The version of the NetFlow collector where the flow log is stored. Valid values: V5, V9, and V10. Default value: V9. If OutputType is set… |

### Calls CreateHealthCheck to create a health check for a Smart Access Gateway instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/create-health-check` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the Smart Access Gateway instance is deployed |
| SmartAGId | string | yes | The ID of the Smart Access Gateway instance |
| Name | string | yes | The name of the health check instance. The name must be 2 to 100 characters in length, and must start with a letter or a Chinese… |
| Description | string | no | The description of the health check instance. The description must be 2 to 256 characters in length, and must start with a letter or a… |
| Type | string | yes | The type of health check packets. Only ICMP_ECHO is supported |
| DstIpAddr | string | yes | The destination IP address of the health check |
| DstPort | integer | no | The destination port of the health check. This feature is currently not supported |
| SrcIpAddr | string | yes | The source IP address of the health check instance |
| SrcPort | integer | no | The source port of the health check. This feature is currently not supported |
| ProbeInterval | integer | no | The interval between health check probes. The next probe will not be initiated until the current probe is complete. Valid values: 1000 to… |
| ProbeCount | integer | no | The number of probes per health check. Valid values: 1 to 20. Default value: 1 |
| ProbeTimeout | integer | no | The timeout period for a single probe. Valid values: 10 to 30000. Default value: 1000. Unit: milliseconds |
| RttThreshold | integer | no | The round-trip time (RTT) threshold. Valid values: -1 or 1 to 5000. Default value: -1, which indicates that no RTT threshold is set. Unit:… |
| RttFailThreshold | integer | no | The number of times that the RTT threshold can be reached. Valid values: 1 to 15. Default value: 3 |
| FailCountThreshold | integer | no | The threshold for the number of consecutive probe failures. Valid values: 1 to 15. Default value: 3 |

### Creates a probe task for a specified Smart Access Gateway device
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/create-probe-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the Smart Access Gateway instance. You can call the https://help.aliyun.com/document_detail/69813.html operation to query… |
| SagId | string | yes | The instance ID of the Smart Access Gateway |
| Sn | string | yes | The serial number of the Smart Access Gateway device |
| TaskName | string | no | The name of the probe task |
| Type | string | yes | The type of the probe task. Valid values: Internet: public network probe. Intranet: private network probe |
| Protocol | string | yes | The protocol of the probe task. Valid values: ICMP. TCP. HTTP. Private network probes support only the ICMP and TCP protocols |
| Domain | string | yes | The destination domain name of the probe node. For ICMP and TCP Protocol Type probes, set this parameter to the IP address or domain name… |
| Port | integer | no | The port number of the probe protocol. This parameter is required for TCP Protocol Type probe tasks. Do not specify this parameter for… |
| PacketNumber | integer | no | The number of packets sent per minute for the probe protocol. Valid values: 1 to 60. This parameter is required for ICMP Protocol Type… |
| ProbeTaskSourceAddress | string | no | The source address for the private network probe. This parameter is required for private network probe tasks |
| Enable | string | yes | Specifies whether to enable the probe task. Valid values: true: Enabled. false: Disabled |

### Creates a quality of service (QoS) policy instance by calling the CreateQos operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/create-qos` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the QoS policy instance |
| QosName | string | yes | The name of the QoS policy instance. The name must be 2 to 100 characters in length and must start with a letter or a Chinese character.… |
| QosDescription | string | no | The description of the QoS policy instance. The description must be 1 to 512 characters in length and must start with a letter or a… |

### Creates a rate limiting rule for a quality of service (QoS) policy by calling the CreateQosCar operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/create-qos-car` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| Description | string | no | The description of the QoS rate limiting rule |
| RegionId | string | yes | The region ID of the QoS policy instance. You can call the https://help.aliyun.com/document_detail/69813.html operation to query region IDs |
| QosId | string | yes | The instance ID of the QoS policy |
| Priority | integer | yes | The priority of the rate limiting rule. Valid values: 1 to 3. A smaller value indicates a higher priority. If two rules have the same… |
| LimitType | string | yes | The type of rate limiting. Valid values: Absolute: by bandwidth value. Percent: by percentage |
| MinBandwidthAbs | integer | no | The minimum bandwidth value. The value must be an integer. Unit: Mbit/s. This parameter is required when LimitType is set to Absolute |
| MaxBandwidthAbs | integer | no | The maximum bandwidth value. The value must be an integer. Unit: Mbit/s. This parameter is required when LimitType is set to Absolute. The… |
| MinBandwidthPercent | integer | no | The minimum bandwidth percentage. Unit: percent (%). Valid values: 1 to 100. This parameter is required when LimitType is set to Percent |
| MaxBandwidthPercent | integer | no | The maximum bandwidth percentage. Unit: percent (%). Valid values: 1 to 100. This parameter is required when LimitType is set to Percent.… |
| PercentSourceType | string | no | The bandwidth type when rate limiting by percentage. Valid values: CcnBandwidth: CCN bandwidth. InternetUpBandwidth: total Internet… |
| Name | string | no | The name of the QoS rate limiting rule. The name must be 2 to 128 characters in length and must start with a letter or a Chinese… |

### Creates a traffic classification rule for a quality of service (QoS) policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/create-qos-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| Description | string | no | The description of the traffic classification rule for the QoS policy. The description must be 1 to 512 characters in length, and can… |
| RegionId | string | yes | The ID of the region where the QoS policy instance resides |
| QosId | string | yes | The instance ID of the QoS policy |
| Priority | integer | yes | The priority of the bandwidth throttling rule to which the traffic classification rule for the QoS policy belongs. Valid values: 1 to 3. A… |
| SourceCidr | string | yes | The source CIDR block. The source CIDR block must be in CIDR format. Example: 192.168.1.0/24 |
| DestCidr | string | yes | The destination CIDR block. The destination CIDR block must be in CIDR format. Example: 192.168.10.0/24 |
| IpProtocol | string | yes | The protocol type applied to the traffic classification rule for the QoS policy. For information about the protocol types supported by the… |
| SourcePortRange | string | yes | The source port range. Valid values: -1 or 1 to 65535. Examples of the source port range format: 1/200: indicates ports 1 to 200. 80/80:… |
| DestPortRange | string | yes | The destination port range. Valid values: -1 or 1 to 65535. Examples of the destination port range format: 1/200: indicates ports 1 to… |
| StartTime | string | no | The start time of the effective period for the traffic categorization rule of the QoS policy. Specify the time in the ISO 8601 standard in… |
| EndTime | string | no | The time when the traffic classification rule for the QoS policy expires. Specify the time in the ISO 8601 standard in the… |
| Name | string | no | The name of the traffic classification rule for the QoS policy. The name must be 2 to 100 characters in length, and can contain digits,… |
| DpiSignatureIds | string | no | The list of application IDs (JSON-encoded) |
| DpiGroupIds | string | no | The list of application group IDs (JSON-encoded) |

### Creates a subinterface for an Express Connect circuit
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/create-sag-express-connect-interface` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the Smart Access Gateway (SAG) instance is deployed |
| SmartAGId | string | yes | The ID of the SAG instance |
| SmartAGSn | string | yes | The serial number of the SAG device associated with the SAG instance |
| PortName | string | yes | The name of the Express Connect port |
| Vlan | string | no | The VLAN ID of the subinterface. Value: 0 to 4094. If the VLAN ID is 0, this port is a physical port and does not support VLAN… |
| IP | string | yes | The IP address |
| Mask | string | yes | The subnet mask of the IP address |

### Adds a static route to a Smart Access Gateway (SAG) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/create-sag-static-route` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the SAG instance is deployed |
| SmartAGId | string | yes | The ID of the SAG instance |
| SmartAGSn | string | yes | The serial number of the SAG device associated with the SAG instance |
| PortName | string | yes | The name of the port |
| DestinationCidr | string | yes | The destination CIDR block |
| NextHop | string | yes | Enter the IP address of the next hop |
| Vlan | string | no | The VLAN ID. Valid values: 0 indicates a physical port. 1 to 4094 indicates that VLANs are supported |

### Configures a service address for a specified Smart Access Gateway device
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/create-service-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the Smart Access Gateway instance. You can call the https://help.aliyun.com/document_detail/69813.html operation to query… |
| AddressType | string | yes | The service address type of the Smart Access Gateway instance. Set the value to ProbeTask |
| Address | string | yes | The service address of the Smart Access Gateway instance. Example: 192.168.1.1 |
| SagId | string | yes | The instance ID of the Smart Access Gateway instance |
| Sn | string | yes | The serial number of the Smart Access Gateway device |

### Creates a Smart Access Gateway (SAG) CPE or vCPE instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/create-smart-access-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where you want to deploy the SAG instance. You can call the https://help.aliyun.com/document_detail/36063.html… |
| MaxBandWidth | integer | no | The bandwidth of the SAG instance. If you want to create an SAG CPE instance and the model is sag-100wm, valid values of this parameter… |
| Name | string | no | The name of the SAG instance. The name must be 2 to 128 characters in length and can contain digits, periods (.), underscores (_), and… |
| Description | string | no | The description of the SAG instance. The description must be 2 to 256 characters in length, and can contain digits, periods (.),… |
| Period | integer | yes | The subscription period of the SAG instance. Unit: months. Valid values: 1 to 9, 12, 24, and 36 |
| AutoPay | string | yes | Specifies whether to enable auto-payment for the instance. Valid values: true: yes false: no If you set the parameter to false, go to… |
| HardWareSpec | string | yes | The type of the SAG instance. Valid values: sag-100wm sag-1000 sag-vcpe |
| ReceiverCountry | string | yes | The country of the recipient address |
| ReceiverState | string | yes | The province of the recipient address |
| ReceiverCity | string | yes | The city of the recipient address |
| ReceiverDistrict | string | yes | The district of the recipient address |
| ReceiverTown | string | yes | The town of the recipient address |
| ReceiverZip | string | yes | The postcode of the recipient address |
| ReceiverPhone | string | no | The landline phone number of the recipient |
| ReceiverMobile | string | yes | The mobile phone number of the recipient |
| ReceiverName | string | yes | The name of the recipient |
| ReceiverEmail | string | yes | The email address of the recipient |
| BuyerMessage | string | yes | The remarks left by the buyer |
| ReceiverAddress | string | yes | The detailed address of the recipient |
| HaType | string | yes | The deployment mode. Valid values: no_backup: You buy only one SAG device to connect private networks to Alibaba Cloud. cold_backup: You… |
| ChargeType | string | yes | The billing method of the SAG instance. Set the value to PREPAY, which specifies the subscription billing method |
| AlreadyHaveSag | string | no | Specifies whether you already have an SAG device. Valid values: true: yes false (default): no |
| CPEVersion | string | no | The edition of SAG when you create an SAG vCPE instance. Set the value to basic, which specifies Basic Edition |

### Creates a client account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/create-smart-access-gateway-client-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the Smart Access Gateway (SAG) app instance |
| SmartAGId | string | yes | The ID of the SAG app instance |
| UserName | string | no | The username of the client account. The usernames of client accounts added to the same SAG app instance must be unique. The username must… |
| ClientIp | string | no | If you enable the client app service, you must set the IP address of the client app. The current client account uses the specified IP… |
| UserMail | string | yes | The email address of the client account. The username and password are sent to the specified email address by the administrator |
| Bandwidth | integer | yes | The maximum bandwidth value. Unit: Kbit/s. Valid values: 1 to 20000. Default value: 2000 |
| Password | string | no | The password that is used to log on to the SAG app. The password must be 8 to 32 characters in length. It can contain letters, digits,… |

### Creates a Smart Access Gateway (SAG) app instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/create-smart-access-gateway-software` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where you want to create the SAG app instance |
| Period | integer | yes | The subscription duration of the SAG app instance. Unit: months. Valid values: 1 to 9, 12, 24, and 36 |
| AutoPay | string | yes | Specifies whether to automatically complete the payment of the order. Valid values: true: yes false (default): no If you set the parameter… |
| ChargeType | string | yes | The billing method of the SAG app instance. Set the value to PREPAY. This value indicates that the SAG app instance is a subscription… |
| UserCount | integer | yes | The maximum number of client accounts that can be created on the SAG app instance |
| DataPlan | integer | yes | The size of the free data plan that is allocated to each client account per month. Unit: GB. Valid value: 5. This value specifies that a… |

### Stops a flow log
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/deactive-flow-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region to which the flow log belongs |
| FlowLogId | string | yes | The instance ID of the flow log |

### Deletes an access control list (ACL)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/delete-acl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region |
| AclId | string | yes | The ID of the ACL |

### Deletes a rule from an ACL
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/delete-aclrule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region to which the ACL rule to be deleted belongs |
| AclId | string | yes | The ID of the ACL to which the ACL rule to be deleted belongs |
| AcrId | string | yes | The ID of the ACL rule to be deleted |

### Deletes a Cloud Connect Network (CCN) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/delete-cloud-connect-network` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| CcnId | string | yes | The ID of the CCN instance |
| RegionId | string | no | The ID of the region where the CCN instance is deployed |

### Removes a DNAT entry from a Smart Access Gateway (SAG) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/delete-dnat-entry` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the SAG instance is deployed. You can call the https://help.aliyun.com/document_detail/36063.html operation to… |
| SagId | string | yes | The ID of the SAG instance. Only SAG instances used to manage SAG devices support DNAT |
| DnatEntryId | string | yes | The ID of the DNAT entry |

### Deletes a specified enterprise code by calling DeleteEnterpriseCode
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/delete-enterprise-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. You can call https://help.aliyun.com/document_detail/69813.html to query the regions supported by Smart Access Gateway and… |
| EnterpriseCode | string | yes | The enterprise code |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. The client generates the value of this parameter. Ensure that the… |

### Deletes a flow log
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/delete-flow-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region to which the flow log belongs |
| FlowLogId | string | yes | The instance ID of the flow log |

### Deletes a health check instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/delete-health-check` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the health check instance |
| HcInstanceId | string | yes | The health check instance ID |

### Deletes a probe task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/delete-probe-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the Smart Access Gateway (SAG) instance. You can call the https://help.aliyun.com/document_detail/69813.html operation to… |
| SagId | string | yes | The ID of the SAG instance |
| Sn | string | yes | The serial number of the SAG device |
| ProbeTaskId | string | yes | The ID of the probe task |

### Deletes a Quality of Service (QoS) policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/delete-qos` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region to which the QoS policy belongs |
| QosId | string | yes | The instance ID of the QoS policy to be deleted |

### Deletes a QoS car (bandwidth throttling rule) by calling the DeleteQosCar operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/delete-qos-car` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the quality of service (QoS) policy instance |
| QosId | string | yes | The instance ID of the QoS policy |
| QosCarId | string | yes | The instance ID of the QoS bandwidth throttling rule |

### Deletes a quintuple rule of a Quality of Service (QoS) policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/delete-qos-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region to which the QoS policy belongs |
| QosId | string | yes | The instance ID of the QoS policy |
| QosPolicyId | string | yes | The ID of the quintuple rule |

### Deletes a route advertisement policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/delete-route-distribution-strategy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the Smart Access Gateway (SAG) instance is deployed |
| SmartAGId | string | yes | The ID of the SAG instance |
| DestCidrBlock | string | yes | The destination CIDR block |
| SourceType | string | yes | The type of the route source. Valid values: cloud: Alibaba Cloud local: on-premises network |
| RouteSource | string | yes | The source of routes. Valid values: Alibaba Cloud * Virtual private cloud (VPC) IDs: Routes that are learned from VPCs. * Virtual border… |

### Deletes a subinterface from a leased line port
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/delete-sag-express-connect-interface` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the Smart Access Gateway (SAG) instance is deployed. You can call the… |
| SmartAGId | string | yes | The ID of the SAG instance |
| SmartAGSn | string | yes | The serial number of the SAG device associated with the SAG instance |
| PortName | string | yes | The name of the leased line port |
| Vlan | string | no | The VLAN ID of the leased line port. Valid values: 0 to 4094. If the VLAN ID is 0, the leased line port is a physical port and does not… |

### Deletes a static route
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/delete-sag-static-route` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the SAG app instance is deployed |
| SmartAGId | string | yes | The ID of the SAG app instance |
| SmartAGSn | string | yes | The serial number of the SAG device associated with the SAG instance |
| PortName | string | yes | The name of the port |
| DestinationCidr | string | yes | The destination CIDR block |
| Vlan | string | no | The VLAN ID. Valid values: 0 (physical port) and 1 to 4094 (VLAN) |

### Deletes a service address configured on a Smart Access Gateway device
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/delete-service-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the Smart Access Gateway instance is deployed. You can call the… |
| AddressType | string | yes | The type of the service address for the Smart Access Gateway instance. Set the value to ProbeTask |
| Address | string | yes | The service address of the Smart Access Gateway instance. Example: 192.168.1.1 |
| SagId | string | yes | The instance ID of the Smart Access Gateway instance |
| Sn | string | yes | The serial number of the Smart Access Gateway device |

### Deletes a Smart Access Gateway (SAG) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/delete-smart-access-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The ID of the region where the SAG instance is deployed |
| InstanceId | string | yes | The ID of the SAG instance that you want to delete |

### Deletes a client account from a Smart Access Gateway (SAG) app instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/delete-smart-access-gateway-client-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the SAG app instance is deployed |
| SmartAGId | string | yes | The ID of the SAG app instance |
| UserName | string | yes | The username of the client account |

### Deletes a DNS forwarding rule. This operation is applicable only to Smart Access Gateway (SAG) instances…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/delete-smart-access-gateway-dns-forward` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| SagInsId | string | yes | The ID of the SAG instance |
| SagSn | string | yes | The serial number (SN) of the device |
| InstanceId | string | yes | The ID of the DNS forwarding rule |
| RegionId | string | yes | The ID of the region where the SAG instance is deployed |

### Removes an SNAT entry from a Smart Access Gateway (SAG) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/delete-snat-entry` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region to which the SAG instance belongs |
| SmartAGId | string | yes | The ID of the SAG instance |
| InstanceId | string | yes | The ID of the SNAT entry |

### Queries the details of a specified access control instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-aclattribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the access control instance |
| AclId | string | yes | The ID of the access control instance |
| PageSize | integer | no | The number of access control rule entries to return on each page in a paging query. Valid values: 1 to 50. Default value: 10 |
| PageNumber | integer | no | The page number for a paging query. Default value: 1 |
| Direction | string | no | The direction in which the access control rule is applied. Valid values: in: inbound, which indicates traffic from external networks to… |
| Order | string | no | The order ID |
| Name | string | no | The name of the access control instance. The name must be 2 to 100 characters in length, and can contain digits, periods (.), underscores… |

### Calls DescribeACLs to query the information about access control instances in a specified region
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-acls` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the access control instance |
| AclIds | string | no | The access control instance ID. To query multiple access control instances simultaneously, separate multiple instance IDs with commas (,).… |
| Name | string | no | The name of the access control instance. The name must be 2 to 100 characters in length and must start with an uppercase letter, lowercase… |
| PageSize | integer | no | The number of entries per page for a paginated query. Maximum value: 50. Default value: 10 |
| PageNumber | integer | no | The page number. Default value: 1 |
| AclType | string | no | The type of Smart Access Gateway (SAG) instance that the access control instance can be associated with. Valid values: acl-hardware: SAG… |

### Queries the Smart Access Gateway (SAG) instances in a region that can be associated with a Cloud Connect…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-bindable-smart-access-gateways` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the SAG instance is deployed |
| CcnId | string | yes | The ID of the CCN instance |
| CrossAccount | string | no | Specifies whether to query only the SAG instances that belong to another Alibaba Cloud account. Valid values: false (default): no true: yes |
| PageSize | integer | no | The number of entries to return on each page. Default value: 10. Maximum value: 50 |
| PageNumber | integer | no | The number of the page to return. Default value: 1 |
| SmartAGId | string | no | The ID of the SAG instance |
| Name | string | no | The name of the SAG instance. The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and… |

### Invokes DescribeClientUserDNS to query the DNS configuration of a Smart Access Gateway app instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-client-user-dns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the Smart Access Gateway app instance |
| SmartAGId | string | yes | The instance ID of the Smart Access Gateway app instance |

### Queries information about Cloud Connect Network (CCN) instances created in a specified region
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-cloud-connect-networks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the Cloud Connect Network (CCN) instance |
| Name | string | no | The name of the Cloud Connect Network (CCN) instance. The name must be 2 to 100 characters in length and must start with a letter or a… |
| CcnId | string | no | The instance ID of the Cloud Connect Network (CCN) |
| PageSize | integer | no | The number of entries per page in a paged query. Default value: 10. Maximum value: 50 |
| PageNumber | integer | no | The page number. Default value: 1 |
| Tag | string | no | The labels used to filter Cloud Connect Network (CCN) instances (JSON-encoded) |

### Queries the automatic upgrade policy of a Smart Access Gateway (SAG) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-device-auto-upgrade-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the SAG instance |
| SmartAGId | string | yes | The ID of the SAG instance |
| SerialNumber | string | yes | The serial number of the SAG instance |
| VersionType | string | no | The type of the software for which you want to query the automatic upgrade policy. Valid values: Device: The operating system that is run… |

### Queries DNAT entries that are associated with a Smart Access Gateway (SAG) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-dnat-entries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the SAG instance |
| SagId | string | yes | The ID of the SAG instance. Only SAG customer-premises equipment (CPE) instances are supported |
| Type | string | no | The type of the DNAT entry. Valid values: Intranet: translates the IP address to a specific internal IP address. This is the default… |
| PageSize | integer | no | The number of entries to return on each page. Default value: 10. Maximum value: 50 |
| PageNumber | integer | no | The number of the page to return. Default value: 1 |

### Queries the Smart Access Gateway instances associated with a flow log by calling DescribeFlowLogSags
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-flow-log-sags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the flow log |
| FlowLogId | string | no | The flow log instance ID |
| PageSize | integer | no | The number of entries per page in a paged query. Maximum value: 50. Default value: 10 |
| PageNumber | integer | no | The page number of the query list. Minimum value: 1. Default value: 1 |

### Queries flow logs in a specified region
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-flow-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region that the flow logs are stored |
| FlowLogId | string | no | The ID of a flow log |
| FlowLogName | string | no | The name of the flow log |
| Description | string | no | The description of the flow log |
| Status | string | no | The status of the flow log. Valid values: Active: The flow log is enabled. Inactive: The flow log is disabled |
| OutputType | string | no | The location where the flow log is stored. Valid values: sls: The flow log is stored in Log Service. netflow: The flow log is stored on a… |
| PageSize | integer | no | The number of entries to return on each page. Default value: 10 |
| PageNumber | integer | no | The number of the page to return. Default value: 1 |

### Queries the authorization information about a Cloud Connect Network (CCN) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-grant-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the CCN instance is deployed |
| AssociatedCcnId | string | no | The ID of the CCN instance |
| PageSize | integer | no | The number of entries to return on each page. Default value: 10. Maximum value: 50 |
| PageNumber | integer | no | The number of the page to return. Default value: 1 |

### Queries the permission information about a Smart Access Gateway (SAG) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-grant-sag-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the SAG instance is deployed |
| SmartAGId | string | yes | The ID of the SAG instance |
| PageNumber | integer | no | The page number of the returned page. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Default value: 10. Maximum value: 50 |

### Queries authorization information about Smart Access Gateway (SAG) instances and cross-account virtual…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-grant-sag-vbr-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the SAG instance is deployed |
| SmartAGId | string | no | The ID of the SAG instance |
| VbrInstanceId | string | no | The ID of the VBR |
| PageNumber | integer | no | The number of the page to return. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Default value:10 |

### Queries the detailed information about a health check instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-health-check-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the Smart Access Gateway (SAG) instance |
| HcInstanceId | string | yes | The ID of the health check instance |
| SmartAGId | string | yes | The ID of the SAG instance |

### Queries health checks that are associated with a Smart Access Gateway (SAG) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-health-checks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the SAG instance |
| SmartAGId | string | yes | The ID of the SAG instance |
| HcInstanceId | string | no | The ID of the health check |
| Name | string | no | The name of the health check. The name must be 2 to 100 characters in length, and can contain letters, digits, periods (.), underscores… |
| PageNumber | integer | no | The number of the page to return. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Default value: 10. Maximum value: 50 |

### Queries traffic throttling rules of a quality of service (QoS) policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-qos-cars` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the QoS policy is created. You can call the https://help.aliyun.com/document_detail/36063.html operation to… |
| QosId | string | yes | The ID of the QoS policy |
| QosCarId | string | no | The ID of the traffic throttling rule |
| Order | string | no | The sorting method of the traffic throttling rules. Valid values: asc: sorted in ascending order. This is the default value. desc: sorted… |
| Description | string | no | The description of the traffic throttling rule |
| PageSize | integer | no | The number of entries to return per page. Valid values: 1 to 50. Default value: 10 |
| PageNumber | integer | no | The number of the page to return. Default value: 1 |

### You can call the DescribeQosPolicies operation to query the quintuple rule configurations for a Quality of…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-qos-policies` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the QoS policy instance resides |
| QosId | string | yes | The ID of the QoS policy instance |
| QosPolicyId | string | no | The ID of the quintuple rule instance in the QoS policy |
| Description | string | no | The description of the quintuple rule instance in the QoS policy. The description must be 1 to 512 characters in length, start with a… |
| PageSize | integer | no | The number of quintuple rules to return on each page. The default value is 10. The maximum value is 50 |
| PageNumber | integer | no | The page number. The default value is 1 |
| Priority | integer | no | The priority of the throttling rule to which the quintuple rule in the QoS policy belongs. The priority range is 1 to 3. A smaller value… |

### Queries quality of service (QoS) policies in a specified region
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-qoses` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the QoS policy is deployed |
| QosIds | string | no | The ID of the QoS policy. Separate multiple QoS polices with commas (,). If you do not specify this parameter, all QoS policies in the… |
| QosName | string | no | The name of the QoS policy. The name must be 2 to 100 characters in length and can contain letters, digits, periods (.), underscores… |
| PageSize | integer | no | The number of entries to return on each page. Default value: 10. Maximum value: 50 |
| PageNumber | integer | no | The number of the page to return. Default value: 1 |

### Queries available regions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| AcceptLanguage | string | no | The language of the response. Valid values: zh-CN (default): Chinese en-US: English ja: Japanese |

### Queries route advertisement policies
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-route-distribution-strategies` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the Smart Access Gateway (SAG) instance is deployed |
| SmartAGId | string | yes | The ID of the SAG instance |
| SourceType | string | yes | The type of route. Valid values: cloud: Alibaba Cloud-facing routes. These routes allow SAG instances to access resources deployed on… |
| PageNumber | integer | no | The number of the page to return. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Default value: 10 |

### Queries information about a Smart Access Gateway device by calling the DescribeSAGDeviceInfo operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-sagdevice-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the Smart Access Gateway instance is deployed. You can call the… |
| SmartAGId | string | yes | The instance ID of the Smart Access Gateway |
| SmartAGSn | string | yes | The serial number of the associated Smart Access Gateway device |

### Queries the DNS settings that are currently in effect on a Smart Access Gateway device
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-sag-current-dns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the Smart Access Gateway instance |
| SmartAGId | string | yes | The instance ID of the Smart Access Gateway instance |
| SmartAGSn | string | yes | The serial number of the Smart Access Gateway device that is associated with the instance |

### Queries the top 10 Smart Access Gateway instances with the highest packet loss rate in a specified region
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-sag-drop-top-n` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the Smart Access Gateway instance |
| Size | integer | no | The number of Smart Access Gateway instances to query. Default value: 10. This value cannot be modified |

### Queries the sub-interfaces of a dedicated connection port by calling DescribeSagExpressConnectInterfaceList
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-sag-express-connect-interface-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the Smart Access Gateway instance. You can call https://help.aliyun.com/document_detail/69813.html to query the regions… |
| SmartAGId | string | yes | The instance ID of the Smart Access Gateway instance |
| SmartAGSn | string | yes | The serial number of the associated Smart Access Gateway device |
| PortName | string | yes | The name of the dedicated connection port |

### Queries the global routing protocol
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-sag-global-route-protocol` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the Smart Access Gateway (SAG) instance is deployed |
| SmartAGId | string | yes | The ID of the SAG instance |
| SmartAGSn | string | yes | The serial number of the SAG device associated with the SAG instance |

### Queries the high-availability configuration of a Smart Access Gateway instance by calling DescribeSagHa
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-sag-ha` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the Smart Access Gateway instance |
| SmartAGId | string | yes | The instance ID of the Smart Access Gateway instance |
| SmartAGSn | string | yes | The serial number of the associated Smart Access Gateway device |

### Queries the LAN port settings of a Smart Access Gateway (SAG) device
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-sag-lan-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the SAG instance is deployed |
| SmartAGId | string | yes | The ID of the SAG instance |
| SmartAGSn | string | yes | The serial number of the SAG device associated with the SAG instance |

### Queries the management port settings of a Smart Access Gateway (SAG) device
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-sag-management-port` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the SAG instance is deployed |
| SmartAGId | string | yes | The ID of the SAG instance |
| SmartAGSn | string | yes | The serial number of the SAG device |

### Queries online client statistics for Smart Access Gateway (SAG) app instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-sag-online-client-statistics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the SAG app instance |
| SmartAGIds | string | no | The IDs of the SAG app instances. The list can contain up to 50 instance IDs (JSON-encoded) |

### Queries the information about a physical port
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-sag-port-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the Smart Access Gateway (SAG) instance is deployed |
| SmartAGId | string | yes | The ID of the SAG instance |
| SmartAGSn | string | yes | The serial number of the SAG device associated with the SAG instance |

### Invokes DescribeSagPortRouteProtocolList to obtain the list of ports on which routing protocols are enabled
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-sag-port-route-protocol-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the Smart Access Gateway instance |
| SmartAGId | string | yes | The instance ID of the Smart Access Gateway |
| SmartAGSn | string | yes | The serial number of the associated Smart Access Gateway device |

### Queries remote logon information about a Smart Access Gateway (SAG) device
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-sag-remote-access` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| SmartAGId | string | yes | The ID of the SAG instance |
| SerialNumber | string | no | The serial number of the SAG device |
| RegionId | string | yes | The ID of the region where the SAG instance is deployed |

### Queries the current route list
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-sag-route-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the Smart Access Gateway (SAG) instance |
| SmartAGId | string | yes | The instance ID of the Smart Access Gateway |
| SmartAGSn | string | yes | The serial number of the attached Smart Access Gateway device |

### Queries the configurations of Border Gateway Protocol (BGP) dynamic routing
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-sag-route-protocol-bgp` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the Smart Access Gateway (SAG) instance |
| SmartAGId | string | yes | The ID of the SAG instance |
| SmartAGSn | string | yes | The serial number of the SAG device that is associated with the SAG instance |

### Queries the OSPF settings of a Smart Access Gateway (SAG) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-sag-route-protocol-ospf` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the SAG instance is deployed |
| SmartAGId | string | yes | The ID of the SAG instance |
| SmartAGSn | string | yes | The serial number of the SAG device associated with the SAG instance |

### Queries the static routes of a Smart Access Gateway (SAG) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-sag-static-route-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the SAG instance is deployed |
| SmartAGId | string | yes | The ID of the SAG instance |
| SmartAGSn | string | yes | The serial number of the SAG device associated with the SAG instance |

### Queries the top 10 Smart Access Gateway (SAG) instances that have the highest data transfer rates in a…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-sag-traffic-top-n` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the SAG instance is deployed |
| Size | integer | no | The number of SAG instances to be queried. Default value:10. This value cannot be modified |

### Queries the DNS servers used by a Smart Access Gateway (SAG) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-sag-user-dns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the SAG instance is deployed |
| SmartAGId | string | yes | The ID of the SAG instance |
| SmartAGSn | string | yes | The serial number of the SAG device associated with the SAG instance |

### Queries whether a specified virtual border router (VBR) is associated with a Smart Access Gateway (SAG)…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-sag-vbr-relations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The ID of the region where the SAG instance is deployed. You can call the https://help.aliyun.com/document_detail/69813.html operation to… |
| VbrRegionId | string | yes | The ID of the region where the VBR is deployed. You can call the https://help.aliyun.com/document_detail/36063.html operation to query the… |
| VbrInstanceIds | string | yes | The IDs of the VBRs (JSON-encoded) |

### Queries the information about the 4G subscriber identity module (SIM) card used by the WAN port of a Smart…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-sag-wan4-g` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the SAG instance |
| SmartAGId | string | yes | The SAG instance ID |
| SmartAGSn | string | yes | The serial number of the SAG device associated with the SAG instance |

### Queries the WAN port settings of a Smart Access Gateway (SAG) device
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-sag-wan-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the SAG instance is deployed. You can call the https://help.aliyun.com/document_detail/69813.html operation to… |
| SmartAGId | string | yes | The ID of the SAG instance |
| SmartAGSn | string | yes | The serial number of the SAG device |

### Queries the SNAT settings of the WAN port of a Smart Access Gateway (SAG) device
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-sag-wan-snat` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the SAG instance |
| SmartAGId | string | yes | The ID of the SAG instance |
| SmartAGSn | string | yes | The serial number of the SAG device that is associated with the SAG instance |

### Queries the Wi-Fi settings of a Smart Access Gateway (SAG) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-sag-wifi` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the SAG instance is deployed |
| SmartAGId | string | yes | The ID of the SAG instance |
| SmartAGSn | string | yes | The serial number (SN) of the SAG device |

### Calls the DescribeSmartAccessGatewayAttribute operation to query the information about a specified Smart…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-smart-access-gateway-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the SAG instance is deployed. You can call the https://help.aliyun.com/document_detail/36063.html operation to… |
| SmartAGId | string | yes | The ID of the SAG instance |

### Invokes DescribeSmartAccessGatewayClientUsers to query the client account information of a Smart Access…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-smart-access-gateway-client-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the Smart Access Gateway app instance |
| SmartAGId | string | yes | The instance ID of the Smart Access Gateway app |
| UserName | string | no | The username of the client |
| PageNumber | integer | no | The page number. Default value: 1 |
| PageSize | integer | no | The number of entries per page when paging is used. Default value: 10 |
| UserMail | string | no | The email address of the client |

### Queries the high availability (HA) settings of a Smart Access Gateway (SAG) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-smart-access-gateway-ha` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| SmartAGId | string | yes | The ID of the SAG instance |
| RegionId | string | yes | The ID of the region where the SAG instance is deployed |

### Queries the version of a Smart Access Gateway (SAG) device
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-smart-access-gateway-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the SAG instance is deployed |
| SmartAGId | string | yes | The ID of the SAG instance |
| SmartAGSn | string | no | The serial number of the SAG device |
| VersionType | string | no | The type of software run by the SAG device. Valid values: Device: The operating system run by the SAG device. This is the default value.… |

### Queries Smart Access Gateway (SAG) instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-smart-access-gateways` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The ID of the region where the SAG instance is deployed |
| AssociatedCcnId | string | no | The ID of the CCN instance with which the SAG instance is associated |
| SmartAGId | string | no | The ID of the SAG instance |
| Status | string | no | The status of the SAG instance. Valid values: Ordered: Your order has been placed. Delivered: Your order has been shipped. Received: You… |
| Name | string | no | The name of the SAG instance. The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and… |
| PageSize | integer | no | The number of entries to return on each page. Default value: 10. Valid values: 1 to 50 |
| PageNumber | integer | no | The number of the page to return. Default value: 1 |
| SerialNumber | string | no | The serial number of the SAG device |
| AclIds | string | no | The ID of the ACL with which the SAG instance is associated |
| UnboundAclIds | string | no | The ID of the ACL rule. Specifies that the SAG instance which is not associated with the ACL is queried. Separate ACL IDs with commas (,) |
| InstanceType | string | no | The type of the SAG instance. Valid values: software: an SAG app instance hardware: an SAG CPE instance |
| CanAssociateQos | string | no | Specifies whether the SAG instance can be associated with a quality of service (QoS) policy. Valid values: true: yes false: no Specifies… |
| HardwareType | string | no | The model of SAG device. Valid values: sag-1000 sag-100wm |
| SoftwareVersion | string | no | The software version of the SAG device |
| VersionComparator | string | no | The version filter. Valid values: greater: later than the current version less: earlier than the current version equals: equal to the… |
| BusinessState | string | no | The business status of the SAG instance. Valid values: Normal: running as expected. Arrearage: locked due to overdue payments |
| ResourceGroupId | string | no | The ID of the resource group to which the SAG instance belongs |
| SmartAGIds | string | no | The IDs of the SAG instances (JSON-encoded) |
| AssociatedCcnName | string | no | The name of the associated CCN instance. The name must be 2 to 100 characters in length, and can contain letters, digits, periods (.),… |

### Queries SNAT entries bound to a Smart Access Gateway instance by calling DescribeSnatEntries
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-snat-entries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the Smart Access Gateway instance |
| SmartAGId | string | yes | The instance ID of the Smart Access Gateway instance |
| PageNumber | integer | no | The page number of the instance status list. Default value: 1 |
| PageSize | integer | no | The number of entries per page in a paged query. Default value: 10. Maximum value: 50 |

### Queries Smart Access Gateway (SAG) instances that are not associated with a flow log in a specific region
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-unbind-flow-log-sags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the SAG instances are deployed. You can call the https://help.aliyun.com/document_detail/36063.html operation… |

### Queries the amount of data transfer generated by each client account of a Smart Access Gateway (SAG) app…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-user-flow-statistics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region where the SAG APP instance is deployed |
| SmartAGId | string | yes | The ID of the SAG APP instance |
| StatisticsDate | string | no | The month during which the data transfer statistics are collected. If you do not specify a month, the current month is queried |
| UserNames | string | yes | The list of usernames of client accounts. Maximum value of N: 50 (JSON-encoded) |

### Queries a specified user's online connection statistics from a Smart Access Gateway (SAG) app instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-user-online-client-statistics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region where the SAG app instance is deployed |
| SmartAGId | string | yes | The ID of the SAG app instance |
| UserNames | string | yes | The usernames. You can query up to 50 users at a time. Separate multiple usernames with commas (,) (JSON-encoded) |

### Queries the connection information about a client based on the ID of the Smart Access Gateway (SAG) APP…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/describe-user-online-clients` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region where the SAG APP instance is deployed |
| SmartAGId | string | yes | The ID of the SAG APP instance |
| UserName | string | yes | The username of the client account. Usernames of client accounts added to the same SAG APP instance are unique. For a client account, if… |

### Unbinds a Cloud Connect Network (CCN) from a Cloud Enterprise Network (CEN) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/detach-ccn-instance-from-cen` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| CcnId | string | no | The ID of the Cloud Connect Network (CCN) that is attached to the CEN instance |
| CenId | string | no | The ID of the CEN instance from which you want to revoke the authorization |
| RegionId | string | no | The region ID of the Smart Access Gateway instance. You can call the DescribeRegions operation to query the regions supported by Smart… |

### Enables diagnostics for Smart Access Gateway (SAG) devices
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/diagnose-smart-access-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| SmartAGId | string | yes | The ID of the SAG instance |
| SmartAGSn | string | yes | The serial number (SN) of the SAG device |
| RegionId | string | no | The ID of the region where the SAG instance is deployed |

### Disables the deep packet inspection (DPI) feature for a Smart Access Gateway (SAG) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/disable-smart-agdpi-monitor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the SAG instance is deployed |
| SmartAGId | string | yes | The ID of the SAG instance |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… |
| DryRun | string | no | Specifies whether to check the validity of the request without actually making the request. Valid values: true: checks the validity of the… |

### Disables a user of a Smart Access Gateway instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/disable-smart-access-gateway-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| UserName | string | yes | The username |
| SmartAGId | string | yes | The instance ID of the Smart Access Gateway |
| RegionId | string | yes | The region ID |

### Disassociates an access control list (ACL) from a Smart Access Gateway (SAG) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/disassociate-acl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the ACL is deployed. You can call the https://help.aliyun.com/document_detail/69813.html operation to query the… |
| AclId | string | yes | The ID of ACL |
| SmartAGId | string | yes | The ID of the SAG instance |

### Disassociates a Smart Access Gateway (SAG) instance from a flow log
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/disassociate-flow-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region to which the flow log belongs |
| FlowLogId | string | yes | The instance ID of the flow log |
| SmartAGId | string | yes | The ID of the SAG instance |

### Disassociates a Smart Access Gateway (SAG) instance from a Quality of Service (QoS) policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/disassociate-qos` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region to which the QoS policy belongs |
| QosId | string | yes | The instance ID of the QoS policy |
| SmartAGId | string | yes | The ID of the SAG instance to be disassociated |

### Queries the diagnosis report of a Smart Access Gateway (SAG) device by calling the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/discribe-smart-access-gateway-diagnosis-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| SmartAGId | string | yes | The ID of the Smart Access Gateway instance |
| SmartAGSn | string | yes | The serial number of the Smart Access Gateway device |
| RegionId | string | no | The ID of the region where the Smart Access Gateway instance is deployed. You can call the… |

### Disassociates a Smart Access Gateway (SAG) instance from a bandwidth plan for application acceleration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/dissociate-smart-agfrom-application-bandwidth-package` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| DryRun | string | no | Specifies whether to precheck the request. Check items include permissions and the status of the specified cloud resources. Valid values:… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make… |
| RegionId | string | yes | The region ID of the bandwidth plan for application acceleration. You can call the https://help.aliyun.com/document_detail/36063.html… |
| ApplicationBandwidthPackageId | string | yes | The ID of the bandwidth plan for application acceleration |
| SmartAGId | string | no | The ID of the SAG instance |
| SmartAGIdList | string | no | The list of the SAG instance id (JSON-encoded) |

### Downgrades the bandwidth of a Smart Access Gateway (SAG) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/downgrade-smart-access-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| SmartAGId | string | yes | The ID of the SAG instance |
| RegionId | string | yes | The ID of the region where the SAG instance is deployed |
| BandWidthSpec | integer | no | The bandwidth of the SAG instance. If the model of the SAG device is SAG-100WM, set the bandwidth to 2 to 50 Mbit/s. If the model of the… |
| AutoPay | string | yes | Specifies whether it is an auto-renewal order generated by a subscription instance. Valid values: true: Yes false: No (default) |

### Decreases the quota of client accounts that can be connected to a Smart Access Gateway (SAG) app instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/downgrade-smart-access-gateway-software` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| SmartAGId | string | yes | The ID of the SAG app instance |
| RegionId | string | yes | The ID of the region where the SAG app instance is deployed |
| AutoPay | string | yes | Specify whether the bill belongs to a subscription instance that has auto renewal enabled. Valid values: false (default): no true: yes |
| DataPlan | integer | yes | The amount of free data transfer allocated to each client account per month, which is 5 GB |
| UserCount | integer | yes | The quota of client accounts that can be connected to an SAG app instance. Typically, you need to create an account for each user that… |

### Enables monitoring based on the deep packet inspection (DPI) feature for a Smart Access Gateway (SAG) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/enable-smart-agdpi-monitor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the SAG instance is deployed |
| SmartAGId | string | yes | The ID of the SAG instance |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… |
| DryRun | string | no | Specifies whether to check the validity of the request without actually making the request. Valid values: true: checks the validity of the… |
| SlsProjectName | string | yes | The name of the Log Service project |
| SlsLogStore | string | yes | The name of the Logstore |

### Activates a client account of a Smart Access Gateway (SAG) app instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/enable-smart-access-gateway-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| UserName | string | yes | The username of the client account |
| SmartAGId | string | yes | The ID of the SAG APP instance |
| RegionId | string | yes | The ID of the region where the SAG APP instance is deployed |

### Queries the configuration errors of the deep packet inspection (DPI) feature in an access control list (ACL)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/get-acl-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the ACL is deployed |
| AclId | string | yes | The ID of the ACL |

### GetAdvancedMonitorState
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/get-advanced-monitor-state` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| SagId | string | yes | The SagId |
| RegionId | string | yes | The RegionId |

### Queries the number of Cloud Connect Network (CCN) instances that can be created within the current account…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/get-cloud-connect-network-use-limit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the CCN instances are deployed |

### Queries the details of a quality of service (QoS) policy instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/get-qos-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://smartag.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the QoS policy instance. You can call the https://help.aliyun.com/document_detail/36063.html operation to query region IDs |
| QosId | string | yes | The instance ID of the QoS policy |

…and 86 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-smartag/activate-smart-access-gateway" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Smart Access Gateway API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-smartag/activate-smart-access-gateway with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Smart Access Gateway API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Smart Access Gateway itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Smart Access Gateway API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-smartag.

### What is the status of the Alibaba Cloud Smart Access Gateway API?
Needs your own provider key (bring your own key)