DeleteForwardingRules - Global Accelerator - Alibaba Cloud Documentation Center

Deletes forwarding rules.

Operation description

DeleteForwardingRules is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the ListForwardingRules operation to query the status of the task.
- If a forwarding rule is in the deleting state, the forwarding rule is being deleted. In this case, you can perform only query operations.
- If a forwarding rule cannot be queried, the forwarding rule is deleted.
The DeleteForwardingRules operation cannot be repeatedly called for the same Global Accelerator (GA) instance within a specific period of time.

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
ga:DeleteForwardingRules	delete	Listener acs:ga:{#regionId}:{#accountId}:listener/{#listenerId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the GA instance. Set the value to cn-hangzhou.	cn-hangzhou
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 sure that the token is unique among all requests. The token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.	123e4567-e89b-12d3-a456-426655440000
ForwardingRuleIds	array	Yes	The forwarding rules.
	string	Yes	The forwarding rule ID.	frule-bp19a3t3yzr21q3****
AcceleratorId	string	Yes	The GA instance ID.	ga-bp17frjjh0udz4q****
ListenerId	string	Yes	The listener ID.	lsr-bp1s0vzbi5bxlx5****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
ForwardingRules	array<object>	The forwarding rules.
	object	The forwarding rule ID.
ForwardingRuleId	string	The forwarding rule ID.	frule-bp19a3t3yzr21q3****
RequestId	string	The request ID.	CFC67ED9-4AB1-431F-B6E3-A752B7B8CCD4

Examples

Sample success responses

JSONformat

{
  "ForwardingRules": [
    {
      "ForwardingRuleId": "frule-bp19a3t3yzr21q3****"
    }
  ],
  "RequestId": "CFC67ED9-4AB1-431F-B6E3-A752B7B8CCD4"
}

Error codes

HTTP status code	Error code	Error message	Description
400	NotExist.Listener	The listener does not exist.	The listener does not exist.
400	NotActive.Listener	The state of the listener is not active.	The listener is unstable.
400	NotExist.Accelerator	The accelerated instance does not exist.	The GA instance does not exist.
400	StateError.Accelerator	The state of the accelerated instance is invalid.	The status of the GA instance is invalid.
400	NotExist.BusinessRegion	The business region does not exist.	The business region does not exist.
400	NotExist.BasicBandwidthPackage	You must specify the basic bandwidth package.	You must specify the basic bandwidth package.
400	QuotaExceeded.EndPoint	The maximum number of endpoints is exceeded.	The maximum number of endpoints is exceeded.
400	Exist.EndpointGroup	The endpoint group already exists.	The endpoint group already exists.
400	NoPermission.VpcEndpoint	You are not authorized to perform the operation.	The user does not have permissions to create service linked roles. Contact the Alibaba Cloud account owner or the permission administrator to grant the current user AliyunGlobalAccelerationFullAccess or create custom permission policies for service linked role. The following content describes the detailed information about custom permission policies: ServiceName: vpcendpoint.ga.aliyuncs.com. Service linked role name: AliyunServiceRoleForGaVpc. Endpoint Permission: ram:CreateServiceLinkedRole.
400	NotExist.ForwardingRule	forwarding rule %s is not exist	-

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

Change history

Change time	Summary of changes	Operation

No change history