Applications can call APIs in the production environments of different service projects. This topic describes how to create and manage your applications.
Permission description
Regular members can request to create and manage their applications. An application is created only after the request is approved.
Application owners can manage their applications and application members, and reset the AppSecret.
Access the My Applications page
You can access the My Applications page in two ways.
Method 1:
In the top menu bar of the Dataphin home page, choose Service > Application Management.
In the navigation pane on the left, click My Applications.
Method 2:
In the upper-right corner of the Dataphin console, click your profile picture to open the User Center, and then click Personal Data Center.
In the navigation pane on the left, click My Applications. You are redirected to the My Applications page, located under Service > Application Management.
Request to create an application
On the My Applications page, click + Request to Create Application in the upper-right corner.
In the Request to Create Application dialog box, configure the parameters.
Parameter
Description
Application Name
Input the application name adhering to the following naming convention:
Can contain Chinese characters, letters, numbers, and underscores (_).
Must start with a Chinese character or a letter.
Must be 4 to 26 characters in length.
Must be unique within the application group.
Application Group
Select an existing application group. You can search for application groups by keyword.
Scenario
Enter the use case for the application. This helps business personnel understand the application. The description cannot exceed 128 characters.
Application Owner
Select the owners for the application. The owners are responsible for routine management, such as editing or deleting the application, adding or deleting application members, and resetting the AppSecret. You can select multiple members who have been added to Dataphin on the Member Management page in the Management Hub.
Custom Key
This parameter is available when the network is configured as Alibaba Cloud API Gateway (shared/dedicated instance) or a built-in gateway.
Use this to unify the keys for Dataphin applications and applications in third-party API management systems. This feature is disabled by default. When disabled, the system automatically generates a key. If you enable this feature, you must configure the AppKey and AppSecret.
AppKey/AppSecret: Enter the AppKey and AppSecret. They can contain letters, numbers, underscores (_), and hyphens (-). The length must be between 8 and 127 characters.
IP Whitelist-based Invocation
This parameter is available only when the network is configured as a built-in gateway. This feature is disabled by default. If you enable this feature, you must specify IP addresses.
IP Address
Enter IP addresses based on the network architecture. You can enter IP addresses or Classless Inter-Domain Routing (CIDR) blocks. Separate multiple entries with semicolons (;). Each IP address must be unique. You can enter a maximum of 100 entries. If you use a CIDR block, append a forward slash (/) and a number from 1 to 32 to the end of the IP address. Example:
192.168.3.12/24.NoteEnter the local IP address of the server first. If you call an API from an IP address that is not in the whitelist, the system prompts you to add the IP address.
Click OK to submit the request for approval. Once approved, the application is created and appears on the Application Management page under Service > Application Management.
Manage my applications
On the My Applications page, you can view the My and Not Joined application lists.
My: Displays the applications for which you are an owner. You can edit the application, manage its members, or delete it.
Not Joined: Displays the applications for which you are not an owner. You can request to join an application or view your join requests.
You can search for applications by name or AppKey, or filter applications by group.
My applications
This list shows the application name, application group, owner, number of authorized APIs, number of authorized data sources, AppKey, AppSecret, last update time, your role, and renewal or expiration date. You can also perform the following operations on an application in the list.
Area
Description
AppSecret
You can display, hide, copy, or reset the AppSecret.
Reset: When the network is configured as Alibaba Cloud API Gateway (shared/dedicated instance) or a built-in gateway, click Reset. In the Reset Key dialog box, reset the AppKey password. You can choose to automatically generate a new password or create a custom one. Click OK to complete the reset.
Auto-generate: The system automatically generates a new password.
Custom: Enter a new password. The format must follow the same rules as when you create a new application.
ImportantBe aware that resetting the AppSecret will disrupt the current application SDK. Coordinate with relevant personnel immediately to prevent business operation issues.
Set IP Whitelist
You must first enable the application IP whitelist in the API call authentication configuration before you can set the IP whitelist. Click the Set IP Whitelist icon in the Actions column. In the Application IP Whitelist Configuration dialog box, select Disable or Enable for the IP whitelist, and then click OK.
NoteOnce enabled, only IP addresses on the whitelist can invoke the API without additional authentication.
Edit
Click the Edit icon in the Actions column. In the Edit Application dialog box, modify the application configuration, and then click OK.
Member Management
Click the Member Management icon in the Actions column. In the Member Management panel, click Add Member. In the Add Member dialog box, enter the username and validity period, and then click OK.
Username: Select users who have not joined the application and are not owners of the application. You can select multiple users.
Validity Period: Select a validity period for the member. You can select 30 Days, 90 Days, 180 Days, Permanent, or Custom.
NoteThe administrator (the current user) can edit or delete regular members. The administrator cannot edit or delete their own account.
Delete
Click the Delete icon in the Actions column to delete the application. This operation is irreversible. Proceed with caution.
Not Joined applications
This list shows the application name, AppKey, group, and owner. You can also perform the following operations on an application in the list.
Request To Join: Click the Request To Join icon in the Actions column. In the Request To Join Application dialog box, set the validity period, provide a reason for the request, and click OK. After the request is approved, the application appears in the My Applications list.
Validity Period
Reason for Request: Enter the reason for your request. This information helps the approver review the request. The reason cannot exceed 500 characters.
View Request: After you submit a request to join an application, you can click the View Request icon in the Actions column to navigate to the Task Hub and view the approval progress.