华为云用户手册

URI GET /v1.0/{project_id}/graphs/metadatas 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页资源数量的最大值，默认为10。 offset 否 Integer 本次请求的起始位置，默认为0。

响应参数 表5 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 jobId String 执行该异步任务的jobId。 可以查询jobId查看任务执行状态、获取返回结果，详情参考Job管理API。

请求示例 进行导入图操作，边文件目录为testbucket/demo_movie/edges/，边数据集格式为csv，点文件目录为testbucket/demo_movie/vertices/，点数据集格式为csv，新增数据的元数据文件OBS路径为testbucket/demo_movie/incremental_data_schema.xml，日志存放目录为testbucket/importlogdir。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=import-graph { "edgesetPath": "testbucket/demo_movie/edges/", "edgesetFormat": "csv", "vertexsetPath": "testbucket/demo_movie/vertices/", "vertexsetFormat": "csv", "schemaPath": "testbucket/demo_movie/incremental_data_schema.xml", "logDir": "testbucket/importlogdir", "parallelEdge": { "action": "override", "ignoreLabel": false }, "delimiter": ",", "trimQuote": "\"", "offline": false, "obsParameters": { "accessKey": "xxxxxx", "secretKey": "xxxxxx" } }

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "jobId": "b4f2e9a0-0439-4edd-a3ad-199bb523b613" } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": "Parameter error!", "errorCode": "GES.8005" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 backup_count Integer 备份总个数。请求失败时，字段为空。 backup_list Array of backup_list objects 当前Project ID下某个图的备份列表。请求失败时，字段为空。 表5 backup_list 参数 参数类型 描述 id String 备份ID。 name String 备份名称。 backup_method String 备份方法，取值为auto，manual或者import。 graph_id String 备份关联的图ID。 graph_name String 备份关联的图Name。 graph_status String 备份关联的图状态。 graph_size_type_index String 备份关联的图规格。 data_store_version String 备份关联的图版本。 arch String 备份关联的图CPU架构。 status String 备份状态。 backing_up：备份中 success：备份成功 failed：备份失败 start_timestamp Long 备份开始时间戳。 start_time String 备份开始时间。 end_timestamp Long 备份结束时间戳。 end_time String 备份结束时间。 size Long 备份文件大小，单位为MB。 duration Long 备份时间，单位为秒。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 error_msg String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。

URI GET /v2/{project_id}/graphs/{graph_id}/backups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 graph_id 是 String 图ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页资源数量的最大值，默认为10。 offset 否 Integer 本次请求的起始位置，默认为0。

响应示例 状态码： 200 成功响应示例 { "backup_count" : 2, "backup_list" : [ { "id" : "ada3e720-ab87-48cb-bff7-3ec5ae1a9652", "name" : "ges060803_nodelete-20210608135513", "backup_method" : "manual", "graph_id" : "4c5f882d-a813-4d78-a8e3-6d3212ddd121", "graph_name" : "ges060803_nodelete", "graph_status" : "200", "graph_size_type_index" : "1", "data_store_version" : "2.2.21", "arch" : "x86_64", "status" : "success", "start_timestamp" : 1623160513000, "start_time" : "2021-06-08T13:55:13", "end_timestamp" : 1623160568000, "end_time" : "2021-06-08T13:56:08", "size" : 1, "duration" : 54 }, { "id" : "7ed3f51d-816d-4651-9129-fe21b64b5c91", "name" : "ges060803_nodelete_20210609203323_auto", "backup_method" : "auto", "graph_id" : "4c5f882d-a813-4d78-a8e3-6d3212ddd121", "graph_name" : "ges060803_nodelete", "graph_status" : "200", "graph_size_type_index" : "1", "data_store_version" : "2.2.21", "arch" : "x86_64", "status" : "success", "start_timestamp" : 1623242004000, "start_time" : "2021-06-09T12:33:24", "end_timestamp" : 1623242004000, "end_time" : "2021-06-09T12:33:24", "size" : 1, "duration" : 0 } ] } 状态码： 400 失败响应示例 { "error_msg": "Cluster does not exist or has been deleted.", "error_code": "GES.0047" }

