DocsICP FilingConsole
官方文档
首页

Network configuration

更新时间：
复制 MD 格式
产品详情
我的收藏

Configure the network gateway to enable communication between applications and data services before calling APIs.

Feature description

The gateway configurations for each deployment environment are as follows:

  • In a public cloud multitenancy environment, all gateway-related configurations are written to the database during deployment. Business tenants only need to configure the visibility of second-level domains. You can also bind independent domains and configure a VPC ID as needed. A VPC ID enables API calls from the VPC network without public network access. After binding an independent domain, you can use it to access APIs.

  • In a private cloud independent deployment environment using the built-in gateway, configure the gateway domain name in the metadata warehouse tenant under Management Hub > System Settings > DataService Studio Settings so that users can view the call domain name.

  • If you have purchased the Tag Factory feature, the system displays the domain name of the built-in gateway by default, and no manual configuration is required.

Permission description

Only super administrators and system administrators can configure networks.

Network configuration entry

  1. In the top menu bar of the Dataphin home page, select Service > Management.

  2. Click Network Configuration in the navigation pane on the left to enter the Network Configuration page.

  3. On the Network Configuration page, select Built-in API Gateway or Alibaba Cloud API Gateway. Once selected, the gateway cannot be changed.

    • Built-in Gateway: Provides services quickly without additional costs.

    • Alibaba Cloud API Gateway: A high-performance, high-availability API hosting service with good configurability and compatibility for cross-VPC access and public network access.

View domain names

Alibaba cloud API gateway

Alibaba Cloud gateway timeout

When the network is configured as Alibaba Cloud Public Cloud API Gateway , you can configure the gateway timeout.

The timeout monitors the duration of API calls. Set an integer between 1 and 60 seconds. Click Save, and then in the Modify Gateway Timeout dialog box, click OK. The configuration takes effect immediately.

Important

  • This configuration applies to all APIs. Excessively long timeout periods affect the overall QPS (queries per second) of the data service. Proceed with caution. For more information, see .

  • APIs under the current tenant are governed by both the Alibaba Cloud gateway timeout and the timeout configured when creating the API.

Second-level domain

In the Subdomain area, you can control domain name visibility for users: Visible To Super Administrators Only or Visible To All Users. You can also enable or disable public second-level domains and copy public second-level domains and internal VPC domain names.

Note

  • Dataphin by default provides second-level domains for testing.

  • Public second-level domains support API calls (including debugging and testing APIs) with a daily limit of 1,000 calls. For production use, bind an independent domain to remove the call limit. Because public second-level domains are intended for internal testing only, we recommend disabling their display to prevent misuse by application developers.

  • Internal VPC domain names are used for inter-VPC calls with no call limit.

  • The API gateway assigns public and internal VPC domain names for each API group. These domain names cannot be modified.

  • If the domain name display is incorrect, contact the Dataphin O&M team.

Bind independent domain

  1. In the Bind Independent Domain area, click the Bind Domain button to enter the Bind Domain dialog box.

    image

  2. In the Bind Domain dialog box, configure the parameters.

    Parameter

    Description

    Domain Name

    Only domain names that have been ICP filed with Alibaba Cloud are supported. Example: dataphin.aliyun.com.

    Environment

    Select Production Environment to use the domain name for production API calls.

  3. Click Confirm to complete the binding of the domain name.

  4. Add an SSL certificate.

    1. Click SSL Certificate column's Add.

    2. In the Add Certificate dialog box, configure the parameters.

      Parameter

      Description

      Certificate Name

      Enter the certificate name.

      Certificate Content

      Enter the certificate content. An example is as follows.

      -- BEGIN CERTIFICATE --
MIFRFGJLyrqtqWEE00cozR1pZ + ultKTANDFFLF9wddddddBGGTFAD
-- END CERTIFICATE --

      Private Key

      Enter the certificate private key. An example is as follows.

      -- BEGIN RSAPRIVATE KEY --
ARTMIFRFGJLyrqtqWEE00cozR1pZultcvfsgsgsrAwREWDCFFGGCuD
-- END RSAPRIVATE KEY --

    3. Click Confirm to complete the addition of the SSL certificate.

      You can click the Actions column's 删除图标 icon to delete the independent domain.

Authorize VPC

Note

When domain name visibility is set to all users and VPC authorization is configured, APIs can be accessed through the internal VPC domain name from the authorized VPC.

In the Authorize VPC area, click Add, then click VPC ID Acquisition Method Description to learn how to obtain the VPC ID. To add multiple VPC IDs, click Add VPC ID, enter the VPC ID, and click Save.

You can click the Actions column's 删除图标 icon to delete the VPC.

image

Appendix: Description

Click Description in the upper-right corner to view information about second-level domains, internal VPC domain names, binding independent domains, and authorizing VPC.

Previous：Data Service system configurationNext：API Development