Updated on 2024-12-03 GMT+08:00

Creating a Graph

URI

POST /ges/v1.0/{project_id}/graphs
Table 1 URI parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

graphName

Yes

String

Graph name. The value can contain 4 to 32 characters and must start with a letter. Only letters, digits, and underscores (_) are allowed.

idType

Yes

String

ID type. The options are hash, fixedLengthString, and varString.

idLength

No

Integer

This parameter is mandatory if idType is fixedLengthString. The value ranges from 1 to 128.

sortKeyType

Yes

String

Mandatory. The options are:

  • int: integer.
  • string: The value is a string that contains a maximum of 40 characters.
  • varString: The value is a variable-length string with no length limit.

The sort key type applies to the entire graph.

Response Parameters

Table 3 Response body parameters

Parameter

Type

Description

errorMessage

String

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.

errorCode

String

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.

result

String

Query result. If the query is successful, the value is success. If the query fails, the value is failed.

Example Request

POST /ges/v1.0/{project_id}/graphs
{
    "graphName": "xxx",
    "idType": "fixedLengthString",
    "idLength": 20,
    "sortKeyType":"varString"
}

Example Response

Status code: 200

Example response for a successful request

Http Status Code: 200
{
    "result": "success"
}

Status code: 400

Example response for a failed request

Http Status Code: 400
{
    "errorMessage": "graph [movie] already exists",
    "errorCode": "GES.8012",
    "result": "failed"
}

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.