Updated on 2023-04-10 GMT+08:00

Resizing a Graph (2.2.21)

Function

This API is used to resize a graph instance.

After the graph is resized, you need to re-create all indexes including composite indexes and full-text indexes.

URI

POST /v1.0/{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 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

resize

Yes

GraphSizeTypeIndexReq object

Graph specifications after the graph is resized.

Table 4 GraphSizeTypeIndexReq

Parameter

Mandatory

Type

Description

graphSizeTypeIndex

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. (graph_size_type_index)

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

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.

Example Request

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

{
  "resize" : {
    "graphSizeTypeIndex" : "2"
  }
}

Example Response

Status code: 200

OK

{ }

Status code: 400

Bad Request

{
  "errorCode" : "GES.7001",
  "errorMessage" : "The graph is not running."
}

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.