华为云用户手册

请求参数 表2 请求Body参数 参数 是否必选 类型 说明 algorithmName 是 String 算法名字。 parameters 否 parameters Object 算法参数。 表3 parameters 参数 是否必选 类型 说明 statistics 否 Boolean 是否仅输出总的统计量结果，取值为true或false，默认取值为true。 true：仅输出总的平均聚类系数。 false：额外输出各点对应聚类系数。 directed 否 Boolean 是否看作有向图进行计算，取值为true或false，默认取值为false。 true：有向图。 false：无向图。

请求示例 POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/algorithm { "algorithmName":"cluster_coefficient", "parameters": { "statistics":"false", "directed":"false" } } 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" }

请求示例 POST https://{Endpoint}/v1.0/{project_id}/graphs { "graph":{ "name":"demo", "graphSizeTypeIndex": "1", "arch":"x86_64", "vpcId":"2d8af840-fd57-4e3b-a8f1-cda0f55ccd99", "subnetId":"dc018ec3-67d1-46c9-b2fc-19d83367f4e2", "securityGroupId":"11d27338-8649-4076-8579-5ebc1a60f79e", "publicIp":{ "publicBindType":"bind_existing", "eipId":"30ef2d58-08a9-4481-b526-b2cbe67d020d" }, "enableMultiAz":false, "sys_tags": [{"key": "_sys_enterprise_project_id", "value": "54c0b33c-8627-462f-948e-bae08c0887b4"}], "enableRBAC":false, "enableFullTextIndex" : false, "cryptAlgorithm": "generalCipher", "enableHttps": "false" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见 获取Token 接口，响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 upgrade_version 是 String 升级到的版本，必须大于当前图版本。 force_upgrade 否 Boolean 是否强制升级。取值为true或false，默认为false。 true：强制升级，会中断升级时已经在处理的任务，比如运行算法长任务，可能会造成少量请求失败。 false：非强制升级，会等待已经运行的业务，升级过程可能较慢。

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

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

请求示例 POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/algorithm { "algorithmName":"closeness", "parameters":{ "sources":"1,2,3" } } 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" }

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

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "jobId": "b7f3ea8d-8a22-40ea-8751-6bcad5fc38b6000003836", "jobType": 4 } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorCode": "GES.8013", "errorMessage": "graph [movie2] is not found" }

请求示例 进行导入图操作，边文件目录为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":true }, "delimiter": ",", "trimQuote": "\"", "offline": true, "obsParameters": { "accessKey": "xxxxxx", "secretKey": "xxxxxx" } }

响应示例 状态码： 200 OK { "graphCount": 2, "graphs": [ { "id": "f1529b88-c958-493e-8452-fccfe932cde1", "name": "demo", "regionCode": "cn-north-1", "azCode": "cn-north-1a", "schemaPath": [ { "path": "ges-graphs/demo_movie/schema.xml", "jobId": "ff80808167bb90340167bc7445670428", "status": "success" } ], "edgesetPath": [ { "path": "ges-graphs/demo_movie/edge.csv", "jobId": "ff80808167bb90340167bc7445670428", "status": "success" } ], "vertexsetPath": [ { "path": "", "jobId": "ff80808167bb90340167bc7445670428", "status": "success" } ], "status": "200", "graphSizeTypeIndex": "1", "vpcId": "2d8af840-fd57-4e3b-a8f1-cda0f55ccd99", "subnetId": "dc018ec3-67d1-46c9-b2fc-19d83367f4e2", "securityGroupId": "11d27338-8649-4076-8579-5ebc1a60f79e", "created": "2018-07-23T04:09:44", "updated": "2018-07-23T04:09:44", "privateIp": "192.168.0.4", "publicIp": "49.4.81.183", "dataStoreVersion": "1.0.5", "arch": "x86_64", "enableFullTextIndex" : false }, { "id": "53205529-026b-455a-9e07-228fae4b12b9", "name": "ges_c5de", "regionCode": "cn-north-1", "azCode": "cn-north-1a", "schemaPath": [ { "path": "ges-graphs/demo_movie/schema.xml", "jobId": "ff80808167bb90340167bc7445670428", "status": "success" } ], "edgesetPath": [ { "path": "ges-graphs/demo_movie/edge.csv", "jobId": "ff80808167bb90340167bc7445670428", "status": "success" } ], "vertexsetPath": [ { "path": "", "jobId": "ff80808167bb90340167bc7445670428", "status": "success" } ], "status": "200", "graphSizeTypeIndex": "2", "vpcId": "2d8af840-fd57-4e3b-a8f1-cda0f55ccd99", "subnetId": "dc018ec3-67d1-46c9-b2fc-19d83367f4e2", "securityGroupId": "11d27338-8649-4076-8579-5ebc1a60f79e", "created": "2018-07-18T13:30:16", "updated": "2018-07-18T13:30:16", "privateIp": "192.168.0.168", "dataStoreVersion": "1.0.5", "arch": "aarch64", "enableFullTextIndex" : false } ] }

