Resizing a Graph (2.2.21)
Function
This API is used to resize a graph.
Database edition graphs cannot be resized by calling this API.
URI
POST /v2/{project_id}/graphs/{graph_id}/resize
|
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 |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
Definition User token. Used to obtain the permission to use 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 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
resize |
Yes |
resize object |
Definition Defines the graph resize operation, including all relevant parameters for resizing. Constraints N/A Range N/A Default Value N/A |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
job_id |
String |
Definition ID of the graph resize 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 Job Management APIs. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Definition System prompt.
Range N/A |
|
error_msg |
String |
Definition System prompt.
Range N/A |
Example Request
Resize a graph. The graph size is Ten-million-edge.
POST https://{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: 404
Example response for a failed request
{
"error_msg": "Cluster does not exist or has been deleted.",
"error_code": "GES.0047"
}
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
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot