Generating a Schema Structure

Function

This API is used to generate a schema structure where labels are represented with vertices and the relationship between the labels are represented with edges, and store the schema structure in an OBS bucket.

URI

• URI format

  POST /ges/v1.0/{project_id}/graphs/{graph_name}/schema/structure/build

• Parameters

  Table 1 URI parameter description

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Project ID, which is used for resource isolation. For details, see Obtaining a Project ID.
  graph_name	Yes	String	Graph name

Request

• Example request

  POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/schema/structure/build

Response

• Parameters

  Table 2 property parameter description

  Parameter	Type	Description
  errorMessage	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error message.
  errorCode	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
  job_id	String	ID of the vertex query job. This parameter is left blank when the request fails.

• Response example (successful request)

  {
      "jobId": "2e0c08e1-3fbb-4b33-8776-4809176068d7154236181",
      "jobType": 1
  }

• Response example (failed request)

  Http Status Code: 400
  {
      "errorMessage": "Bad Request ",
      "errorCode": "GES.8813"
  }

Return Value

• Normal

  200

• Abnormal

  Table 3 Return code for failed requests

  Return Value	Description
  400 Bad Request	Request error.
  401 Unauthorized	Authentication failed.
  403 Forbidden	No operation permission.
  404 Not Found	No resources found.
  500 Internal Server Error	Internal service error.