Data service settings - Dataphin - Alibaba Cloud Documentation Center

Data service settings streamline the gateway configuration process across different deployment environments, ensuring consistency and eliminating the need for repeated setup. This topic describes the steps for configuring data service settings.

Prerequisites

To utilize the data service settings feature, you must have purchased the data service or Tag Factory feature module. Additionally, the deployment environment for your Dataphin instance must be one of the following: a public cloud dedicated instance (semi-managed), public cloud independent deployment, or private cloud independent deployment.

Limits

For Dataphin instances deployed in public cloud dedicated instances (semi-managed) or independent deployments (private cloud and public cloud), configuring a built-in gateway is supported.
The built-in gateway allows for the addition of up to 20 domain names, including one default domain name.
Only traditional Alibaba Cloud API Gateway is supported, specifically Alibaba Cloud API Gateway - Original API Gateway (shared instance) or Alibaba Cloud API Gateway - Original API Gateway (dedicated instance). When using Alibaba Cloud API Gateway - Original API Gateway (shared instance) to configure domain names and log collection information, ensure that the purchased Alibaba Cloud API Gateway - Original API Gateway (shared instance) and SLB service are in the same VPC as Dataphin. Otherwise, network connectivity must be established. For Alibaba Cloud API Gateway - Original API Gateway (dedicated instance), ensure that the purchased instance and SLB service are in the same region as Dataphin.

Permission description

Only super administrators and system administrators of the metadata warehouse tenant are authorized to modify data service settings.

Procedure

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

Alibaba Cloud API Gateway

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

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

Parameter		Description
API Gateway Configuration	Service Access Point	Enter the service access point for the API Gateway. It is recommended to use the VPC access address in the same region as the Dataphin deployment. Service access points differ by region. For more information, see Service access point.
	AccessKey ID and AccessKey Secret	Provide the AccessKey ID and AccessKey Secret of the Alibaba Cloud account (primary account). For instructions on obtaining these credentials, see Create an AccessKey pair. Once entered, click Test Connection to verify the API Gateway AccessKey ID and AccessKey Secret connectivity.
	Gateway Instance	The system retrieves the API Gateway instance information, including shared and dedicated gateway instances, based on the Service Access Point, AccessKey ID, and AccessKey Secret.
	SLB ID	The system automatically creates the VPC authorization name, which includes the VPC ID, SLB ID, and port number, during system initialization for backend application load balancing of data services.
Gateway Log Collection	API Gateway Log Delivery	Log delivery is disabled by default and is not required unless enabled. If enabled, configure the gateway log collection details. Note Prior to enabling, activate log delivery for the API gateway. For details, see View API call logs through the log service.
	Service Access Point	Enter the log service access point, such as `cn-<region>.log.aliyuncs.com`. Replace <region> with the region where Dataphin is deployed. Note Replace the <region> placeholder with the actual region of your Dataphin deployment.
	AccessKey ID and AccessKey Secret	Provide the AccessKey ID and AccessKey Secret of the Alibaba Cloud account (primary account). For instructions on obtaining these credentials, see Create an AccessKey pair. Once entered, click Test Connection to verify the log service AccessKey ID and AccessKey Secret connectivity.
	Project	The system retrieves the project information based on the log Service Access Point, AccessKey ID, and AccessKey Secret.
	Logstore	Select a Logstore only after a project has been chosen.

Click Confirm And Set to finalize the Alibaba Cloud API Gateway configuration.

Built-in gateway

The domain name for the built-in gateway is solely for display purposes on the Data Service > Management > Network Configuration page. You may bind the domain name independently or seek assistance from Dataphin operation and maintenance staff.

The system's default domain name is dataphin-service.xxxx.svc, is immutable and cannot be edited or deleted but may be reordered and its status can be modified. This domain name is reserved for testing and debugging data service APIs. It is recommended that after configuring the official domain name for API calls, you add it to the domain name list in the built-in gateway and disable the display of the default domain name. You can view the official domain name for calls in Data Service > Management > Network Configuration.

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

The domain name list shows the name, domain name, and IP address information. Perform the following actions on the desired domain name:

Parameter	Description
Display Domain Name	Toggle this setting to control whether the domain name is visible on the data service's network configuration page. When disabled, the domain name will not be displayed.
Add Domain Name	To add a domain name, click the + Add Domain Name button. Enter the name, domain name, and IP address, then save the configuration by clicking the save icon in the Actions column. Domain Name: Mandatory. Input the name for the domain name, up to 128 characters. The domain name must be unique. Domain Name: Mandatory. Specify the domain name, ensuring it is unique. For instance, `dataphin-service.aliyun.com`. IP Address: Optional. Enter the IP address(es), separating multiple entries with commas. Enter different IP addresses based on your network architecture. You can contact Dataphin operation and maintenance personnel for assistance. This IP address configuration is only for display purposes in Data Service > Management > Network Configuration and will not trigger DNS configuration updates or modify local resolution files (such as Host configuration).
Edit	To edit a domain name, click the corresponding edit icon in the Actions column. You can modify the name, domain name, IP address, and display status.
Pin To Top	To rearrange the display order of domain names, click the pin icon in the Actions column or use the icon next to the domain name to drag and sort. The new order will be reflected on the Data Service > Management > Network Configuration page.
Delete	To remove a domain name, click the delete icon in the Actions column. Deletion is irreversible, so proceed with caution.

Click Save to finalize the built-in gateway configuration.