ViewSmartAccessGatewayDnsForwards - Smart Access Gateway

Queries the DNS forwarding list of a Smart Access Gateway (SAG) SCG5000 or SCG5000-5G instance. The version of the device must be 3.4.2 or later.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
smartag:ViewSmartAccessGatewayDnsForwards	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
SagInsId	string	Yes	The ID of the instance.	sag-v9un1ccz22owd76lf8
SagSn	string	Yes	The serial number (SN) of the device.	sagf4dkqh78
RegionId	string	Yes	The ID of the region in which the SAG instance resides.	cn-shanghai

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	E223E535-AE11-4158-B00F-DC107887A909
Success	boolean	Indicates whether the request is successful.	true
Code	string	The response code.	200
Message	string	The response message.	Successful
HttpStatusCode	integer	The HTTP status code.	200
Count	integer	The total number of entries returned.	1914
Data	object []	A DNS forwarding list.
InstanceId	string	The ID of the instance.	sagv3dnsforward-nc7qabskj17werc7su
Domain	string	The domain name.	www.baidu.com
MasterIp	string	The primary DNS server.	172.16.58.20
SlaveIp	string	The secondary DNS server.	172.16.0.14
Mode	string	The forwarding mode. Note This parameter is not in use. Ignore this parameter.	first
OutboundPortType	string	The type of the egress port. Enumeration Value: Tunnel: Tunnel. PhysicalPort: PhysicalPort. None: None.	PhysicalPort
OutboundPortIndex	integer	The number of the egress port. Enumeration Value: 0: 0. 2: 2.	0
OutboundPortName	string	The egress port. Enumeration Value: eth0: eth0. lte: lte.	eth0

Examples

Sample success responses

JSONformat

{
  "RequestId": "E223E535-AE11-4158-B00F-DC107887A909",
  "Success": true,
  "Code": "200",
  "Message": "Successful",
  "HttpStatusCode": 200,
  "Count": 1914,
  "Data": [
    {
      "InstanceId": "sagv3dnsforward-nc7qabskj17werc7su",
      "Domain": "www.baidu.com",
      "MasterIp": "172.16.58.20",
      "SlaveIp": "172.16.0.14",
      "Mode": "first",
      "OutboundPortType": "PhysicalPort",
      "OutboundPortIndex": 0,
      "OutboundPortName": "eth0"
    }
  ]
}

Error codes

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