Help Center/ API Gateway/ User Guide/ Managing APIG Gateways/ Viewing or Modifying Gateway Information
Updated on 2024-11-27 GMT+08:00
View PDF
Share

Viewing or Modifying Gateway Information

You can view and modify the configuration of your gateways on the console.

Procedure

  1. Go to the APIG console.
  1. In the navigation pane, choose Gateways.
  2. Click Access Console or the name of the target gateway.
  3. On the Gateway Information tab, view or modify the configuration of the gateway.

    Table 1 Gateway information

    Modifiable Parameter

    Description

    Basic Information

    Basic information about the gateway, including the name, ID, edition, AZ, description, enterprise project, and maintenance time window.

    • Modify the basic information as required.
    • To copy the gateway ID, click next to the ID.

    Billing Mode

    Billing mode of the gateway and the time when the gateway is created.

    Network
    • VPC

      VPC associated with the gateway. Click the VPC name to view the configuration.

    • Subnet

      Subnet associated with the gateway. Click the subnet name to view the configuration.

    • Security Group

      Security group associated with the gateway. Click the security group name to view the configuration or click to bind a new one.

    • Access Control

      APIG provides access control policies to gateways. You can set an IP address blacklist or whitelist to forbid or allow an IP address to access a gateway. The IP addresses are described as follows:

      • Common IP address, for example, 127.0.0.1 or ::1.
      • IP address and mask, for example, 192.145.0.0/16 or 2407:c080:17ef:ffff::3104:703a/64.
      • IP address segment, for example, 127.0.0.1-192.145.0.1 or 2407:c080:17ef:ffff::3104:703a-2407:c080:17ef:ffff::3104:704a.

      An access control policy supports a maximum of 100 IP addresses or segments, with the maximum length of 5,120 characters.

      Before entering an IPv6 address, ensure the gateway supports IPv6 access.

      If Status is disabled, access from all IP addresses is allowed by default. If Status is enabled and no IP address is configured in Whitelist, access from any IP address is denied. If Status is enabled and no IP address is configured in Blacklist, access from any IP address is allowed.

      For security group policies, and gateway and API access control policies, the "Deny" settings take precedence over the "Allow" settings.

    Inbound Access
    • VPC Access Address
    • EIP
      • To bind an EIP to the gateway, click Enable.
      • To copy the bound EIP, click .
      • Modify the bandwidth as required. The bandwidth is billed by hour based on the rate of the EIP service.
      • To unbind the EIP from the gateway, click Unbind EIP.

    Outbound Access

    Determine whether to allow backend services of the APIs created in the gateway to be deployed on public networks. You can enable or disable outbound access at any time.

    After enabling outbound access, you can click View Metrics to view the monitoring data, or modify the bandwidth as required.

    Routes

    Configure a private network segment that needs to communicate with the gateway. After a gateway is created, it can communicate with the VPC subnet specified during gateway creation by default.

    Configure routes at your premises if the subnet of your data center is within the following three segments: 10.0.0.0/8-24, 172.16.0.0/12-24, and 192.168.0.0/16-24.

Parent topic: Managing APIG Gateways