Help Center> Graph Engine Service> API Reference> Management Plane APIs> System Management APIs> Verifying Metadata Files (1.0.0)
View PDF

Verifying Metadata Files (1.0.0)

Function

This API is used to verify the selected data set and metadata file.

URI

  • URI format 
    POST /v1.0/{project_id}/graphs/action?action_id=check-schema
  • Parameter description
    Table 1 URI parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID, which is used for resource isolation. For details about how to obtain the project ID, see Obtaining a Project ID.

Request

  • Request example 
    POST https://Endpoint/v1.0/{project_id}/graphs/action?action_id=check-schema

{    
"schemaPath": "ges-graphs/demo_movie/schema.xml",
"edgesetPath": "ges-graphs/demo_movie/edge.csv",
"edgesetFormat": "csv",
"vertexsetPath": "ges-graphs/demo_movie/vertex.csv",
"vertexsetFormat": "csv"
}
  • Request body parameter description

    Parameter

    Mandatory

    Type

    Description

    schemaPath

    Yes

    String

    OBS path for storing metadata files

    edgesetPath

    Yes

    String

    OBS path for storing the edge data set

    edgesetFormat

    No

    String

    Format of the edge data set. Currently, only the CSV format is supported.

    The CSV format is used by default.

    vertexsetPath

    No

    String

    OBS path for storing the vertex data set

    vertexsetFormat

    No

    String

    Format of the vertex data set. Currently, only the CSV format is supported.

    The CSV format is used by default.

Response

Table 2 Parameter description

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. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
  • Response example (successful request) 
    Http Status Code: 200
{}
  • Response example (failed request) 
    Http Status Code: 400
{
   "errorCode": "GES.7017",
   "errorMessage": "The object does not exist. Check whether the bucket or object name is correct." 
}

Return Value

  • Normal

    200

  • Abnormal
    Table 3 Return code for failed requests

    Return Value

    Description

    400 Bad Request

    Request error.

    401 Unauthorized

    Authentication failed.

    403 Forbidden

    No operation permission.

    404 Not Found

    The requested resource was not found.

    500 Internal Server Error

    Internal service error.

    503 Service Unavailable

    Service unavailable.
Parent topic: System Management APIs