DeleteSmartAccessGatewayDnsForward - Smart Access Gateway

Deletes a DNS forwarding rule. This operation is applicable only to Smart Access Gateway (SAG) instances that are created using an SCG5000 or SCG5000-5G device with firmware version 3.4.2 or later.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

smartag:DeleteSmartAccessGatewayDnsForward

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SagInsId	string	Yes	The ID of the SAG instance.	sag-v9un1ccz22owd76lf8
SagSn	string	Yes	The serial number (SN) of the device.	sagf4dkqh78
InstanceId	string	Yes	The ID of the DNS forwarding rule.	sagv3dnsforward-nc7qabskj17werc7su
RegionId	string	Yes	The ID of the region where the SAG instance is deployed.	cn-shanghai

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	0BAAF2B9-88B8-4574-BDBE-102A90EE3FEE
Success	string	Indicates whether the request was successful.	true
Code	string	The response code.	200
Message	string	The returned message.	Successful
HttpStatusCode	string	The HTTP status code.	200

Examples

Success response

JSON format

{
  "RequestId": "0BAAF2B9-88B8-4574-BDBE-102A90EE3FEE",
  "Success": "true",
  "Code": "200",
  "Message": "Successful",
  "HttpStatusCode": "200"
}

Error codes

HTTP status code	Error code	Error message
400	InvalidSpec.FeatureNotSupport	The current edition of the cloudbranch does not support this feature.
400	GATEWAY.InvalidSN	The specified gateway serial number does not exist.
400	CCN.DNS.Forward.IdNotExist	DNS forwarding does not exist.
400	ConfigUnsynchronized	The configs of device are unsynchronized, please check whether the device is online
400	DeviceNotExist	The specified device does not exist

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.