响应示例 状态码： 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." }

请求参数 表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的消息信息的对象。

请求示例 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" } ] } ] } }

响应示例 状态码： 200 响应成功示例 { "graph_count" : 2, "graphs" : [ { "id" : "146227d2-bfac-499a-97df-df475349e43d", "name" : "TenThousand_Charging", "created_by" : "ei_ges_j00356469_01", "is_multi_az" : "false", "region_code" : "cn-north-7", "az_code" : "cn-north-7c", "edgeset_format" : "", "edgeset_default_label" : "", "vertexset_format" : "", "vertexset_default_label" : "", "data_store_version" : "2.3.2", "sys_tags" : [ "0" ], "status" : "200", "graph_size_type_index" : "0", "vpc_id" : "0ac6e3c3-2c9b-4296-84f7-6883cebc7b41", "subnet_id" : "2b1755eb-d6d4-421f-88c0-cf6f0bc16801", "security_group_id" : "7aa7c8c9-7443-4a01-abf5-8064b586f8f5", "replication" : 1, "created" : "2022-04-26T02:19:54", "private_ip" : "192.168.0.228", "arch" : "x86_64", "master_key_id" : "", "master_key_name" : "", "enable_rbac" : false, "enable_full_text_index" : false, "enable_hyg" : false, "traffic_ip_list" : [ "192.168.0.228" ], "crypt_algorithm" : "generalCipher", "enable_https" : false, "enable_multi_label":false, "origin_graph_size_type_index": "1", "expand_time": "2023-08-03T02:10:52", "resize_time": "2023-08-02T02:10:52" }, { "id" : "1172f16c-63c7-4746-89b0-78972eddf706", "name" : "GES_UI_2_0_1", "created_by" : "ei_ges_j00356469_01", "is_multi_az" : "false", "region_code" : "cn-north-7", "az_code" : "cn-north-7c", "edgeset_format" : "", "edgeset_default_label" : "", "vertexset_format" : "", "vertexset_default_label" : "", "data_store_version" : "2.0.1", "sys_tags" : [ "0" ], "status" : "900", "graph_size_type_index" : "0", "vpc_id" : "0ac6e3c3-2c9b-4296-84f7-6883cebc7b41", "subnet_id" : "2b1755eb-d6d4-421f-88c0-cf6f0bc16801", "security_group_id" : "7aa7c8c9-7443-4a01-abf5-8064b586f8f5", "replication" : 1, "created" : "2022-04-26T02:10:52", "private_ip" : "192.168.0.123", "enable_rbac" : false, "enable_full_text_index" : false, "enable_hyg" : false, "traffic_ip_list" : [ "192.168.0.123" ], "crypt_algorithm" : "generalCipher", "enable_https" : false, "enable_multi_label":false, "origin_graph_size_type_index": "1", "expand_time": "2023-08-03T02:10:52", "resize_time": "2023-08-02T02:10:52" } ] } 状态码： 400 响应失败示例 { "error_code" : "GES.7006", "error_msg" : "An internal error occurs in the underlying service of the graph engine." }

请求示例 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-algorithm { "algorithmName":"triangle_count", "parameters":{ } } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "jobId": "4448c9fb-0b16-4a78-8d89-2a137c53454a001679122" } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": "Parameter error!", "errorCode": "GES.8005" }

请求参数 表2 请求Body参数 参数 是否必选 类型 说明 algorithmName 是 String 算法名字。 parameters 是 parameters Object 算法参数。 表3 parameters 参数 是否必选 类型 说明 statistics 否 Boolean 是否仅输出总的统计量结果，取值为true或false，默认为true。 true：仅输出总的统计数量。 false：输出各点对应三角形数量。

