Dataphin OpenAPI AccessKey management

更新时间:
复制 MD 格式

Create and manage AccessKey credentials for authenticating Dataphin OpenAPI calls.

Prerequisites

The OpenAPI value-added feature is activated.

Limits

You can create up to two AccessKeys.

OpenAPI call instructions

  1. On the Dataphin page, click your profile picture in the upper-right corner, then click User Account.

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

  3. The Accesskey Management page displays OpenAPI call addresses.

    • OpenAPI Call Address: Displays the server endpoint (domain name). Click the copy icon to copy it. Click Download OpenAPI SDK to download the SDK file.

    • Changes to OpenAPI calls take up to 30 minutes to take effect.

Create AccessKey

  1. On the Accesskey Management page, click Create Accesskey in the AccessKey list area.

  2. The Create Accesskey dialog box displays a confirmation.

    Important

    Download the AccessKey file immediately. After the dialog box closes, the AccessKey ID and AccessKey Secret cannot be retrieved.

    image

    Block

    Description

    Show or hide the AccessKey ID and AccessKey Secret.

    Download AccessKey information in CSV format.

    Close the current window.

Manage AccessKey

  1. On the Accesskey Management page, view your AccessKeys in the AccessKey list area.

  2. You can enable or delete AccessKeys from this list.

    Feature

    Description

    Modify enable status

    Toggle the switch in the enable status column. The AccessKey becomes invalid 30 minutes after you disable it.

    Delete

    Click the delete icon in the Actions column. The AccessKey becomes invalid 30 minutes after deletion. After that, OpenAPI calls using this AccessKey return the error: Illegal Accesskey, Please Check Whether The Accesskey Exists Or Is In An Enabled State.

    Important

    Deletion is irreversible.