Help Center/ Graph Engine Service/ API Reference/ Calling APIs/ Making an API Request/ Making a Service Plane API Request
Updated on 2025-10-24 GMT+08:00
View PDF

Making a Service Plane API Request

This section describes the structure of a REST API on the service plane of GES.

Request URI

A request URI of a service plane API of GES is in the following format:

{URI-scheme} :// {SERVER_URL} / {resource-path} ? {query-string}

Although a request URI is included in the request header, most programming languages or frameworks require the request URI to be transmitted separately.

  • URI-scheme: Protocol used to transmit requests. All APIs use HTTPS.
  • SERVER_URL: Address for accessing a graph. For details about its value, see Using Service Plane APIs.
  • resource-path: Access path of an API for performing a specified operation. Obtain the value from the URI module of the API, for example, ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=query.
  • query-string: Query parameter, which is optional. Ensure that a question mark (?) is included before each query parameter that is in the format of "Parameter name=Parameter value". For example, ? limit=10 indicates that a maximum of 10 data records will be displayed.

Request Methods

The HTTP protocol defines the following request methods that can be used to send a request to the server:

  • GET: requests the server to return specified resources.
  • PUT: requests the server to update specified resources.
  • POST: requests the server to add resources or perform special operations.
  • DELETE: requests the server to delete specified resources, for example, an object.
  • HEAD: same as GET except that the server must return only the response header.
  • PATCH: requests the server to update partial content of a specified resource. If the resource does not exist, a new resource will be created.

Request Header

You can also add additional header fields to a request, such as the fields required by a specified URI or HTTP method. For example, to request for the authentication information, add Content-Type, which specifies the request body type.

Common request header fields are as follows:
Table 1 Common request headers

Parameter

Mandatory

Description

Example

Content-Type

Yes

Specifies the request body type or format. This field is mandatory and its default value is application/json. Other values of this field will be provided for specific APIs if any.

application/json

X-Auth-Token

Yes

Specifies a user token only for token-based API authentication.

-

X-Language

Yes

Request language

en-us

Request Message Body

The body of a request is often sent in a structured format as specified in the Content-Type header field. The request body transfers content except the request header.

Request bodies vary with APIs. Some APIs do not require a request body, such as the APIs using GET and DELETE methods.

For the IAM API that is used to obtain a user token, obtain the request parameters and parameter description in the API request. The following provides an example request with a body included. Replace username, domainname, ******** (login password), and xxxxxxxxxxxxxxxxxx (project name) with the actual values.

At this point, all the necessary data for making the request is in place. You can send the API call by directly writing code. For the IAM API that is used to obtain a user token, the response header will include a field called x-subject-token, which contains the required user token. Once you have obtained the token, you can use it for authentication when calling other APIs.

Parent topic: Making an API Request