华为云用户手册

新镜像调试操作 使用命令ma-cli image debug --swr-path=[OPTIONS] SWR-PATH调试镜像。 ma-cli image debug --swr-path=swr.cn-north-4.myhuaweicloud.com/sdk-test/pytorch_1_8:v2 --service=NOTEBOOK --region=cn-north-4 该命令调试镜像swr.cn-north-4.myhuaweicloud.com/sdk-test/pytorch_1_8:v2，-s参数指定该镜像提供Notebook服务。 命令执行后，首先会停止上一次调试相同镜像时已经启动的容器，再进行一些准备工作，最后运行目标镜像，启动一个新容器，并打印相关指令，帮助用户进一步调试新镜像，输出信息如下图所示。 图2 调试镜像 该命令的详细信息请参考ma-cli命令介绍中的调试镜像。

响应参数 表2 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 data Object 要查询的索引数据。 result String 查询结果，成功时为success。 indices List 查询结果，索引列表。 indexType String 查询结果，索引类别。 indexName String 查询结果，索引名称。 indexLabel List 查询结果，局部索引的label列表。 indexProperty List 查询结果，创建的索引属性列表。 hasLabel Boolean 查询结果，索引中是否包含label。 说明： 全文索引该参数默认值为false。

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "data": { "indices": [ { "indexType": "GlobalCompositeVertexIndex", "indexName": "ageIndx", "indexProperty": [ "age" ], "hasLabel": true } ] }, "result": "success" } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": "graph [demo] is not found", "errorCode": "GES.8605" }

响应参数 表2 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 status String 查询成功时返回任务状态，包括以下四种状态： pending:等待中 running:运行中 success:成功 failed:失败 查询失败时字段为空。 data Object 算法运行的结果。查询失败时字段为空。 表3 data参数说明 参数 类型 说明 vertices List 点上关联的算法结果。 edges List 边上关联的算法结果。 outputs Object 其他输出结果。 data_return_size Integer 本次查询返回结果数量。 data_offset Integer 本次查询返回结果偏移量。 data_total_size Integer 异步任务产生的结果数据总量。

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "data": { "outputs": { "data_return_size": 2, "vertices": [ { "id": "Sarah", "label": "user", "properties": { "Occupation": [ "other or not specified" ], "Name": [ "莎拉" ], "Zip-code": [ "55105" ], "Gender": [ "F" ], "Age": [ "18-24" ] } }, { "id": "Sidney", "label": "user", "properties": { "Occupation": [ "writer" ], "Name": [ "西德尼" ], "Zip-code": [ "85296" ], "Gender": [ "M" ], "Age": [ "18-24" ] } } ], "data_offset": 0, "data_total_size": 19 } }, "status": "success" }

URI GET /ges/v1.0/{project_id}/graphs/{graph_name}/jobs/{job_id}/status?offset=offset&limit=limit 表1 路径参数 参数 是否必选 类型 说明 project_id 是 String 项目ID。获取方法请参见获取项目ID。 job_id 是 String Job ID。 offset 否 Integer 本次查询偏移量，默认为0。 limit 否 Integer 本次查询返回最大数量(最大100000)，默认为100000。

最短路径（shortest_path） 表1 parameters参数说明 参数 是否必选 类型 说明 source 是 String 输入路径的起点ID。 target 是 String 输入路径的终点ID。 directed 否 Boolean 是否考虑边的方向，取值为true。 timeWindow 否 Object 用于进行时间过滤的时间窗，具体请参见表2。 说明： timeWindow目前不支持带weight的最短路，即timeWindow与weight不可同时输入。 表2 timeWindow参数说明 参数 是否必选 类型 说明 filterName 是 String 字符串：对应的点/边上的属性作为时间 filterType 否 String 在点或边上过滤，默认值为BOTH。 V：点上 E：边上 BOTH：点和边上 startTime 否 String 起始时间，Date型字符串或时间戳。 endTime 否 String 终止时间，Date型字符串或时间戳。 表3 response_data参数说明 参数 类型 说明 path List 最短路径，格式： [vertexId,...] 其中, vertexId：string类型 source String 起点ID target String 终点ID 父主题： 算法API参数参考

