文档首页/图引擎服务 GES/API参考/管理面API（V2）/元数据管理API/查询元数据(1.0.2)
更新时间：2025-12-19 GMT+08:00
查看PDF
分享

查询元数据(1.0.2)

功能介绍

查询某个元数据。

URI

GET /v2/{project_id}/graphs/metadatas/{metadata_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目编号。获取方法，请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母和数字组成，且长度为[1-64]个字符。

默认取值：

不涉及。

metadata_id

是

String

参数解释：

元数据ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。用于获取操作API的权限。获取方法请参见获取Token接口，响应消息头中X-Subject-Token的值即为Token。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

master_key_name

String

参数解释：

密钥名称。

取值范围：

不涉及。

master_key_id

String

参数解释：

密钥id。

取值范围：

不涉及。

ges_metadata

ges_metadata object

参数解释：

存储metadata的消息信息的对象。

取值范围：

不涉及。

表4 ges_metadata

参数

参数类型

描述

labels

Array of labels objects

参数解释：

Label数据结构集合。

取值范围：

不涉及。

表5 labels

参数

参数类型

描述

name

String

参数解释：

Label名称。

取值范围：

不涉及。

properties

Array of Map<String,String> objects

参数解释：

属性Map。

取值范围：

不涉及。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

系统提示信息。

  • 执行成功时，字段可能为空。
  • 执行失败时，用于显示错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

系统提示信息。

  • 执行成功时，字段可能为空。
  • 执行失败时，用于显示错误信息。

取值范围：

不涉及。

请求示例

查询元数据。

GET https://{Endpoint}/v2/{project_id}/graphs/metadatas/{metadata_id}

响应示例

状态码： 200

成功响应示例

{
  "ges_metadata" : {
    "labels" : [ {
      "name" : "friends"
    }, {
      "name" : "movie",
      "properties" : [ {
        "data_type" : "string",
        "name" : "ChineseTitle",
        "cardinality" : "single"
      }, {
        "data_type" : "int",
        "name" : "Year",
        "cardinality" : "single"
      }, {
        "data_type" : "string",
        "name" : "Genres",
        "cardinality" : "set"
      } ]
    }, {
      "name" : "user",
      "properties" : [ {
        "data_type" : "string",
        "name" : "ChineseName",
        "cardinality" : "single"
      }, {
        "type_name1" : "F",
        "type_name2" : "M",
        "data_type" : "enum",
        "name" : "Gender",
        "type_name_count" : "2",
        "cardinality" : "single"
      }, {
        "type_name1" : "Under 18",
        "type_name2" : "18-24",
        "type_name3" : "25-34",
        "type_name4" : "35-44",
        "type_name5" : "45-49",
        "type_name6" : "50-55",
        "type_name7" : "56+",
        "data_type" : "enum",
        "name" : "Age",
        "type_name_count" : "7",
        "cardinality" : "single"
      }, {
        "data_type" : "string",
        "name" : "Occupation",
        "cardinality" : "single"
      }, {
        "data_type" : "char array",
        "name" : "Zip-code",
        "max_data_size" : "12",
        "cardinality" : "single"
      } ]
    }, {
      "name" : "rate",
      "properties" : [ {
        "data_type" : "int",
        "name" : "Score",
        "cardinality" : "single"
      }, {
        "data_type" : "date",
        "name" : "Datetime",
        "cardinality" : "single"
      } ]
    } ]
  }
}

状态码： 400

失败响应示例

{
  "error_msg" : "6b74069d-3cf3-4cc0-9118-2478e23b87a does not exist.",
  "error_code" : "GES.2067"
}

状态码

返回值

说明

400 Bad Request

请求错误

401 Unauthorized

鉴权失败

403 Forbidden

没有操作权限

404 Not Found

找不到资源

500 Internal Server Error

服务内部错误

503 Service Unavailable

服务不可用

错误码

请参见错误码。

父主题：元数据管理API