Data service settings - Dataphin - Alibaba Cloud Documentation Center

Gateway configurations vary depending on the deployment environment. To avoid repetitive setup, you can use data service settings to centralize basic gateway configurations. This topic describes how to configure these settings.

Prerequisites

The data service settings feature is available only if you have purchased the Data Service or Tag Factory feature module and your Dataphin instance is deployed in one of the following environments: a semi-managed public cloud dedicated instance, a public cloud independent deployment, or a private cloud independent deployment.

Limits

You can configure a built-in gateway for Dataphin instances that are deployed in semi-managed public cloud dedicated instances or independent deployments (private and public cloud).
The built-in gateway supports a maximum of 20 domain names, including one default domain name.
Only traditional API Gateway, which includes shared and dedicated instances, is supported. If you use a shared instance to configure domain names and log collection, the instance and the Server Load Balancer (SLB) service must be in the same VPC as Dataphin. Otherwise, you must establish network connectivity. If you use a dedicated instance, the instance and the SLB service must be in the same region as Dataphin.

Permission description

Only super administrators and system administrators of a metadata warehouse tenant can modify data service settings.

Procedure

On the Data Service Settings page, configure the parameters for Alibaba Cloud API Gateway and Built-in Gateway.

Alibaba Cloud API Gateway

Log on to the metadata warehouse tenant as a super administrator or system administrator.
In the top menu bar of the Dataphin home page, choose Management Center > System Settings.

In the navigation pane on the left, choose System Settings > Data Service Settings. On the Data Service Settings page, click the Alibaba Cloud API Gateway tab. Then, click the Edit button at the bottom of the page to configure the parameters.

Parameter		Description
API Gateway Configuration	Service Endpoint	Enter the service access point for API Gateway. We recommend that you use the VPC access address in the same region where Dataphin is deployed. Service access points differ by region. For more information, see Service access point.
	AccessKey ID and AccessKey Secret	Enter the AccessKey ID and AccessKey secret for your Alibaba Cloud account (primary account). For instructions on how to obtain these credentials, see Create an AccessKey pair. After you enter the credentials, click Test Connection to check the connectivity.
	Gateway Instance	The system retrieves the API Gateway instances, including shared and dedicated instances, based on the Service Endpoint, AccessKey ID, and AccessKey Secret.
	SLB ID	The load balancer for the backend applications of Data Service. During system initialization, the system automatically creates a VPC authorization in API Gateway. The authorization includes the VPC ID, SLB ID, and port number.
Gateway Log Collection	API Gateway Log Delivery	This feature is disabled by default. The configuration items are optional when this feature is disabled. If you enable this feature, you must configure the information for log collection. Note You must enable log delivery for API Gateway in advance. For more information, see Use Simple Log Service to view API call logs.
	Service Endpoint	Enter the endpoint for Simple Log Service, such as `cn-<region>.log.aliyuncs.com`. Note Replace <region> with the region where Dataphin is deployed.
	AccessKey ID and AccessKey Secret	Enter the AccessKey ID and AccessKey Secret of your Alibaba Cloud account (primary account). For instructions on how to obtain these credentials, see Create an AccessKey pair. After you enter the credentials, click Test Connection to check the connectivity of the Simple Log Service AccessKey pair.
	Project	The system retrieves the projects based on the Service Endpoint, AccessKey ID, and AccessKey Secret for the logs.
	Logstore	You can select a Logstore only after you select a project.

Click the OK And Set button to complete the Alibaba Cloud API Gateway configuration.

Built-in gateway

The domain names that you configure for the built-in gateway are displayed only on the Data Service > Management > Network Configuration page. You can bind the domain names yourself or contact Dataphin Operations and Maintenance (O&M) engineers for assistance.

The default system domain name is dataphin-service.xxxx.svc. You cannot edit or delete this domain name, but you can change its display order and status. This domain name is used for testing and debugging Data Service APIs. After you configure the official domain name for API calls, add it to the domain name list in the built-in gateway and hide the default domain name. You can view the official domain name on the Data Service > Management > Network Configuration page.

Log on to the metadata warehouse tenant as a super administrator or system administrator.
In the top menu bar of the Dataphin home page, choose Management Center > System Settings.
In the navigation pane on the left, choose System Settings > Tenant Settings. On the Data Service Settings page, click the Built-in Gateway tab. Then, click the Edit button at the bottom of the page to configure the parameters.

The domain name list displays the name, domain, and IP address for each domain name. You can perform the following operations on the domain names.

Parameter	Description
Display Domain Name	If you enable this switch, the domain name is displayed on the network configuration page of Data Service. If you disable this switch, the domain name is not displayed.
Add Domain Name	Click the + Add Domain Name button. Configure the name, domain, and IP address. Then, click the save icon in the Actions column to save the configuration. Domain Name: Required. Enter a name for the domain name. The name can be up to 128 characters in length and must be unique. Domain: Required. Enter the domain name. The domain name must be unique. Example: `dataphin-service.aliyun.com`. IP Address: Optional. Enter one or more IP addresses. Separate multiple IP addresses with commas (,). Enter IP addresses based on your network architecture. You can contact Dataphin O&M engineers for assistance. This IP address configuration is for display only on the Data Service > Management > Network Configuration page. It does not trigger DNS configuration updates or modify local resolution files, such as the hosts file.
Edit	Click the edit icon in the Actions column to modify the name, domain, IP address, and display status of the domain name.
Pin To Top	Click the pin icon in the Actions column or drag the icon next to the domain name to drag and sort. The new order will be reflected on the DataService Studio > Management > Network Configuration page.
Delete	Click the delete icon in the Actions column to delete the domain name. This operation cannot be undone. Proceed with caution.

Click the Save button to complete the built-in gateway configuration.