请求 请求样例 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/edges { "source":"Lily", "target": "Rocky", "label": "rate", "properties": {"Score":[5],"Datetime":["2018-01-01 20:30:05"]}, "parallelEdge": "override" } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。 Body参数说明 参数 是否必选 类型 说明 source 是 String source点名称。 target 是 String target点名称。 label 是 String 点的label，若没有则置为“__DEFAULT__”。 properties 否 Json 各个属性的值。 parallelEdge 否 String 重复边的处理方式，可选值为allow，ignore和override。allow表示允许重复边；ignore表示忽略之后的重复边；override表示覆盖之前的重复边。默认值为allow。

响应 要素说明 参数 类型 说明 errorMessage String 系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误信息。 errorCode String 系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误码。 data String 查询成功时包含data字段，data字段中包含edges查询结果。 result String 成功时result值为success。 请求成功样例 Http Status Code: 200 { "result":"success", "data":{"index":"0"} } 请求失败样例 Http Status Code: 400 { "errorMessage":"Edge source vertex [Lily] does not exist", "errorCode":"GES.8000" }

请求示例 导入文件更新点边的指定属性，点文件目录为datasets/movie/movie.csv，点数据集格式为csv，边文件目录为datasets/movie/ranking_edge.csv，边数据集格式为csv。 POST http://{Endpoint}/ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=import-properties { "vertexsetPath": "datasets/movie/movie.csv", "vertexsetFormat": "csv", "vertexProperties": [ { "label": "movie", "properties": [ "genres" ] } ], "edgesetPath": "datasets/movie/ranking_edge.csv", "edgesetFormat": "csv", "edgeProperties": [ { "label": "rate", "properties": [ "Datetime" ] } ], "targetProperties": [ { "label": "rate", "properties": [ "Rating" ] } ], "delimiter": ",", "trimQuote": "\"", "obsParameters": { "accessKey": "XXXXXXX", "secretKey": "XXXXXXX" }, "vertexFileContainLabel": true }

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

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "jobId": "72b268f7-fdb6-467d-a41f-b1a09f26e593000003836", "jobType": 3 } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": "Not found. Please check the input parameters.", "errorCode": "GES.8000" }

请求参数 导入文件更新属性的csv文件格式如下： 点文件（包含label）：点ID,label,property_1,…property_n 点文件（不包含label）：点ID,property_1,…property_n 边文件：源点ID,目的点ID,label,边ID属性,property_1,…property_n 表2 Body参数说明 参数 是否必选 类型 说明 vertexsetPath vertexsetPath和edgesetPath至少有一个 String 点文件目录或点文件名。 vertexsetFormat 否 String 点数据集格式，当前支持csv和txt。 默认为csv。 vertexProperties 有vertexsetPath则必选 Object 点文件中点的label和待更新属性列表信息，JsonArray格式。请参见表3。 edgesetPath vertexsetPath和edgesetPath至少有一个 String 边文件目录或边文件名。 edgesetFormat 否 String 边数据集格式，当前支持csv和txt。 默认为csv。 edgeProperties 有edgesetPath则必选 Object 边文件中边的label和待更新属性列表信息，JsonArray格式。请参见表4。 targetProperties 有edgesetPath则必选 Object 边文件中用于区分重复边的属性信息，JsonArray格式。请参见表5。 delimiter 否 Character csv格式文件字段分隔符，默认值为逗号（,）。list/set类型的字段内元素分隔符默认为分号（;）。 trimQuote 否 Character csv格式文件字段包围符，默认值为双引号（"）。用来包围一个字段，如字段中含有分隔符或者换行等。 obsParameters 是 String OBS认证参数。请参见表6。 vertexFileContainLabel 否 Boolean 点文件是否包含label信息。可选选项，默认值是true。 表3 vertexProperties参数说明 参数 是否必选 类型 说明 label 是 String label名称。 properties 是 Object 待更新属性列表，需要与点文件中属性顺序一致，JsonArray格式。 表4 edgeProperties参数说明 参数 是否必选 类型 说明 label 是 String label名称。 properties 是 Object 待更新属性列表，需要与边文件中属性顺序一致，JsonArray格式。 表5 targetProperties参数说明 参数 是否必选 类型 说明 label 是 String label名称。 properties 是 Object 边ID属性信息，JsonArray格式。当前仅支持一个属性 表6 obsParameters参数说明 参数 是否必选 类型 说明 accessKey 是 string ak值。 secretKey 是 string sk值。

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

URI POST /v2/{project_id}/graphs/{graph_id}/clear-graph 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 graph_id 是 String 图ID。 表2 Query参数 参数 是否必选 参数类型 描述 clear-metadata 否 Boolean 是否清空图关联的元数据，建议清空。取值为“true”或者“false”。默认为“false”。 true：表示清空 false：表示不清空

