Dataphin:Dataphin OpenAPI AccessKey management

Prerequisites

You must have the OpenAPI value-added feature activated.

Limits

A maximum of two AccessKeys can be created.

OpenAPI call instructions

1. Navigate to the Dataphin page, click your profile picture in the upper right corner to access the user center, and then select User Account to proceed to the user center page.

2. In the left-side navigation pane, choose API Access > Accesskey Management to go to the Accesskey Management page.

3. On the Accesskey Management page, you can oversee OpenAPI call addresses.

   • OpenAPI Call Address: Shows server endpoint details, such as the domain name. You can replicate this information quickly by clicking the copy icon. The Download OpenAPI SDK button allows you to download the SDK file to your local machine.

   • Please note that changes to OpenAPI calls may take up to 30 minutes to become effective.

Create AccessKey

1. To create a new AccessKey, click Create Accesskey within the AccessKey list area on the Accesskey Management page.

2. After creating an AccessKey, a confirmation message will appear in the Create Accesskey dialog box.

   Important

   It is important to download the AccessKey file immediately. Once the dialog box is closed, the AccessKey ID and AccessKey Secret cannot be retrieved again.

   

   Block	Description
   ①	Display and hide AccessKey ID and AccessKey Secret information.
   ②	Download AccessKey information in CSV format.
   ③	Close the current window.

Manage AccessKey

1. AccessKey management is done on the Accesskey Management page, where you can oversee your AccessKeys in the AccessKey list area.

2. Here, you can view AccessKey details and perform actions such as enabling or deleting AccessKey entries.

   Feature	Description
   Modify enable status	Click the switch under the enable status column of the target AccessKey to modify the effective status of the AccessKey. It will become invalid 30 minutes after shutdown.
   Delete	Click the delete icon under the Actions column of the target AccessKey. The AccessKey will become invalid 30 minutes after deletion. After invalidation, the AccessKey cannot be used for authentication when invoking OpenAPI, and an exception message will be thrown: Illegal Accesskey, Please Check Whether The Accesskey Exists Or Is In An Enabled State. Important The delete operation cannot be revoked. Please proceed with caution.