Delete Forwarding Rules via API Without Blocking - Global Accelerator - Alibaba Cloud - Global Accelerator

Operation description

DeleteForwardingRules is an asynchronous operation. After you send a request, 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, it is being deleted. In this case, you can perform only query operations.
- If a forwarding rule can no longer be found, the forwarding rule is deleted.
You cannot repeatedly call the DeleteForwardingRules operation for the same Global Accelerator (GA) instance within a specific period of time.

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 supports 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

ga:DeleteForwardingRules

delete

*Listener

acs:ga:{#regionId}:{#accountId}:listener/{#listenerId}

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.	frule-bp19a3t3yzr21q3****
	string	No	The forwarding rule ID.	frule-bp19a3t3yzr21q3****
AcceleratorId	string	Yes	The GA instance ID.	ga-bp17frjjh0udz4q****
ListenerId	string	Yes	The listener ID.	lsr-bp1s0vzbi5bxlx5****

Response elements

Element	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

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.