华为云用户手册

请求示例 更新label，label的名称为book，label一共有三个待更新的属性。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/schema/labels/book/properties { "properties": [ { "property": { "name": "Title", "cardinality": "single", "dataType": "string" } }, { "property": { "name": "Version", "cardinality": "single", "dataType": "string" } }, { "property": { "name": "Category", "typeName1": "science", "typeName2": "literature", "typeNameCount": "2", "dataType": "enum" } } ] } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "result": "success" } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": "Graph [cb1ed5491f7f466e8947ff09c06ca08c-ges_hyg1] does not exist, please check projectId and graphName.", "errorCode": "GES.8000", "result": "failed" }

响应参数 表3 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 result String 执行结果。 成功时，result值为success。 失败时，result值为failed。

请求参数 表2 Body参数说明 参数 是否必选 类型 说明 policy 否 String 指定图切分策略，目前支持oec策略，默认是oec策略。 inEdge 否 Boolean 图是否包含入边，默认为false，设置为true会影响数据同步性能。 对于部分算法，如果不包含入边，算法可能会性能下降或者报错，例如算法：shortest_path、sssp、k_hop，详情请查阅对应的算法参数说明。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见 获取Token 接口，响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 metadataPath 是 String 元数据存储地址。 name 是 String 元数据的名字。 description 否 String 对元数据的描述。

响应示例 状态码： 200 成功响应示例 { "instance_name": "ges_demo-ges-dn-2-1", "edge_capacity": 0, "edge_number": 0, "edge_usage": 0, "vertex_capacity": 0, "vertex_number": 0, "vertex_usage": 0, "read_waiting_queue_length": 2, "read_running_queue_length": 1, "write_waiting_queue_length": 0, "write_running_queue_length": 0, "current_queries": [ { "task_name": "incremental_load_graph", "request": { "vertex_file_format": "csv", "parallel_edge": "allow", "graph_name": "ges_demo", "vertex_file_path": "wepbucket/movie1/sit_ges_data_uat/nodes/", "edge_file_path": "wepbucket/movie1/sit_ges_data_uat/edges/", "schema_file_path": "wepbucket/movie1/sit_ges_data_uat/sit_ges_metadata_v6.xml", "vidSerialize": true, "offline": false, "trim_quote": "\"", "ignore_label": true, "delimiter": ",", "edge_file_format": "csv", "parameters": { "secret_key": "xxxxxxxx", "access_key": "xxxxxxxx", "region": "cn-north-7" } }, "pending_duration": 9.91311, "request_id": "0c56e2d14369586da38d7fe3b81bb1bd", "status": "pending", "begin_time": "", "running_duration": 0, "progress": 0 } ] } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": "graph ges_fdb_hyg1 not exist.", "errorCode": "GES.8000" }

URI GET /ges/v1.0/{project_id}/graphs/{graph_name}/om/real-time-queries?summary= 表1 路径参数 参数 是否必选 类型 说明 project_id 是 String 项目ID。项目ID，获取方法请参见获取项目ID。 graph_name 是 String 图名称。 表2 Query参数 参数 是否必选 参数类型 描述 summary 否 Boolean 是否只查询实时请求的概要信息，默认为false。如果设置为true，只返回概要信息，任务详情不会返回。

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

请求参数 表2 Body参数说明 参数 是否必选 类型 说明 exportPath 是 String 导出路径。 fileName 否 String 导出文件名。 obsParameters 是 String OBS认证参数。请参见表 obsParameters参数说明。 labels labels和edgeFilters两者必选其一 String 关系类型过滤条件。 edgeFilters labels和edgeFilters两者必选其一 String 过滤条件，按属性过滤，JsonArray格式字符串。请参见表 edgeFilters参数结构。

响应示例 根据输入参数，执行指定算法，查询算法结果（根据算法请求返回的job_id，调用查询job_id接口获取算法结果）。 状态码： 200 成功响应示例 { "data": { "outputs": { $response_data //各算法的具体返回结果，不同算法返回结果不同 "runtime": 1.365867, "data_return_size": 3, "data_offset": 0, "data_total_size": 100 } }, "status": "complete" } response_data 表示各算法的具体返回结果，不同算法返回结果不同。 状态码： 400 失败响应示例 Http Status Code: 400 { "status": "complete", "errorMessage": "Unknown algorithm name: pagerank12", "errorCode": "GES.8301", "result": "failed" }

请求参数 表1 请求Body参数说明 参数 是否必选 类型 说明 algorithmName 是 String 算法名字，详见具体的各个算法。 parameters 否 Object 算法参数。详情请参考各算法参数描述。 output 否 Object 结果输出参数。具体请见表2。 timeout 否 Integer 超时时间，单位为秒，超时范围为 (0, 2147483648)。 表2 output参数说明 参数 是否必选 类型 说明 format 否 String 算法结果的输出格式。可选值是["JSON", "TXT"]，默认值是"JSON"。TXT格式请参考算法结果TXT格式说明。 mode 否 String 算法结果的输出模式。可选值是["FULL", "TRUNCATED"]。默认值是"TRUNCATED"。 "FULL"表示算法结果全量输出。"FULL"模式下，当前只支持"TXT"这个格式，且算法结果会写到集群节点的本地目录，需要通过"export-result"接口将全量结果写到obs才能访问。 "TRUNCATED"表示算法结果截断输出，当前只支持"JSON"这种格式。 对于存在默认值的参数，如果传参数值为null，按默认值处理。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 schemaCount Integer 元数据返回个数。请求失败时，该字段为空。 schemaList Array of metadata objects 当前project_id下的所有元数据列表。请求失败时，该字段为空。 表5 metadata 参数 参数类型 描述 id String 元数据 ID。 name String 元数据名称。 description String 元数据描述。 status String 元数据是否可用。 metadataPath String 元数据对应路径。 startTime String 元数据的创建时间。 lastUpdateTime String 元数据的最后更新时间。

响应示例 状态码： 200 OK { "schemaCount": 1, "schemaList" : [ { "id" : "ff7dddc4-6402-43d7-9aed-c5ec677b47fa", "name" : "schema_demo", "description" : "", "status" : "200", "metadataPath" : "ges-graphs/demo_movie/schema.xml", "startTime" : "2018-07-23T02:59:41", "lastUpdateTime" : "2018-07-23T02:59:41" } ] } 状态码： 500 Internal Server Error { "errorCode" : "GES.7006", "errorMessage" : "The underlying graph engine has internal error." }

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 新扩副本数量。