Cypher预置条件 图规格为持久化版的图暂无此约束。 当前的Cypher查询编译过程中使用了基于label的点边索引，如需正常使用Cypher，请使用新建索引API构建索引，示例如下： 点label索引添加命令示例，索引名称为cypher_vertex_index，索引类型为全局点索引。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/indices { "indexName": "cypher_vertex_index", "indexType": "GlobalCompositeVertexIndex", "hasLabel": "true", "indexProperty": [] } 边label索引添加命令示例，索引名称为cypher_edge_index，索引类型为全局边索引。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/indices { "indexName": "cypher_edge_index", "indexType": "GlobalCompositeEdgeIndex", "hasLabel": "true", "indexProperty": [] } 图规格为一亿边、十亿边、百亿边规格时，不需要进行此步骤（图版本要求2.3.6及以上）。 需要同时添加两个索引（点label索引和边label索引）才能正常使用Cypher查询。 如果图中已经存在hasLabel为true, indexProperty为空的点索引或边索引，则不需要重复构建。 添加索引API为异步接口，查询索引是否添加成功，请使用查询Job状态API。 细粒度权限开启时使用子帐号创建索引，需要子帐号具有schema权限、所有label（包括默认label“__DEFAULT__”）的读权限。否则创建索引后需要使用具备相应权限的帐号发送“call db.schema()”对Cypher查询编译缓存进行刷新。 父主题： Cypher操作API

personalrank算法(1.0.0) 表1 parameters参数说明 参数 是否必选 类型 说明 source 是 String 节点的ID。 alpha 否 Double 权重系数(又称阻尼系数)，取值范围为（0,1），默认值为0.85。 convergence 否 Double 收敛精度。 取值范围0~1，不包括0和1，默认值为0.00001。 max_iterations 否 Integer 最大迭代次数。API调用限制为[1,2147483647]，前端调用限制为[1,2000]，默认值为1000。 num_thread 否 Integer 并发线程数。范围为[1,40]，小于1会自动置为1，大于40则自动置为40。默认值为4。 directed 否 Boolean 是否考虑边的方向，取值为true或false，默认值为true。 关于迭代次数（iterations）和收敛精度（convergence）参数如何调节，请参考迭代次数和收敛精度的关系。 表2 response_data参数说明 参数 类型 说明 source String - personalrank List 各节点的personalrank值，格式： [{vertexId:rankValue},...], 其中, vertexId：string类型 rankValue：double类型 父主题： 算法API参数参考

k跳算法（k_hop）(1.0.0) 表1 parameters参数说明 参数 是否必选 类型 说明 k 是 Integer 跳数，取值范围[1,100]。 num_thread 否 Integer 并发线程数。范围为[1,40]，小于1会自动置为1，大于40则自动置为40。默认值为4。 source 是 String 节点的ID。 mode 否 String 方向，取值如下： OUT：沿出边跳。 IN：沿入边跳。 ALL：双向跳。 默认值为OUT statistics 否 Boolean 是否仅返回邻居数统计结果，取值为true或false，默认值为false。 表2 response_data参数说明 参数 类型 说明 vertices List k跳内的节点id，格式： [vertexId,...], 其中，vertexId：string类型 source String 起点id。 k Integer 跳数。 k_hop_neighbors Integer k跳内的节点个数（不包含起点）。 父主题： 算法API参数参考

pagerank算法(1.0.0) 表1 parameters参数说明 参数 是否必选 类型 说明 alpha 否 Double 权重系数(又称阻尼系数)，取值范围为（0,1），默认值为0.85。 convergence 否 Double 收敛精度。取值范围(0,1)，默认值为0.00001。 max_iterations 否 Integer 最大迭代次数。API调用限制为[1,2147483647]，前端调用限制为[1,2000]，默认值为1000。 num_thread 否 Integer 并发线程数。范围为[1,40]，小于1会自动置为1，大于40则自动置为40。默认值为4。 directed 否 Boolean 是否考虑边的方向。取值为true或false。默认值为true。 迭代次数（iterations）和收敛精度（convergence）。 算法终止的条件：要么达到设置的最大迭代次数，要么满足收敛精度，满足其一即可。 一般来说，收敛精度设置得越小，迭代次数设置得越大，算法的效果越好。 在固定收敛精度的情况下，要想算法优先满足收敛精度，迭代次数设置得尽量大。 迭代次数越大，算法运行时间越长。在固定迭代次数（即固定运行时间）的情况下，要想算法运行到设置的迭代次数，收敛精度设置得尽量小。 表2 response_data参数说明 参数 类型 说明 pagerank List 各节点的pagerank值，格式： [{vertexId:rankValue},...], 其中, vertexId：string类型 rankValue：double类型 父主题： 算法API参数参考

