All Products
Search

This Product

    Vector Retrieval Service:Manage API keys

    Document Center

    Vector Retrieval Service:Manage API keys

    Last Updated:Sep 05, 2024

    This topic describes how to create, view, and delete an API key in the DashVector console.

    Prerequisites

    • An Alibaba Cloud account is created. To create an Alibaba Cloud account, click here.

    • Your identity or enterprise is verified. To complete real-name verification, click here.

    • A cluster is created. For more information, see Create a cluster.

    Create an API key

    1. Log on to the DashVector console.

    2. In the left-side navigation pane, click API Keys. On the page that appears, click Create API Key.image.png

    3. In the Create API-KEY dialog box, click Copy and save your API key properly. This API key can be used to call the DashVector API.image.png

    View an API key

    After an API key is created and you close the dialog box, you can find the created API key on the API Keys page and click View in the Actions column. Complete the security verification, and then you can view the created API key.

    Important

    For security reasons, if you want to view a created API key after the Create API-KEY dialog box is closed, you must complete the identity verification.

    1. On the API-KEY Management page, click View in the Operation column of the API key that you want to view.image.png

    2. After the verification is passed, you can view the details of the API key.image.png

    Delete an API key

    If you want to create another API key but three API keys already exist, you can delete one by clicking Delete in the Actions column of the API key that you want to delete on the API Keys page. In the message that appears, click OK.

    Warning

    DashVector performs call authentication and metering and billing based on an API key. If an API key is deleted, subsequent calls based on the API key will be rejected. Proceed with caution.

    image.png

    Protect and use your API key properly

    Important

    An API key is used to access DashVector and must be kept properly. Do not expose your API key to external channels outside Alibaba Cloud. Otherwise, security risks or capital loss may occur due to unauthorized use.

    • DashVector performs call authentication and metering and billing based on an API key. You can manage API keys only by using your Alibaba Cloud account, and you can create up to three valid API keys within an account. Do not share API keys with unauthorized developers.

    • To prevent abuse of the API key create operation, you can perform up to 10 create operations per day by using an Alibaba Cloud account.

    • To protect API keys from being leaked, we recommend that you call API operations from a server. API calls from clients such as browsers, apps, and mini programs may cause leaks of API keys.