All Products
Search

This Product

    API Gateway:Manage routes

    Document Center

    API Gateway:Manage routes

    Last Updated:May 21, 2025

    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. Cloud-native API Gateway provides two ways to view route details: from outside an instance and from inside an instance:

      From outside an instance

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

      2. Click the target API. You can select the instance for which you want to view route details from the drop-down list, or select All Instances. image

      3. Select the target route from the Route List.

      From inside an instance

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

      2. On the Instances page, click the ID of the target gateway instance. In the left-side navigation pane, select API, and click the target API.

      3. Select the target route from the Route List.

    2. You can view the Basic Information, Matching Rules, and Backend Service of the route.

    Edit routing rules

    1. Cloud-native API Gateway provides two ways to edit routing rules: from outside an instance and from inside an instance:

      From outside an instance

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

      2. Click the target API. You can select the instance for which you want to edit routing rules from the drop-down list, or select All Instances. image

      3. Select the target route from the Route List.

      From inside an instance

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

      2. On the Instances page, click the ID of the target gateway instance. In the left-side navigation pane, select API, and click the target API.

      3. Select the target route from the Route List.

    2. Click image Edit Route under Ingress List Edit Ingress next to the route name. Or click in the upper-right corner of the dialog box.

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

    Publish routing rules

    1. Cloud-native API Gateway provides two ways to publish routing rules: from outside an instance and from inside an instance:

      From outside an instance

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

      2. Click the target API. You can select the instance for which you want to publish routing rules from the drop-down list, or select All Instances. image

      3. Select the target route from the Route List.

      From inside an instance

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

      2. On the Instances page, click the ID of the target gateway instance. In the left-side navigation pane, select API, and click the target API.

      3. Select the target route from the Route List.

    2. Click image Publish Route under Ingress List Advertise Routes next to the route name. Or click in the upper-right corner of the dialog box.

    3. In the Publish dialog box, click OK. When Published is displayed for the route in the Route List, the route is published.

    Unpublish routing rules

    Important

    After a route is unpublished, the route cannot be accessed in the specified instance. Exercise caution when you perform this operation.

    1. Cloud-native API Gateway provides two ways to unpublish routing rules: from outside an instance and from inside an instance:

      From outside an instance

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

      2. Click the target API. You can select the instance for which you want to unpublish routing rules from the drop-down list, or select All Instances. image

      3. Select the target route from the Route List.

      From inside an instance

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

      2. On the Instances page, click the ID of the target gateway instance. In the left-side navigation pane, select API, and click the target API.

      3. Select the target route from the Route List.

    2. Click image Unpublish under Ingress List More Operations Unpublish next to the route name. Or click under in the upper-right corner of the dialog box.

    3. In the dialog box, click Unpublish. When Not Published is displayed for the route in the Route List, the route is unpublished.

    Debug

    Prerequisites

    You have published routing rules.

    Procedure

    1. Cloud-native API Gateway provides two ways to debug routes: from outside an instance and from inside an instance:

      From outside an instance

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

      2. Click the target API. You can select the instance for which you want to debug routes from the drop-down list, or select All Instances. image

      3. Select the target route from the Route List.

      From inside an instance

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

      2. On the Instances page, click the ID of the target gateway instance. In the left-side navigation pane, select API, and click the target API.

      3. Select the target route from the Route List.

    2. Click image Debug under Ingress List Debug next to the route name. Or click in the upper-right corner of the dialog box.

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

    Stress test

    Prerequisites

    You have published routing rules.

    Procedure

    1. Cloud-native API Gateway provides two ways to stress test routes: from outside an instance and from inside an instance:

      From outside an instance

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

      2. Click the target API. You can select the instance for which you want to debug routes from the drop-down list, or select All Instances. image

      3. Select the target route from the Route List.

      From inside an instance

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

      2. On the Instances page, click the ID of the target gateway instance. In the left-side navigation pane, select API, and click the target API.

      3. Select the target route from the Route List.

    2. Click image Stress Test under Ingress List More Operations Stress Testing PTS pressure testing quick start next to the route name. Or click under in the upper-right corner of the dialog box. For more information, see.

    Delete routing rules

    Important

    • If the current route is published, you need to unpublish the route before you can delete it.

    • After a route is deleted, it cannot be recovered. Exercise caution when you perform this operation.

    1. Cloud-native API Gateway provides two ways to delete routing rules: from outside an instance and from inside an instance:

      From outside an instance

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

      2. Click the target API. You can select the instance for which you want to delete routing rules from the drop-down list, or select All Instances. image

      3. Select the target route from the Route List.

      From inside an instance

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

      2. On the Instances page, click the ID of the target gateway instance. In the left-side navigation pane, select API, and click the target API.

      3. Select the target route from the Route List.

    2. Click image Delete under Ingress List More Operations Delete next to the name of the successfully unpublished route, or click under in the upper-right corner of the dialog box.

    3. In the dialog box, click OK.