Making a Service Plane API Request

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.

Request Body

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

The request body varies according to APIs. Certain APIs do not require the request body, such as GET and DELETE.

For the Obtaining a User Token API, 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. You can obtain the endpoint by referring to Regions and Endpoints.

The scope parameter specifies where a token takes effect. You can set scope to an account or a project under an account. In the following example, the token takes effect only for the resources in a specified project. For more information about this API, see Obtaining a User Token.

If all data required for the API request is available, you can send the request to call the API through curl, Postman, or code. In the response to the API used to obtain a user token, x-subject-token is the desired user token. This token can then be used to authenticate the calling of other APIs.