标签传播（label_propagation）(2.1.8) 表1 parameters参数说明 参数 是否必选 说明 类型 取值范围 默认值 convergence 否 收敛精度。 Double 0~1，不包括0和1。 0.00001 max_iterations 否 最大迭代次数。 Integer 最大迭代次数。API调用限制为[1,2147483647]，前端调用限制为[1,2000]，默认值为1000。 1000 initial 否 点上用作初始化标签的属性名称 String 空或字符串。 空：每个节点各自分配一个特有的初始化标签；适用于事先没有任何节点标注信息的情况。 字符串：将节点的对应的属性字段取值作为初始化标签（类型为string，对于未知标签的点，初始化标签字段赋空）；适用于已标注部分节点标签，预测未知节点标签的情况。 说明： 当initial取值为“字符串”时，其中具有初始化标签的点的数量应大于0，小于点总数。 - 关于迭代次数（iterations）和收敛精度（convergence）参数如何调节，请参考迭代次数和收敛精度的关系。 表2 reponse_data参数说明 参数 类型 说明 community List 各节点对应的社团(community)，格式： [{vertexId:communityId},...] 其中, vertexId: string类型 communityId: string类型 父主题： 算法API参数参考

请求参数 表2 Body参数说明 参数 是否必选 类型 说明 vertices 是 Json 待添加的顶点数组，一次最多添加1万个点。数组参数详见vertices参数说明。 overrideExists 否 Boolean 检测待插入的点是否存在，默认值为false。 当值为false时，只要有一个点存在，就会报错，且这批点均写入失败。 当值为true时，对已存在的点采取覆盖写策略。 表3 vertices参数说明 参数 是否必选 类型 说明 vertex 是 String 点ID。 label 是 String 点的label。 properties 否 Json 各个属性的值。

请求示例 批量添加点，待添加的顶点数组的点名称分别为150，6。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-add { "vertices": [ { "vertex": "150", "label": "movie", "properties": { "movieid": [ "150" ], "title": [ "testmoive" ], "genres": [ "Comedy" ] } }, { "vertex": "6", "label": "movie", "properties": { "movieid": [ "6" ], "title": [ "testmoive_exist_id" ], "genres": [ "Comedy" ] } } ], "overrideExists": true } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。 样例中，假设“6”这个点已存在图中，则覆盖“6”这个点的属性。

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "jobId": "fb74314e-a82d-41b2-8900-96e2559fa0d9000168232", "jobType": 9 } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": "graph [demo] is not found", "errorCode": "GES.8604 " }

响应参数 表2 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 result String 查询成功时值为success,失败时值为failed。 jobs Object 查询成功时包含jobs字段，jobs字段中包含系统中保存的job状态列表，单个job的状态结构如表3。 表3 job状态结构 参数 类型 说明 jobId String Job名称。 request Object 请求内容，包括command、url和body体。 status String Job执行状态，取值为pending/running/complete。

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "jobs": [ { "jobId": "62582163123991943683d0f9aa3-f701-48be-a662-360e6a0455da", "status": "complete", "request": { "command": "import_graph", "url": "/ges/v1.0/10001/graphs/moviejx/action?action_id=import-graph", "body": { "edgesetPath": "file:///root/ges-install/auDatas/ranking_edge-sp.csv", "vertexsetPath": "file:///root/ges-install/auDatas/movies_vertex_new.csv", "schemaPath": "file:///root/ges-install/auDatas/schema_aikv.xml.bak" } } }, { "jobId": "62582163123991943683fe74caf-f4d3-48b3-b3ee-66daaedcd2ca", "status": "complete", "request": { "command": "import_graph", "url": "/ges/v1.0/10001/graphs/moviejx/action?action_id=import-graph", "body": { "edgesetPath": "file:///root/ges-install/auDatas/ranking_edge-sp.csv", "vertexsetPath": "file:///root/ges-install/auDatas/movies_vertex_new.csv", "schemaPath": "file:///root/ges-install/auDatas/schema_aikv.xml.bak" } } }, { "jobId": "6258216312399194368daa80df3-e3bd-440d-9764-74f4622a550f", "status": "complete", "request": { "command": "import_graph", "url": "/ges/v1.0/10001/graphs/moviejx/action?action_id=import-graph", "body": { "edgesetPath": "file:///root/ges-install/auDatas/ranking_edge-sp.csv", "vertexsetPath": "file:///root/ges-install/auDatas/movies_vertex_new.csv", "schemaPath": "file:///root/ges-install/auDatas/schema_aikv.xml.bak" } } }, { "jobId": "62582163123991943680ed2761f-01f7-4fbf-b867-0a9aae6d9c12", "status": "complete", "request": { "command": "import_graph", "url": "/ges/v1.0/10001/graphs/moviejx/action?action_id=import-graph", "body": { "edgesetPath": "file:///root/ges-install/auDatas/ranking_edge-sp.csv", "vertexsetPath": "file:///root/ges-install/auDatas/movies_vertex_new.csv", "schemaPath": "file:///root/ges-install/auDatas/schema_aikv.xml.bak" } } } ], "result": "success" } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": "graph : movidde not exist", "errorCode": "GES.8000", "result": "failed" }

