Updated on 2024-11-25 GMT+08:00

Obtaining Initialization Parameters

Authentication Mode

When using the service-plane SDK, you need to prepare the necessary parameters for client initialization in advance. GES offers two authentication modes, and you can choose either one.

  • Token-based authentication: Obtain a token authentication request using a username and password.
  • AK/SK-based authentication: Requests are authenticated by encrypting the request body using an AK/SK.

AK/SK-based authentication is recommended as it provides higher security.

Obtaining Initialization Parameters

Table 1 Initialization parameters

Parameter

Mandatory

Description

Source

graphEndPoint

Yes

Graph access address

Log in to the GES console. In the navigation pane on the left, choose Graph Management. The value of this parameter is the Internal Access Address or External Access Address value of the graph you want to access.

graphName

Yes

Graph name

The value of this parameter is the Name/ID value of the graph you want to access on the Graph Management page of the GES console.

ak

No. Mandatory for AK/SK-based authentication.

Access key

  1. Log in to the management console. In the upper right corner of the page, hover over the username and choose My Credentials from the drop-down list. The My Credentials page is displayed.
  2. In the navigation pane on the left, choose Access Keys.

sk

No. Mandatory for AK/SK-based authentication.

Secret key used together with the access key ID

regionCode

No. Mandatory for AK/SK-based authentication.

Project the graph belongs to

  1. Log in to the management console. In the upper right corner of the page, hover over the username and choose My Credentials from the drop-down list. The My Credentials page is displayed.
  2. View the project ID in the project list.

domainName

No. Mandatory for password-based authentication.

Domain name

IAM account used to log in to the management console

userName

No. Mandatory for password-based authentication.

Username

IAM username used to log in to the management console

password

No. Mandatory for password-based authentication.

Password

Password of the IAM username used to log in to the management console

projectId

No. Mandatory for password-based authentication.

Project the graph belongs to

  1. Log in to the management console. In the upper right corner of the page, hover over the username and choose My Credentials from the drop-down list. The My Credentials page is displayed.
  2. View the project ID in the project list.

iamEndPoint

No. Mandatory for password-based authentication.

Endpoint of the IAM service

You can obtain the region where the service is deployed by referring to Regions and Endpoints.

authToken

No. Mandatory for token-based authentication.

User token

You can obtain the token by calling the Obtaining a User Token API.