All Products
Search

This Product

    API Gateway:Manage routes

    Document Center

    API Gateway:Manage routes

    Last Updated:Jun 25, 2026

    This topic describes how to view route details and how to edit, publish, unpublish, and delete routing rules of a gateway.

    View route details

    1. You can view route details from two locations in the Cloud-native API Gateway console:

      API page

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

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

      3. In the Routes, select the target route.

      Instances page

      1. Log on to the Cloud-native API Gateway console. In the left-side navigation pane, 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 left-side navigation pane, choose API, and then click the target API.

      3. In the Routes, select the target route.

    2. You can view the route's Basic Information, Match Rule, and Backend Services.

    Modify routing rule

    1. You can modify a routing rule from two locations in the Cloud-native API Gateway console:

      API page

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

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

      3. In the Routes, select the target route.

      Instances page

      1. Log on to the Cloud-native API Gateway console. In the left-side navigation pane, 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 left-side navigation pane, choose API, and then click the target API.

      3. In the Routes, select the target route.

    2. Next to the route name, click the image icon and select Edit Route. Alternatively, click Edit Route in the upper-right corner of the Routes.

    3. On the Edit Route page, modify the route parameters and click Save or Save and Publish.

    Publish a routing rule

    1. You can publish a routing rule from two locations in the Cloud-native API Gateway console:

      API page

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

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

      3. In the Routes, select the target route.

      Instances page

      1. Log on to the Cloud-native API Gateway console. In the left-side navigation pane, 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 left-side navigation pane, choose API-level, and then click the target API.

      3. In the Routes, select the target route.

    2. Next to the route name, click the image icon and select Publish Route. Alternatively, click Publish Route in the upper-right corner of the Routes.

    3. In the Publish dialog box, click OK. The route is successfully published when its status changes to Published in the Routes.

    Unpublish a routing rule

    Important

    After you unpublish a route, it becomes inaccessible on the specified instance. Proceed with caution.

    1. You can unpublish a routing rule from two locations in the Cloud-native API Gateway console:

      API page

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

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

      3. In the Routes, select the target route.

      Instances page

      1. Log on to the Cloud-native API Gateway console. In the left-side navigation pane, 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 left-side navigation pane, choose API, and then click the target API.

      3. In the Routes, select the target route.

    2. Next to the route name, click the image icon and select Shutdown. Alternatively, in the upper-right corner of the Routes, click More and select Shutdown.

    3. In the dialog box, click Shutdown. The route is successfully unpublished when its status changes to Unpublished in the Routes.

    Debug

    Prerequisites

    The routing rule must be published.

    Procedure

    1. You can debug a route from two locations in the Cloud-native API Gateway console:

      API page

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

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

      3. In the Routes, select the target route.

      Instances page

      1. Log on to the Cloud-native API Gateway console. In the left-side navigation pane, 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 left-side navigation pane, choose API, and then click the target API.

      3. In the Routes, select the target route.

    2. Next to the route name, click the image icon and select Debug. Alternatively, click Debug in the upper-right corner of the Routes.

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

    Stress testing

    Prerequisites

    The routing rule must be published.

    Procedure

    1. You can perform load testing on a route from two locations in the Cloud-native API Gateway console:

      API page

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

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

      3. In the Routes, select the target route.

      Instances page

      1. Log on to the Cloud-native API Gateway console. In the left-side navigation pane, 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 left-side navigation pane, choose API, and then click the target API.

      3. In the Routes, select the target route.

    2. Next to the route name, click the image icon and select Stress Test. Alternatively, in the upper-right corner of the Routes, click More and select Stress Test. For detailed instructions, see Quick start for PTS load testing.

    Delete a routing rule

    Important

    • You must unpublish a route before you can delete it.

    • Deleting a route is irreversible. Proceed with caution.

    1. You can delete a routing rule from two locations in the Cloud-native API Gateway console:

      API page

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

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

      3. In the Routes, select the target route.

      Instances page

      1. Log on to the Cloud-native API Gateway console. In the left-side navigation pane, 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 left-side navigation pane, choose API, and then click the target API.

      3. In the Routes, select the target route.

    2. For an unpublished route, click the image icon next to its name and select Delete. Alternatively, in the upper-right corner of the Routes, click More and select Delete.

    3. In the dialog box, click OK.