Adding Vertices in Batches

Function

This API is used to add vertices in batches.

URI

• URI format

  POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-add

• Parameter description

  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

• Request example

  POST
  http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-add
  {
      "vertices": [
          {
              "vertex": "150",
              "label": "movie",
              "properties": {
                  "movieid": [
                      "150"
                  ],
                  "title": [
                      "testmoive"
                  ],
                  "genres": [
                      "Comedy"
                  ]
              }
          },
          {
              "vertex": "6",
              "label": "movie",
              "properties": {
                  "movieid": [
                      "6"
                  ],
                  "title": [
                      "testmoive_exist_id"
                  ],
                  "genres": [
                      "Comedy"
                  ]
              }
          }
      ],
      "overrideExists": true
  }

  

  • SERVER_URL: Address for accessing a graph. For details about its value, see Constraints of Using Service Plane APIs.
  • In the example, if vertex 6 already exists in the graph, properties of vertex 6 are overwritten.
• Parameter description

  Table 2 Request body parameter description

  Parameter	Mandatory	Type	Description
  vertices	Yes	Json	Vertex array to be added. You are advised to add a maximum of 10,000 vertices at a time.
  overrideExists	No	Boolean	Whether to overwrite the existing vertices in the vertices parameter. The default value is false, indicating that existing vertices are ignored. For 100-billion-edge graphs, an error is reported for existing vertices. The value true indicates that existing vertices in the vertices parameter are overwritten.

  Table 3 vertices parameter description

  Parameter	Mandatory	Type	Description
  vertex	Yes	String	Vertex ID
  label	Yes	String	Vertex label
  properties	No	Json	Value of each property

Response

• Parameter description

  Table 4 Parameter description

  Parameter	Mandatory	Type	Description
  errorMessage	No	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	No	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
  result	No	String	If the execution is successful, the value of result is success.

• Response example (successful request)

  Http Status Code: 200
  {
  "result": "success"
  }

• Response example (failed request)

  Http Status Code: 400
  {
  "errorMessage": "vertex [Lily] already exists",
  "errorCode": "GES.8000"
  }

Return Value

• Normal

  200

• Abnormal