Help Center/ API Gateway/ User Guide/ API Management/ Binding a Domain Name
Updated on 2024-10-23 GMT+08:00
View PDF
Share

Binding a Domain Name

Before you expose an API, bind an independent domain name to the API group so that APIs in the group can be accessed with the domain name. A maximum of five independent domain names can be added, and the number of access times is not limited.

Independent domain names are classified into private and public domain names.

  • Private domain name: Service systems deployed on the cloud service platform can use private domain names to access APIs.
  • Public domain name: Service systems deployed outside the cloud service platform can use public domain names to access APIs.

For internal testing, use the debugging domain name (subdomain name) to access APIs in an API group (maximum 1,000 times a day). The debugging domain name cannot be modified.

  • Groups under the same gateway cannot be bound with a same independent domain name.
  • By default, the debugging domain name of an API group can only be resolved to a server in the same VPC as the gateway. If you want to resolve the domain name to a public network, bind an EIP to the gateway.
  • If the independent domain name you select is a wildcard domain name (for example, *.aaa.com), you can use any of its subdomain names (for example, default.aaa.com and 1.aaa.com) to access all APIs in the group to which the domain name is bound.

Constraints

  • If a domain name is already bound to a port, it cannot be bound to the same port again.
  • If different ports are used for the same domain name, all ports take effect no matter whether any of them are bound to, modified, or unbound from the SSL certificate or whether client authentication is enabled or disabled.
  • If you access backend services through a load balance channel, the port bound to the independent domain name must be the same as the access port of the backend server in the load balance channel.
  • After an independent domain name is bound to a port, if you use an IP address to access an API, you need to add the header parameter host to the request. The host value should include the port number for the access protocol, unless you are using the default ports 80 or 443, in which case the host value is not necessary.

Obtaining Domain Names

  • To enable a service system on the cloud service platform to access APIs, obtain a private zone as an independent domain name.
    1. Apply for a private network domain name. For details, see Creating a Private Zone
    2. Configure an A record set to map the domain name to the inbound access address of your gateway. For details, see Adding an A Record Set
    3. If the API group contains HTTPS-compatible APIs, add an SSL certificate for the independent domain name bound to the group. Obtain the content and keys of the SSL certificate and create an SSL certificate in advance.
  • To enable a service system outside the cloud service platform to access APIs, obtain a public zone as an independent domain name.
    1. Apply for a public zone from Domain Registration.
    2. Configure a CNAME record set for the API group subdomain name. For details, see Adding a CNAME Record Set.
    3. If the API group contains HTTPS-compatible APIs, add an SSL certificate for the independent domain name bound to the group. Obtain the content and keys of the SSL certificate and create an SSL certificate in advance.

Procedure

  1. Go to the APIG console.
  2. Select a dedicated gateway at the top of the navigation pane.
  3. Choose API Management > API Groups.
  4. Click a group name.
  5. Click the Group Information tab.
  6. In the Independent Subdomain Names area, click Bind Independent Domain Name. Then configure the domain name information.

    Table 1 Independent domain name configuration

    Parameter

    Description

    Domain Name

    Domain name to be bound to the API group.

    Minimum TLS Version

    The minimum TLS version that can be used to access the domain name. TLS 1.1 and TLS 1.2 (recommended) are supported.

    This parameter applies only to HTTPS and does not take effect for HTTP and other access modes. Configure HTTPS cipher suites using the ssl_ciphers parameter on the Parameters tab.

    HTTP-to-HTTPS Auto Redirection

    Whether to support HTTP-to-HTTPS redirection.

    Redirection takes effect only when the API request protocol is HTTPS or HTTP&HTTPS and an SSL certificate has been bound to the independent domain name.

    NOTE:

    Redirection is only suitable for GET and HEAD requests. Redirecting other requests may cause data loss due to browser restrictions.

    HTTP Port

    The default value is 80, which is the default HTTP port number. You can customize the inbound port. For details, see Custom Inbound Port. If the HTTP port is not used, select suspend.

    HTTPS Port

    The default value is 443, which is the default HTTPS port. You can customize the inbound port. For details, see Custom Inbound Port. If the HTTPS port is not used, select suspend.

  7. Click OK.

    If the domain name is no longer needed, click Unbind Domain Name to unbind it from the API group.

  8. (Optional) If the API group contains HTTPS APIs, bind an SSL certificate to the independent domain name.

    1. In the row that contains the domain name, click Select SSL Certificate.
    1. Select an SSL certificate and click OK.
      • If a CA certificate has been uploaded for the SSL certificate, you can enable client authentication (HTTPS two-way authentication). Enabling or disabling client authentication will affect the existing services. Exercise caution when performing this operation.
      • If no SSL certificate is available, click Create SSL Certificate to create one. For details, see SSL Certificates.

Troubleshooting

  • Failure in binding an independent domain name: It already exists or is not CNAMEd to the debugging domain name of the API group.
  • Failure in binding an SSL certificate: The domain name used to generate the SSL certificate is different from the target independent domain name.

Follow-Up Operations

After binding independent domain names to the API group, create APIs in the group to selectively expose backend capabilities. For details, see Creating an API.

Parent topic: API Management