响应参数 参数 类型 说明 errorMessage String 系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误信息。 errorCode String 系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误码。 jobId String 执行算法任务ID。请求失败时，字段为空。 说明： 可以利用返回的jobId查看任务执行状态、获取算法返回结果，详情参考查询Job状态(1.0.0)。 triangle_count Integer 三角形个数。 vertex_triangles List 各节点的三角形个数，格式： [{vertexId : vertexTriangleCount},...], 其中, vertexId：string类型。 vertexTriangleCount：Integer类型。

点集最短路（shortest_path_of_vertex_sets）(2.1.5) 表1 parameters参数说明 参数 是否必选 说明 类型 取值范围 默认值 sources 是 起点ID集合 String 标准csv格式，ID之间以英文逗号分隔，例如："Alice,Nana"。 个数不大于100000。 - targets 是 终点ID集合 String 标准csv格式，ID之间以英文逗号分隔，例如："Alice,Nana"。 个数不大于100000。 - directed 否 是否考虑边的方向 Boolean true或false false timeWindow 否 用于进行时间过滤的时间窗 Object 具体请参见表2。 - 表2 timeWindow参数说明 参数 是否必选 说明 类型 取值范围 默认值 filterName 否 用于进行时间过滤的时间属性名称 String 字符串：对应的点/边上的属性作为时间 - filterType 否 在点或边上过滤 String V：点上 E：边上 BOTH：点和边上 BOTH startTime 否 起始时间 String Date型字符串或时间戳 - endTime 否 终止时间 String Date型字符串或时间戳 - 表3 response_data参数说明 参数 类型 说明 path List 最短路径，格式： [vertexId,...] 其中, vertexId：string类型 source String 起点ID target String 终点ID 父主题： 算法API参数参考

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见获取Token接口，响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 expand 是 expand object expand是一个对象 表4 expand 参数 是否必选 参数类型 描述 replication 是 Integer 新扩副本数量。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 job_id String 扩副本任务ID。请求失败时字段为空。 说明： 可以查询jobId查看任务执行状态、获取返回结果，详情参考任务中心API。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 error_msg String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。

响应参数 表5 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 jobId String 执行该异步任务的jobId。 可以查询jobId查看任务执行状态、获取返回结果，详情参考查询Job状态(1.0.0)-业务面。 jobType Integer 任务类型。请求失败时，字段为空。

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "jobId": "2aa37d87-fb5a-44c4-81a1-c3876247d1cf000003836", "jobType": 15 } 状态码： 400 失败响应示例 Http Status Code: 400 { "jobId": "2aa37d87-fb5a-44c4-81a1-c3876247d1cf000003836", "jobType": 15 }

功能介绍 用于将异步任务（jobId）的执行结果（result）导出到文件。 支持算法列表： pagerank、personalrank、pixie louvain、label_propagation、connect_component kcore sssp、shortest_path（含time_window_shortest_path）、shortest_path_of_vertex_sets、all_shortest_paths、n_paths traingle_count、cluster_coefficient、degree_correlation、closeness link_prediction betweenness、edge_betweenness、od_betweenness 支持查询列表 Cypher操作API（2.2.16） 点过滤查询(1.0.0) 边过滤查询(1.0.0)

URI POST /ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id}/action?action_id=export-result 表1 路径参数 参数 是否必选 类型 说明 project_id 是 String 项目ID。获取方法请参见获取项目ID。 graph_name 是 String 图名称。 job_id 是 String Response对应的任务Job ID。