请求示例 执行指定算法，算法名字为pagerank，算法的权重系数为0.85，收敛精度为0.00001，最大迭代次数为1000，考虑边的方向。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-algorithm { "algorithmName":"pagerank", "parameters":{ "alpha":0.85, "convergence":0.00001, "max_iterations":1000, "directed":true } } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

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

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "jobId": "4448c9fb-0b16-4a78-8d89-2a137c53454a001679122", "jobType": 1 } 状态码：4200 失败响应示例 Http Status Code: 400 { "errorMessage":"graph [demo] is not found", "errorCode":"GES.8402" }

点集共同邻居(common_neighbors_of_vertex_sets) 表1 parameters参数说明 参数 是否必选 说明 类型 取值范围 默认值 sources（2.2.6） 是 起点ID集合 String 标准csv格式，ID之间以英文逗号分隔，例如：“Alice,Nana”。 个数不大于100000。 - targets（2.2.6） 是 终点ID集合 String 标准csv格式，ID之间以英文逗号分隔，例如：“Mike,Amy”。 个数不大于100000。 - restricted（2.2.13） 否 是否带其他约束 Boolean true或false。 false：不带额外约束，即找到的共同邻居为起点集和终点集对应邻域的交集。 true，带额外约束，这里指找到的共同邻居不仅是起点集和终点集邻域的交集，同时共同邻居集合中的每个点都至少有2个以上邻居节点在起点集和终点集中。 true 表2 response_data参数说明 参数 类型 说明 vertices List 公共邻居节点，格式： [vertexId,...], 其中, vertexId：string类型 common_neighbors Integer 公共邻居节点个数。 父主题： 算法API参数参考

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "jobId": "b4f2e9a0-0439-4edd-a3ad-199bb523b613" } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorCode": "GES.8012", "errorMessage": "graph [movie2] is not found" }

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

请求示例 批量更新点属性，待更新的顶点数组的点名称分别为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使用限制。

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "version":"2.0.0" } 状态码： 400 失败响应示例 Http Status Code: 404 { "errorMessage":"Not found. Please check the input parameters.", "errorCode": "GES.8000" }

请求示例 根据批量节点ID删除节点，待删除的顶点ID数组为Vivian和46。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=batch-delete { "vertices": [ "Vivian", "46" ] } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

响应示例 状态码： 200 成功响应示例 Http Status Code: 200 { "result": "success" } 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage": " Bad Request, parameter vertices cannot be null", "errorCode": "GES.8214" }

louvain算法（louvain）(2.2.1) 表1 parameters参数说明 参数 是否必选 说明 类型 取值范围 默认值 convergence 否 收敛精度。 Double 0~1，不包括0和1。 0.00001 max_iterations 否 最大迭代次数。 Integer API调用限制为[1,2147483647]，前端调用限制为[1,2000]，默认值为100。 100 weight 否 边上权重 String 空或字符串 空：边上的权重、距离默认为“1” 字符串：对应的边上的属性将作为权重，当某边没有对应属性时，权重将默认为“1” 说明： 边上权重应大于0。 weight 关于迭代次数（iterations）和收敛精度（convergence）参数如何调节，请参考迭代次数和收敛精度的关系。 表2 reponse_data参数说明 参数 类型 说明 modularity Double 模块度。 community_num Integer 社团数量。 community List 各节点对应的社团(community)，格式： [{vertexId:communityId},...] 其中, vertexId: string类型 communityId: string类型 父主题： 算法API参数参考

知识图谱应用 基于图引擎服务的知识图谱，融合各种异构异质数据，可以支持更大的规模以及更高的性能。 该场景能帮助您实现以下功能。 存储海量知识 融合各种异构异质数据，方便治理，规模可达千亿级。 快速关联查询 在海量知识中快速关联查询秒级响应，搜索结果更准确。 知识梳理 通过图上分析计算，合并相似本体，进行知识消岐。 学习路径的识别及推荐 通过知识点的先修关系，识别学习路径，针对薄弱知识点进行学习路径推荐。

城市工业应用 帮助客户对城市路网或管道（如水气电油管道等）进行压力调节、负载平衡，提升交通网络、管道等的通过性，进行精细化控制。 该场景能帮助您实现以下功能。 管道压力调节 根据管道实时监控数据，对管道全网进行流量压力分析，为管道阀门控制进行辅助决策，实现精细化调控。 城市路网调控 结合车流信息、路网信息、路口监控信息等，对城市路网进行车流拥堵分析，为信号灯控制进行辅助决策。 路径设计 可以根据人与车的请求，进行实时路径设计，提高上座率，减少运营成本。