响应示例 状态码： 200 OK { "graph": { "id": "f1529b88-c958-493e-8452-fccfe932cde1", "name": "demo", "regionCode": "cn-north-1", "azCode": "cn-north-1a", "schemaPath": [ { "path": "ges-graphs/demo_movie/schema.xml", "jobId": "ff80808167bb90340167bc7445670428", "status": "success" } ], "edgesetPath": [ { "path": "ges-graphs/demo_movie/edge.csv", "jobId": "ff80808167bb90340167bc7445670428", "status": "success" } ], "vertexsetPath": [ { "path": "", "jobId": "ff80808167bb90340167bc7445670428", "status": "success" } ], "status": "200", "graphSizeTypeIndex": "1", "vpcId": "2d8af840-fd57-4e3b-a8f1-cda0f55ccd99", "subnetId": "dc018ec3-67d1-46c9-b2fc-19d83367f4e2", "securityGroupId": "11d27338-8649-4076-8579-5ebc1a60f79e", "created": "2018-07-23T04:09:44", "privateIp": "192.168.0.4", "publicIp": "49.4.81.183", "dataStoreVersion": "1.0.5", "arch": "x86_64" } }

请求参数 表2 Body参数说明 参数 是否必选 类型 说明 properties 是 Object 各个属性的值。 targetProperties 否 Array 判断重复边所用的属性列表。 若不为空，则会覆盖重复边（起点终点一致）中，指定属性值与输入属性值相同的边的其他属性（若有多个指定属性，则修改按属性输入顺序匹配上的第一条边的属性）。 若为空或输入边没有指定属性则更新行为与之前一致——更新符合条件的第一条边。 属性列表元素格式见表 targetProperty参数说明。 表3 targetProperty参数说明 参数 是否必选 类型 说明 label 是 String label名称, 需要按属性判断重复边的Label。 properties 是 Array 各个属性的值。需要按属性来判断重复边的Property列表。当前仅支持单个属性，输入多个属性则取第一个。

请求示例 更新边的属性值，属性名Rating的值为7，属性名Datetime的值为2020-12-27 23:44:41，标签名称为rate。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/edges/properties/action?action_id=update&source=Lily&target=Tom&index=1 { "properties": { "Rating": ["7"], "Datetime":["2020-12-27 23:44:41"] }, "targetProperties": [ { "label": "rate", "properties": [ "Rating" ] } ] } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

URI POST /ges/v1.0/{project_id}/graphs/{graph_name}/edges/properties/action?action_id={actionId}&source={sourceVertex}&target={targetVertex}&index={index} 表1 路径参数 参数 是否必选 类型 说明 project_id 是 String 项目ID。获取方法请参见获取项目ID。 graph_name 是 String 图名称。 actionId 是 String 操作符。 update更新该属性的值。 add 添加属性的值。当属性的cardiniality为single时，其操作与update一致；当cardinality为list或set时，意为向集合中添加值。 del 删除属性的值。 sourceVertex 是 String 边的起点。 targetVertex 是 String 边的终点。 index 否 Integer 边的标识号，若不设置，则修改两点间第一条边的属性。

请求示例 批量更新点属性，待更新的点数组的点名称分别为150、6。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/properties/action?action_id=batch-update { "vertices": [ { "vertex": "150", "label": "movie", "properties": { "movieid": [ "150" ], "title": [ "testmoive" ], "genres": [ "Comedy" ] } }, { "vertex": "6", "properties": { "title": [ "testmoive_exist_id" ], "genres": [ "Comedy" ] } } ], "ignoreError": true } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

请求参数 表2 Body参数说明 参数 是否必选 类型 说明 vertices 是 Json 待更新的点数组。数组参数详见vertices参数说明。 ignoreError 否 Boolean 是否忽略批量中部分点的更新错误。默认值为false。 当值为false：表示发现导致无法更新的错误，例如待更新的点不存在则报错，不更新任何点。 当值为true：表示忽略类似错误并更新其他无错误的点属性。 表3 vertices参数说明 参数 是否必选 类型 说明 vertex 是 String 点ID。 label 否 String 点的label。 properties 是 Json 待更新的各个属性的值。

URI POST /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/properties/action?action_id={actionId} 表1 路径参数 参数 是否必选 类型 说明 project_id 是 String 项目ID。获取方法请参见获取项目ID。 graph_name 是 String 图名称。 actionId 是 String 操作符。 batch-update 更新该属性的值。 batch-add 添加属性的值。当属性的cardinality为single时，其操作与update一致；当cardinality为list或set时，意为向集合中添加值。 batch-del 删除属性的值。

请求示例 取消订阅scenes场景应用分析能力，取消订阅的具体场景名称为12345工单关联分析，取消订阅的application名字列表为"动态高纬关系深度分析"。 POST /v2/{project_id}/graphs/{graph_id}/scenes/unregister { "scenes" : [ { "name" : "12345工单关联分析", "applications" : [ "动态高纬关系深度分析" ] } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见获取Token接口，响应消息头中X-Subject-Token的值即为Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 scenes 否 Array of scenes objects 要取消订阅的具体场景列表。 表4 scenes 参数 是否必选 参数类型 描述 name 否 String 场景名。 applications 否 Array of strings 要取消订阅的application 名字列表。