Updated on 2024-05-23 GMT+08:00

Expanding a Graph (2.2.23)

Function

This API is used to expand multiple secondary nodes dynamically. The expanded secondary nodes can process read requests, improving read performance.

  • This API is not supported by graphs of the Ten-thousand-edge and Ten-billion-edge types.
  • The sizes of graphs cannot be changed after expansion.
  • To resize and expand a graph, first resize it and then expand it.
  • Graphs of the database edition cannot be expanded by calling this API.

URI

POST /v2/{project_id}/graphs/{graph_id}/expand

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

graph_id

Yes

String

Graph ID

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It is used to obtain the permission to call APIs. For details about how to obtain the token, see Authentication. The value of X-Subject-Token in the response header is the token.

Table 3 Request body parameter

Parameter

Mandatory

Type

Description

expand

Yes

expand object

expand is an object.

Table 4 expand

Parameter

Mandatory

Type

Description

replication

Yes

Integer

Number of new nodes to expand

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

job_id

String

ID of the expansion job. This parameter is left blank when the request fails.

NOTE:

You can view the job execution status and obtain the return result by querying the job ID. For details, see Task Center APIs.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

System prompt code.

  • If execution succeeds, this parameter may be left blank.
  • If execution fails, this parameter is used to display the error code.

error_msg

String

System prompt code.

  • If execution succeeds, this parameter may be left blank.
  • If execution fails, this parameter is used to display the error message.

Example Request

Expand a graph. The number of new replicas is 1.

POST http://Endpoint/v2/{project_id}/graphs/{graph_id}/expand

{
    "expand":{
    "replication": 1
  }
}

Example Response

Status code: 200

Example response for a successful request

{
  "job_id" : "ff8080816025a0a1016025a5a2700007"
}

Status code: 400

Example response for a failed request

{
  "error_code" : "GES.7015",
  "error_msg" : "The graph is not running or stopped."
}

Status Codes

Return Value

Description

400 Bad Request

Request error.

401 Unauthorized

Authorization failed.

403 Forbidden

No operation permissions.

404 Not Found

No resources found.

500 Internal Server Error

Internal server error.

503 Service Unavailable

Service unavailable.

Error Codes

See Error Codes.