DeleteForwardingRules

Updated at: 2024-07-31 07:21

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
ga:DeleteForwardingRulesdelete
  • Listener
    acs:ga:{#regionId}:{#accountId}:listener/{#listenerId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the GA instance. Set the value to cn-hangzhou.

cn-hangzhou
ClientTokenstringNo

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
ForwardingRuleIdsarrayYes

The forwarding rules.

stringYes

The forwarding rule ID.

frule-bp19a3t3yzr21q3****
AcceleratorIdstringYes

The GA instance ID.

ga-bp17frjjh0udz4q****
ListenerIdstringYes

The listener ID.

lsr-bp1s0vzbi5bxlx5****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

ForwardingRulesarray<object>

The forwarding rules.

object

The forwarding rule ID.

ForwardingRuleIdstring

The forwarding rule ID.

frule-bp19a3t3yzr21q3****
RequestIdstring

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 codeError codeError messageDescription
400NotExist.ListenerThe listener does not exist.The listener does not exist.
400NotActive.ListenerThe state of the listener is not active.The listener is unstable.
400NotExist.AcceleratorThe accelerated instance does not exist.The GA instance does not exist.
400StateError.AcceleratorThe state of the accelerated instance is invalid.The status of the GA instance is invalid.
400NotExist.BusinessRegionThe business region does not exist.The business region does not exist.
400NotExist.BasicBandwidthPackageYou must specify the basic bandwidth package.You must specify the basic bandwidth package.
400QuotaExceeded.EndPointThe maximum number of endpoints is exceeded.The maximum number of endpoints is exceeded.
400Exist.EndpointGroupThe endpoint group already exists.The endpoint group already exists.
400NoPermission.VpcEndpointYou 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.
400NotExist.ForwardingRuleforwarding rule %s is not exist-

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

Change history

Change timeSummary of changesOperation
No change history
  • On this page (1)
  • Operation description
  • Debugging
  • Authorization information
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
  • Change history
Feedback
phone Contact Us