请求参数 表2 Body参数说明 参数 是否必选 类型 说明 exportPath 是 String 导出路径。 fileName 否 String 导出文件名。 obsParameters 是 String OBS认证参数。具体请见表3。 paginate 否 Object 分页参数，导出异步任务API默认关闭分页，具体请见表表4。 erase 否 Boolean 导出后是否删除原job任务，取值为true或false，默认值为true即表示默认删除job并释放资源。 表3 obsParameters参数说明 参数 是否必选 类型 说明 accessKey 是 string ak值。 secretKey 是 string sk值。 表4 paginate中各要素说明 参数 是否必选 类型 说明 enable 否 Boolean 是否开启分页，默认为false，需要开启分页时，需输入值true。 rowCountPerFile 否 Integer 按页导出时，每个文件最大行数，默认10000000。 numThread 否 Integer 按页导出时，并行线程数，默认为8。 maxSizePerFile 否 Integer 按页导出时，每个文件大小的最大值，单位是byte。 分页参数说明 当分页参数开启状态下，请求体中fileName代表目录名，目录下存放分页的文件；分页参数关闭时，fileName代表文件名。导出前请保证文件名指向的路径为空，确保导出时不会覆盖OBS上已有数据。 当numThread的值大于GES图实例使用的机器cpu数时，会配置为机器cpu数。 rowCountPerFile的值会影响实际使用的线程数。即当结果集大小和rowCountPerFile的比值小于numThread时，会使用这个比值作为线程数。 如果请求被用户取消，已上传到OBS中的数据不会删除，有关取消Job的API详见取消Job(1.0.0)。 分页开启时文件名的命名规则： 分页选项中enable参数为true时，fileName代表一个目录，目录下的文件使用线程id与文件编号的组合命名，中间使用“.”连接。例如，对于320万条数据，不同配置下第一个文件名和最后一个文件名示例如下： rowCountPerFile 10万 10万 100万 100万 500万 numThread 2 48 2 5 2 实际使用的线程 2 32 2 4 1 单线程生成文件数 16 1 2 1 1 第一个文件名 00.000.txt 00.000.txt 00.00.txt 00.00.txt 00.00.txt 最后一个文件名 01.015.txt 031.000.txt 01.01.txt 03.00.txt 00.00.txt

响应参数 表3 响应Body参数说明 参数 是否必选 说明 errorMessage 否 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode 否 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 jobId 否 执行该异步任务的jobId。 可以查询jobId查看任务执行状态、获取返回结果，详情参考Job管理API。 jobType Integer 任务类型。请求失败时，该字段为空。

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "jobId": "c332e1d4-844c-4f75-beeb-e31d2c57f118000003836", "jobType": 3 } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorCode": "GES.8012", "errorMessage": "graph [movie2] is not found" }

请求示例 查询输入的节点和它们之间所有边所构成的子图，子图中包含的点ID为Ray，Ella，Lethal Weapon。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/subgraphs/action??action_id=query { "vertices":[ "Ray", "Ella", "Lethal Weapon" ] }

响应参数 表3 响应Body参数说明 名称 参数类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 data Object 查询成功时包含data字段，data字段中包含子图查询结果。 说明： 当前支持返回的子图边数最大值为100000，超过返回最大值时，会报错。

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "data":{ "vertices":[ { "id":"Ray", "label":"user", "properties":{ "Name":["雷"], "Gender":["M"], "Age":["18-24"], "Occupation":["college/grad student"], "Zip-code":["90241"] } }, { "id":"Ella", "label":"user", "properties":{ "Occupation":["other or not specified"], "Name":["埃拉"], "Zip-code":["94402"], "Gender":["F"], "Age":["25-34"] } } ], "edges":[ { "source":"Ray", "target":"Lethal Weapon", "index":"1", "label":"rate", "properties":{ "Score":[2], "Datetime":["2000-11-22 19:16:16"] } }, { "index":"0", "source":"Ella", "label":"rate", "properties":{ "Score":[5], "Datetime":["2000-11-23 02:30:29"] }, "target":"Lethal Weapon" }, { "index":"5", "source":"Ella", "label":"friends", "properties":{}, "target":"Ray" } ] } } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": " Bad Request, parameter vertices cannot be null", "errorCode": "GES.8214" }

请求示例 批量更新边属性，边的起点为46，边的终点分别为39，38。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/edges/properties/action?action_id=batch-update { "edges": [ { "source": "46", "target": "39", "properties": { "Rating": [ 5 ], "Datetime": [ "2018-01-0120:30:05" ] } }, { "source": "46", "target": "38", "index": "0", "properties": { "Rating": [ 4 ], "Datetime": [ "2018-01-0120:30:05" ] } } ] } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "result":"success" } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": "Edge [46] not exist.", "errorCode": "GES.8221", "result": "failed" }