Function

This API is used to query the metadata of a graph.

URI

• URI format

  GET /v1.0/{project_id}/graphs/metadatas/{metadata_id}

• 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, see Obtaining a Project ID.
  metadata_id	Yes	String	Metadata ID

Request

• Request example

  GET https://Endpoint/v1.0/{project_id}/graphs/metadatas/{metadata_id}

Response

• Parameter description

  Table 2 Parameter description

  Parameter	Mandatory	Type	Description
  errorMessage	No	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	No	String	System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.
  gesMetadata	Yes	GesMetaData data structure	Object of the message that stores the metadata

  Table 3 GesMetaData data structure

  Parameter	Mandatory	Type	Description
  labels	Yes	JsonArray	Label data structure set

  Table 4 Label data structure

  Parameter	Mandatory	Type	Description
  name	Yes	String	Label name
  properties	Yes	Map	Property map

• Response example

  {
      "gesMetadata": {
          "labels": [
              {
                  "name": "friends",
                  "properties": null
              },
              {
                  "name": "movie",
                  "properties": [
                      {
                          "dataType": "string",
                          "name": "ChineseTitle",
                          "cardinality": "single"
                      },
                      {
                          "dataType": "int",
                          "name": "Year",
                          "cardinality": "single"
                      },
                      {
                          "dataType": "string",
                          "name": "Genres",
                          "cardinality": "set"
                      }
                  ]
              },
              {
                  "name": "user",
                  "properties": [
                      {
                          "dataType": "string",
                          "name": "ChineseTitle",
                          "cardinality": "single"
                      },
                      {
                          "dataType": "int",
                          "name": "Year",
                          "cardinality": "single"
                      },
                      {
                          "dataType": "string",
                          "name": "Genres",
                          "cardinality": "set"
                      }{
                          "typeName1": "F",
                          "typeName2": "M",
                          "typeNameCount": "2",
                          "dataType": "enum",
                          "name": "Gender",
                          "cardinality": "single"
                      },
                      {
                          "typeName1": "Under 18",
                          "typeName2": "18-24",
                          "typeName3": "25-34",
                          "typeName4": "35-44",
                          "typeNameCount": "7",
                          "dataType": "enum",
                          "name": "Age",
                          "typeName5": "45-49",
                          "typeName6": "50-55",
                          "cardinality": "single",
                          "typeName7": "56+"
                      },
                      {
                          "dataType": "string",
                          "name": "Occupation",
                          "cardinality": "single"
                      },
                      {
                          "dataType": "char array",
                          "name": "Zip-code",
                          "maxDataSize": "12",
                          "cardinality": "single"
                      }
                  ]
              },
              {
                  "name": "rate",
                  "properties": [
                      {
                          "dataType": "int",
                          "name": "Score",
                          "cardinality": "single"
                      },
                      {
                          "dataType": "date",
                          "name": "Datetime",
                          "cardinality": "single"
                      }
                  ]
              }
          ]
      }
  }

• Response example (failed request)

  Http Status: 500
    {
      "errorCode": "GES.7006",
      "errorMessage": "The underlying graph engine has internal error."
    }

Return Value

• Normal

  200

• Abnormal

  Table 5 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.