WithdrawNotifyRoutes

Last updated: 2021-02-22 15:08:16

1. API Description

Domain name for API request: vpc.tencentcloudapi.com.

This API is used to withdraw a route from CCN. This can also be done by clicking the Withdraw from CCN button on the route table page.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: WithdrawNotifyRoutes.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
RouteTableId Yes String The unique ID of the route table
RouteItemIds.N Yes Array of String The unique ID of the routing policy

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Withdrawing a route from CCN

Input Example

https://vpc.tencentcloudapi.com/?Action=WithdrawNotifyRoutes
&RouteTableId=rtb-9wzwlnhc
&RouteItemIds.0=rti-i8bap903
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "627c2362-890f-4f9e-9158-5e457b80d48b"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError An internal error occurred.
InternalServerError Internal error.
InvalidParameterValue.Malformed Invalid input parameter format.
InvalidRouteId.NotFound Invalid routing policy ID (RouteId).
InvalidRouteTableId.Malformed Invalid route table. The route table ID is invalid.
InvalidRouteTableId.NotFound Invalid route table. The VPC resource does not exist. Please check and enter the correct resource information.
UnsupportedOperation.NotifyCcn The specified routing policy cannot be published to or withdrawn from CCN.
UnsupportedOperation.SystemRoute System route. Operation is prohibited.