Updated on 2024-01-04 GMT+08:00

Resizing a Graph

Function

This API is used to resize a graph instance.

After the graph is resized, you need to re-create all indexes.

URI

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

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

resize

Yes

resize object

Graph specifications after the graph is resized.

Table 4 resize

Parameter

Mandatory

Type

Description

graph_size_type_index

Yes

String

Graph flavor. Currently, the value can be 2, 3, 4, or 5, indicating 10-million-edge, 100-million-edge, 1-billion-edge, or 10-billion-edge, respectively.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

job_id

String

Indicates the ID of the resize 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 Job Management 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

Resize a graph instance. The graph size is ten-million-edge.

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

{
  "resize" : {
    "graph_size_type_index" : "2"
  }
}

Example Response

Status code: 200

Example response for a successful request

{
  "job_id" : "ff8080816025a0a1016025a5a2700007"
}

Status code: 400

Example response for a failed request

{
  "error_msg" : "graph [demo] is not found",
  "error_code" : "GES.8012"
}

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.