Generating a Schema
Function
This API is used to generate a schema where labels are represented with vertices and the relationship between the labels are represented with edges, and store the schema in an OBS bucket.
URI
| 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_name | Yes | String | Graph name |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| errorMessage | String | System prompt.
|
| errorCode | String | System prompt code.
|
| jobId | String | ID of the vertex query job. This parameter is left blank when the request fails. |
| jobType | String | Type of an asynchronous job |
Example Request
Generate a schema where labels are represented with vertices and the relationship between the labels are represented with edges.
POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/schema/structure/build Example Response
Status code: 200
Example response for a successful request
{
"jobId": "2e0c08e1-3fbb-4b33-8776-4809176068d7154236181",
"jobType": 1
} Status code: 400
Example response for a failed request
Http Status Code: 400
{
"errorMessage": "Bad Request ",
"errorCode": "GES.8813"
} 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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
