Deletes forwarding rules.

Description

  • DeleteForwardingRules is an asynchronous operation. After you send a request, the system returns a request ID, but the operation is still being performed in the system background. You can call the ListForwardingRules operation to query the state of a forwarding rule.
    • If the forwarding rule is in the deleting state, the forwarding rule is being deleted. In this case, you can perform only query operations.
    • If the 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DeleteForwardingRules

The operation that you want to perform. Set the value to DeleteForwardingRules.

RegionId String Yes cn-hangzhou

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

ClientToken String No 123e4567-e89b-12d3-a456-426655440000

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the value, but you must make sure that it is unique among different requests. The client token can contain only ASCII characters.

Note If you do not set this parameter, ClientToken is set to the value of RequestId. The value of RequestId may be different for each API request.
ForwardingRuleIds.N String Yes frule-bp19a3t3yzr21q3****

The ID of the forwarding rule.

AcceleratorId String Yes ga-bp17frjjh0udz4q****

The ID of the GA instance.

ListenerId String Yes lsr-bp1s0vzbi5bxlx5****

The ID of the listener.

Response parameters

Parameter Type Example Description
ForwardingRules Array of ForwardingRules

Details about the forwarding rules.

ForwardingRuleId String frule-bp19a3t3yzr21q3****

The ID of the forwarding rule.

RequestId String CFC67ED9-4AB1-431F-B6E3-A752B7B8CCD4

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DeleteForwardingRules
&RegionId=cn-hangzhou
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&ForwardingRuleIds=["frule-bp19a3t3yzr21q3****"]
&AcceleratorId=ga-bp17frjjh0udz4q****
&ListenerId=lsr-bp1s0vzbi5bxlx5****
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DeleteForwardingRulesResponse>
    <ForwardingRules>
        <ForwardingRuleId>frule-bp19a3t3yzr21q3****</ForwardingRuleId>
    </ForwardingRules>
    <RequestId>CFC67ED9-4AB1-431F-B6E3-A752B7B8CCD4</RequestId>
</DeleteForwardingRulesResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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 error message returned because the specified listener does not exist.
400 NotActive.Listener The state of the listener is not active. The error message returned because the specified listener is unstable.
400 NotExist.Accelerator The accelerated instance does not exist. The error message returned because the specified GA instance does not exist.
400 NotExist.BusinessRegion The business region does not exist. The error message returned because the specified region does not exist.
400 NotExist.BasicBandwidthPackage You must specify the basic bandwidth package. The error message returned because no basic bandwidth plan is specified.
400 QuotaExceeded.EndPoint The maximum number of endpoints is exceeded. The error message returned because the number of endpoints reaches the upper limit.
400 Exist.EndpointGroup The endpoint group already exists. The error message returned because the specified endpoint group already exists.
400 NoPermission.VpcEndpoint You are not authorized to perform the operation. The error message returned because you are not authorized to create the service-linked role. Contact the owner of the Alibaba Cloud account or the administrator to attach the AliyunGlobalAccelerationFullAccess policy or a custom permission policy that grants the permissions to create the required service-linked role to your RAM user. In the custom policy, the service name must be set to vpcendpoint.ga.aliyuncs.com, the service-linked role to AliyunServiceRoleForGaVpcEndpoint, and the permissions to ram:CreateServiceLinkedRole.

For a list of error codes, visit the API Error Center.