To enable network communication between applications and data services, you need to configure the network before calling the API. This topic describes how to configure the gateway.
Feature description
Different deployment environments require different API gateway configurations. You can configure common basic settings in the management center of the metadata warehouse tenant. For more information, see DataService Studio settings. The gateway configuration for different deployment environments is as follows:
In a public cloud independent deployment environment, both Alibaba Cloud API Gateway and built-in gateway are supported. Alibaba Cloud API Gateway supports setting the endpoint service access point, AccessKey ID, AccessKey secret, and gateway instance required to access the API gateway in the metadata warehouse tenant, and creating a VPC authorization name by specifying the SLB ID. Additionally, you can configure the SLS log collection instance for gateway logs to support log collection. If you use the built-in gateway, you need to enable public network access (requires purchasing and binding an EIP). To enable this feature, contact the Dataphin operations and maintenance team in advance for evaluation. The configuration method for the built-in gateway in public cloud independent deployment is the same as in the private cloud independent deployment environment.
In a private cloud independent deployment environment using a built-in gateway, you can configure the domain name of the built-in gateway in the metadata warehouse tenant's Management Hub > System Settings > DataService Studio Settings for users to 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
Super administrators and system administrators have the permission to configure networks.
Network configuration entry
In the top menu bar of the Dataphin home page, select Service > Management.
Click Network Configuration in the navigation pane on the left to enter the Network Configuration page.
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
Different gateways support viewing different domain names. Alibaba Public Cloud API Gateway - Dedicated Instance, Alibaba Public Cloud API Gateway - Shared Instance, and Alibaba Apsara Stack API Gateway support viewing public second-level domains and internal VPC domain names. Dataphin's self-developed gateway supports viewing the current tenant's domain names.
Alibaba cloud API gateway
Alibaba Cloud gateway timeout
When the network is configured as Alibaba Cloud Public Cloud API Gateway or Alibaba Cloud Apsara Stack API Gateway, you can configure the Alibaba Cloud gateway timeout.
This setting monitors the duration of API calls. You can configure an integer between 1-60 seconds. Click Save, and then in the Modify Gateway Timeout dialog box, click OK. The configuration takes effect immediately after completion.
The configuration will apply to all APIs. Excessively long timeout periods will affect the overall QPS (queries per second that can be processed) of the data service. Please operate with caution. For more information about gateway timeout configuration, see TCP Connection Timeout Configuration.
APIs under the current tenant will be controlled 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 user permissions to view domain names, supporting Visible To Super Administrators Only and Visible To All Users. Additionally, you can individually enable or disable public second-level domains and quickly copy public second-level domains and internal VPC domain names.
Alibaba Cloud API Gateway provides second-level domains for testing.
Public second-level domains support API calls (including debugging APIs and testing APIs) with a daily limit of 1000 calls. For official online calls, please bind an independent domain. After binding, there is no limit on the number of calls. Because public second-level domains are for internal testing only, it is recommended to disable display to prevent misuse by application developers.
Internal VPC is used for calls between VPCs with no limit on the number of calls.
The API gateway assigns public domain names and internal VPC domain names for each API group, which cannot be modified.
If the domain name display is incorrect, please contact the Dataphin operations and maintenance team.
Bind independent domain
In the Bind Independent Domain area, click the Bind Domain button to enter the Bind Domain dialog box.
In the Bind Domain dialog box, configure the parameters.
Parameter
Description
Domain Name
Only supports binding domain names that have been ICP filed with Alibaba Cloud. For example: dataphin.aliyun.com.
Environment
Select Production Environment to use the domain name for calling in the production environment.
Click Confirm to complete the binding of the domain name.
Add an SSL certificate.
Click SSL Certificate column's Add.
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 --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
When the domain name visibility is set to visible to all users and the VPC is authorized, access to the API through the internal VPC domain name from the authorized VPC is supported.
In the Authorize VPC area, click the Add button, then click VPC ID Acquisition Method Description to obtain the VPC ID. To add multiple VPC IDs, click the Add VPC ID button, enter the VPC ID, and click Save to complete the addition of the VPC ID.
You can click the Actions column's icon to delete the VPC.
Built-in gateway
On the Network Configuration page, you can view domain names. To edit domain names, please modify them in the metadata warehouse tenant. For more information, see DataService Studio settings.
If the domain name display is incorrect, please contact the Dataphin operations and maintenance team.
Appendix: Description
You can click the Description button in the upper right corner to view information about second-level domains, internal VPC domain names, binding independent domains, and authorizing VPC.