Expanding a Graph (2.2.23)

This API is used to dynamically expand multiple secondary nodes to enable concurrent handling of increased read requests.

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Constraints N/A Range The value can contain up to 64 characters. Only letters and digits are allowed. Default Value N/A
graph_id	Yes	String	Definition Graph ID. Constraints N/A Range N/A Default Value N/A

**Table 2** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. It is used to obtain the permission to call APIs. For how to obtain the token, see Authentication. (The token is the value of X-Subject-Token in the response header.) Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameter
Parameter	Mandatory	Type	Description
expand	Yes	expand object	Definition Defines the graph expansion operation, including all relevant parameters for expansion. Constraints N/A Range N/A Default Value N/A

**Table 4** expand
Parameter	Mandatory	Type	Description
replication	Yes	Integer	Definition Number of secondary nodes. Constraints N/A Range N/A Default Value N/A

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
job_id	String	Definition ID of the expansion job. This parameter is left blank when the request fails. Range N/A 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	Definition System prompt. If the execution succeeds, this parameter may be left blank. If the execution fails, this parameter is used to display the error code. Range N/A
error_msg	String	Definition System prompt. If the execution succeeds, this parameter may be left blank. If the execution fails, this parameter is used to display the error message. Range N/A

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

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

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

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."
}