Deletes a forwarding rule.

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 a 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 Global Accelerator (GA) instance is deployed. Set the value to cn-hangzhou.

ClientToken String No 02fb3da4****

The client token that is used to ensure the idempotency 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 token can contain only ASCII characters and cannot exceed 64 characters in length.

ForwardingRuleIds Array of 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

The information about the forwarding rule.

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=02fb3da4****
&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

HttpCode 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 StateError.Accelerator The state of the accelerated instance is invalid. The error message returned because the specified GA instance is invalid.
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 the required basic bandwidth plan is not specified.
400 QuotaExceeded.EndPoint The maximum number of endpoints is exceeded. The error message returned because the number of endpoints has reached 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 unauthorized to create the service-linked role. Contact the owner of the Alibaba Cloud account or the permission administrator to grant the current user the AliyunGlobalAccelerationFullAccess permission or required custom permissions. The custom permissions allow you to create the service-linked role. Information about the custom permissions: ServiceName: vpcendpoint.ga.aliyuncs.com The name of the service-linked role: AliyunServiceRoleForGaVpcEndpoint Required permission: ram:CreateServiceLinkedRole

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