Help Center/ Graph Engine Service/ User Guide/ Accessing a Graph Using a Graph Access Credential
Updated on 2025-12-29 GMT+08:00

Accessing a Graph Using a Graph Access Credential

GES introduces a new authentication credential called API key for accessing graphs.

Procedure

  1. Log in to the GES management console. In the navigation pane on the left, choose Graph Access Credentials.
  2. Click Create Graph Access Credential in the upper right corner. In the dialog box that appears, choose the user you want to associate with the graph.

    • Associated User: Select the IAM user to associate with. Note that this cannot be changed after creation.
    • Description: Add a description for the access credential. This can be updated later.
    Figure 1 Creating a graph access credential

    After filling in the description, click OK. The newly created API key will be saved in an automatically downloaded .txt file.

    Ensure you securely store the API key, as it cannot be recovered if lost.

  3. Click Associate with Graph in the Operation column of the access credential and select the graph instance to associate with.

    Figure 2 Clicking Associate with Graph
    • Only graphs of version 2.4.17 or later support association with access credentials.
    • Graphs must be in either the Running or Stopped state to allow association.
    • Access credentials associated with a graph cannot be deleted unless the association is removed first.
    • Association takes 1–2 minutes to take effect.
    • Due to caching design, disassociation requires 10–15 minutes to take effect.

  4. Once associated, navigate to Graph Management from the navigation pane on the left. On the Graph Management page, select the graph associated with the access credential and click Access. A certification method dialog box will appear.

    • Authentication Mode: Select API key.
    • API Key: Enter the API key obtained in 3.

    Click OK to access the graph editor.