All Products
Search

This Product

    API Gateway:Manage routes

    Document Center

    API Gateway:Manage routes

    Last Updated:Aug 12, 2026

    Manage routing rules for your Cloud Native API Gateway instance, including viewing details, modifying rules, publishing, unpublishing, debugging, and deleting routes.

    View route details

    1. Navigate to the target route:

      Global

      1. Log on to the Cloud Native API Gateway console. In the navigation pane on the left, choose API. In the top navigation bar, select a region.

      2. Click the target API. From the drop-down list, select the target instance, or select All Instances.image

      3. In the Routes tab, select the target route.

      Instance

      1. Log on to the Cloud Native API Gateway console. In the navigation pane on the left, choose Instance. In the top navigation bar, select a region.

      2. On the Instance page, click the ID of the target gateway instance. In the navigation pane on the left, choose API and then click the target API.

      3. In the Routes tab, select the target route.

    2. View the Basic Information, Match Rule, and Backend Services details.

    Modify routing rules

    1. Navigate to the target route:

      Global

      1. Log on to the Cloud Native API Gateway console. In the navigation pane on the left, choose API. In the top navigation bar, select a region.

      2. Click the target API. From the drop-down list, select the target instance, or select All Instances.image

      3. In the Routes tab, select the target route.

      Instance

      1. Log on to the Cloud Native API Gateway console. In the navigation pane on the left, choose Instance. In the top navigation bar, select a region.

      2. On the Instance page, click the ID of the target gateway instance. In the navigation pane on the left, choose API and then click the target API.

      3. In the Routes tab, select the target route.

    2. Click image next to the route name and choose Edit Route. Alternatively, click Routes in the upper-right corner of the Edit Route tab.

    3. On the Edit Route page, modify the parameters as required, and then click Save or Save and Publish.

    Publish a routing rule

    1. Navigate to the target route:

      Global

      1. Log on to the Cloud Native API Gateway console. In the navigation pane on the left, choose API. In the top navigation bar, select a region.

      2. Click the target API. From the drop-down list, select the target instance, or select All Instances.image

      3. In the Routes tab, select the target route.

      Instance

      1. Log on to the Cloud Native API Gateway console. In the navigation pane on the left, choose Instance. In the top navigation bar, select a region.

      2. On the Instance page, click the ID of the target gateway instance. In the navigation pane on the left, choose API-level and then click the target API.

      3. In the Routes tab, select the target route.

    2. Click image next to the route name and choose Publish Route. Alternatively, click Routes in the upper-right corner of the Publish Route tab.

    3. In the Publish dialog box, click OK. The status of the route changes to Routes in the Published tab.

    Unpublish a routing rule

    Important

    • Batch operations are not supported for unpublishing routes or unbinding domain names. Unpublish each route or unbind each domain name individually.

    • Unpublishing a route makes it inaccessible on the specified instance. Proceed with caution.

    To stop public network access before an instance maintenance window, unpublish all published routes on the instance. After maintenance is complete, click Publish Route to restore access.

    1. Navigate to the target route:

      Global

      1. Log on to the Cloud Native API Gateway console. In the navigation pane on the left, choose API. In the top navigation bar, select a region.

      2. Click the target API. From the drop-down list, select the target instance, or select All Instances.image

      3. In the Routes tab, select the target route.

      Instance

      1. Log on to the Cloud Native API Gateway console. In the navigation pane on the left, choose Instance. In the top navigation bar, select a region.

      2. On the Instance page, click the ID of the target gateway instance. In the navigation pane on the left, choose API and then click the target API.

      3. In the Routes tab, select the target route.

    2. Click image next to the route name and choose Shutdown. Alternatively, in the upper-right corner of the Routes tab, click More and choose Shutdown.

    3. In the dialog box that appears, click Shutdown. The status of the route changes to Routes in the Unpublished tab.

    Debug a route

    Prerequisites

    The routing rule must be published.

    Procedure

    1. Navigate to the target route:

      Global

      1. Log on to the Cloud Native API Gateway console. In the navigation pane on the left, choose API. In the top navigation bar, select a region.

      2. Click the target API. From the drop-down list, select the target instance, or select All Instances.image

      3. In the Routes tab, select the target route.

      Instance

      1. Log on to the Cloud Native API Gateway console. In the navigation pane on the left, choose Instance. In the top navigation bar, select a region.

      2. On the Instance page, click the ID of the target gateway instance. In the navigation pane on the left, choose API and then click the target API.

      3. In the Routes tab, select the target route.

    2. Click image next to the route name and choose Debug. Alternatively, click Routes in the upper-right corner of the Debug tab.

    3. In the Route Debugging panel, configure the parameters and click Send Request.

    Run a performance test

    Prerequisites

    The routing rule must be published.

    Procedure

    1. Navigate to the target route:

      Global

      1. Log on to the Cloud Native API Gateway console. In the navigation pane on the left, choose API. In the top navigation bar, select a region.

      2. Click the target API. From the drop-down list, select the target instance, or select All Instances.image

      3. In the Routes tab, select the target route.

      Instance

      1. Log on to the Cloud Native API Gateway console. In the navigation pane on the left, choose Instance. In the top navigation bar, select a region.

      2. On the Instance page, click the ID of the target gateway instance. In the navigation pane on the left, choose API and then click the target API.

      3. In the Routes tab, select the target route.

    2. Click image next to the route name and choose Stress Test. Alternatively, in the upper-right corner of the Routes tab, click More and choose Stress Test. Quick start for Performance Testing Service (PTS).

    Delete a routing rule

    Important

    • A route must be unpublished before you can delete it.

    • Deleted routes cannot be recovered. Proceed with caution.

    1. Navigate to the target route:

      Global

      1. Log on to the Cloud Native API Gateway console. In the navigation pane on the left, choose API. In the top navigation bar, select a region.

      2. Click the target API. From the drop-down list, select the target instance, or select All Instances.image

      3. In the Routes tab, select the target route.

      Instance

      1. Log on to the Cloud Native API Gateway console. In the navigation pane on the left, choose Instance. In the top navigation bar, select a region.

      2. On the Instance page, click the ID of the target gateway instance. In the navigation pane on the left, choose API and then click the target API.

      3. In the Routes tab, select the target route.

    2. Click image next to the route name and choose Delete. Alternatively, in the upper-right corner of the Routes tab, click More and choose Delete.

    3. In the dialog box that appears, click OK.