-
响应示例 状态码: 200 成功响应示例 {
"schema_count" : 2,
"schema_list" : [ {
"start_time" : "2022-01-21T10:13:31",
"last_update_time" : "2022-01-21T10:13:31",
"name" : "schema_748e",
"description" : "xxxxx",
"id" : "6634c50e-13aa-4395-8088-6b327f7da694",
"metadata_path" : "devdata/schema_748e.xml",
"status" : "200"
}, {
"start_time" : "2022-04-12T03:15:17",
"last_update_time" : "2022-11-16T08:18:32",
"name" : "unionsdk_schema",
"id" : "6b74069d-3cf3-4cc0-9118-2478e23b87aa",
"metadata_path" : "devdata/unionsdk/unionsdk_schema.xml",
"status" : "200"
} ]
} 状态码: 400 失败响应示例 {
"error_code" : "GES.7006",
"error_msg" : "An internal error occurs in the underlying service of the graph engine."
}
-
响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 schema_count Integer 元数据返回个数。请求失败时,字段为空。 schema_list Array of schema_list objects 当前project_id下的所有元数据列表。请求失败时,字段为空。 表5 schema_list 参数 参数类型 描述 id String 元数据 ID。 name String 元数据名称。 start_time String 元数据创建时间。 last_update_time String 元数据最后更新时间。 description String 元数据描述。 metadata_path String 元数据对应路径。 status String 元数据是否可用。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误码。 error_msg String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误信息。
-
请求示例 新增元数据,元数据存储地址为devdata/unionsdk/unionsdk_test.xml,不覆盖文件,元数据的名字为unionsdk_test,对元数据的描述为测试。 POST https://{Endpoint}/v2/{project_id}/graphs/metadatas
{
"metadata_path" : "devdata/unionsdk/unionsdk_test.xml",
"is_overwrite" : false,
"name" : "unionsdk_test",
"description" : "测试",
"ges_metadata" : {
"labels" : [ {
"name" : "friends"
}, {
"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" : "ChineseName",
"cardinality" : "single"
}, {
"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"
} ]
} ]
}
}
-
响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 id String 元数据ID。 name String 元数据名字。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误码。 error_msg String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误信息。
-
响应示例 状态码: 200 OK {
"id" : "ff8080815f9a3c84015f9a438ff70001",
"name" : "movie_schema"
} 状态码: 500 Internal Server Error {
"errorCode" : "GES.2067",
"errorMessage" : "name: 1 to 64 characters, only letters, digits, and underscores(_) are allowed."
}
-
请求示例 POST https://{Endpoint}/v1.0/{project_id}/graphs/metadatas
{
"metadataPath": "gesdata/demo_movie/schema.xml",
"name": "movie_schema",
"description": "xxxxx",
"isOverwrite": "true",
"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": "Name",
"cardinality": "single"
},
{
"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"
}
]
}
]
}
}
-
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见
获取Token 接口,响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 metadataPath 是 String 元数据存储地址。 name 是 String 元数据的名称,限制为1-64个字符,且只能包含字母,数字或下划线。 description 是 String 对元数据的描述信息。 isOverwrite 是 Boolean 是否覆盖文件。取值为true或false,默认值为false。 true表示覆盖文件。 false表示不覆盖文件。 gesMetadata 是 Object 存储metadata的消息信息的对象。