Updated on 2023-04-10 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.

  1. This API is not supported by graphs of the 10,000-edge and 10-billion-edge types.
  2. Graphs cannot be resized after expansion.
  3. If you want to resize and expand the graph, resize the graph before you expand it.

URI

POST /v1.0/{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 Parameters in the request header

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 parameters

Parameter

Mandatory

Type

Description

expand

Yes

ReplicationReq object

Expansion information

Table 4 ReplicationReq

Parameter

Mandatory

Type

Description

replication

Yes

String

Number of new nodes to expand

Response Parameters

Status code: 200

Table 5 Response body parameters

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 code.

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

jobId

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.

Example Request

POST http://Endpoint/v1.0/{project_id}/graphs/{graph_id}/expand

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

Example Responses

Status code: 200

OK

{
  "jobId" : "ff8080816025a0a1016025a5a2700007"
}

Status code: 400

Bad Request

{
  "errorCode" : "GES.7015",
  "errorMessage" : "The graph is not running or stopped."
}

Status Code

Status Code

Description

200

Request sent.

400

Request error.

401

Authentication failed.

403

No operation permission.

404

No resources found.

500

Internal service error.

503

Service unavailable.