华为云用户手册

  • 响应参数 表5 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误信息。 errorCode String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误码。 jobId String 执行该异步任务的jobId。 可以查询jobId查看任务执行状态、获取返回结果,详情参考Job管理API。
  • 响应示例 状态码: 200 成功响应示例 Http Status Code: 200 { "jobId": "b4f2e9a0-0439-4edd-a3ad-199bb523b613" } 状态码: 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" } }
  • 标签传播(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参数参考
  • 请求示例 根据批量边的起点、终点以及索引来查询这些边的详细信息,待查询边的source节点为Vivian。 POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/edges/action?action_id=batch-query { "edges": [ { "source": "Vivian", "target": "Lethal Weapon", "label": "rate" }, { "source": "Vivian", "target": "Raising Arizona" } ] } SERVER_URL:图的访问地址,取值请参考业务面API使用限制。
  • 响应示例 状态码: 200 响应成功示例 { "data": { "edges": [ { "source": "Vivian", "target": "Raising Arizona", "label": "rate", "properties": { "Score": [ 4 ], "Datetime": [ "2000-12-27 23:51:42" ] } }, { "source": "Vivian", "target": "Lethal Weapon", "label": "rate", "properties": { "Score": [ 5 ], "Datetime": [ "2000-12-27 23:44:41" ] } } ] }, "result": "success" }
  • 响应参数 表4 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误信息。 errorCode String 系统提示信息。 执行成功时,字段可能为空。 执行失败时,用于显示错误码。 data String 查询成功时包含data字段,data字段中包含edges查询结果。 result String 查询成功时值为success,失败时值为failed。
  • 请求参数 表2 Body参数说明 参数 是否必选 类型 说明 edges 是 Object 待查询的边数组。 表3 edges参数说明 参数 是否必选 类型 说明 source 是 String 边的source节点。 target 是 String 边的target节点。 label 否 String 边的label。 sortKey 否 String/int/null 重复边的sortKey,查询时给出sortKey必须给出label。
  • 响应示例 状态码: 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参数参考
  • 互联网应用 在移动互联网时代,面对庞大的社交关系,媒体传播网络,GES可以帮助客户快速、有效的发现海量数据中隐含的信息。 该场景能帮助您实现以下功能。 推荐好友、商品或资讯 通过好友关系、用户画像、行为相似性、商品相似性、资讯传播的途径等,实现好友、商品或资讯的个性化推荐。 用户分群 通过对用户画像、行为相似度或者好友关系等,进行用户分群,实现用户群体分析管理。 异常的行为分析 通过对用户行为、伴行关系、账户/IP登录信息等,进行异常的行为分析,降低欺诈损失。 舆情&社会化聆听 通过对资讯传播、好友关系分析,识别大V及热点话题,分析传播的途径,增强舆情分析质量。
  • 企业IT应用 网络&IT基础设备规模庞大、结构复杂,帮助客户深入了解设备状态、设备之间的关系,实现全网络设备智能监控与管理。 该场景能帮助您实现以下功能。 合理规划网络 快速确定故障节点对网络的影响,并在最依赖的节点周围推荐备用路由,在新节点的规划时,精准规划网络位置。 分析故障根因 快速轻松地识别任何网络或基础设施问题的根本原因,也让您能更好地了解构成IT基础架构的所有组件和关系。 IT基础设施管理 通过图形化网络设备关联关系,让您更好的了解设备、资产的状态,极大降低设备管理成本。
  • 知识图谱 应用 基于图引擎服务的知识图谱,融合各种异构异质数据,可以支持更大的规模以及更高的性能。 该场景能帮助您实现以下功能。 存储海量知识 融合各种异构异质数据,方便治理,规模可达千亿级。 快速关联查询 在海量知识中快速关联查询秒级响应,搜索结果更准确。 知识梳理 通过图上分析计算,合并相似本体,进行知识消岐。 学习路径的识别及推荐 通过知识点的先修关系,识别学习路径,针对薄弱知识点进行学习路径推荐。
  • 城市工业应用 帮助客户对城市路网或管道(如水气电油管道等)进行压力调节、负载平衡,提升交通网络、管道等的通过性,进行精细化控制。 该场景能帮助您实现以下功能。 管道压力调节 根据管道实时监控数据,对管道全网进行流量压力分析,为管道阀门控制进行辅助决策,实现精细化调控。 城市路网调控 结合车流信息、路网信息、路口监控信息等,对城市路网进行车流拥堵分析,为信号灯控制进行辅助决策。 路径设计 可以根据人与车的请求,进行实时路径设计,提高上座率,减少运营成本。
  • 调用API(Node.js)示例 在工程中引入signer.js。 var signer = require('./signer') var http = require('http') 生成一个新的Signer,填入AppKey和AppSecret。 var sig = new signer.Signer() // Directly writing AK/SK in code is risky. For security, encrypt your AK/SK and store them in the configuration file or environment variables. // In this example, the AK/SK are stored in environment variables for identity authentication. Before running this example, set environment variables HUAWEICLOUD_SDK_AK and HUAWEICLOUD_SDK_SK. sig.Key = "4f5f****100c" sig.Secret = "******" 生成一个Request对象,指定方法名、请求uri和body。 var r = new signer.HttpRequest("POST", "c967a237-cd6c-470e-906f-a8655461897e.apigw.exampleRegion.com/app1?a=1"); r.body = '{"a":1}' 给请求添加x-stage头,内容为环境名。如有需要,添加需要签名的其他头域。 r.headers = { "x-stage":"RELEASE" } 进行签名,执行此函数会生成请求参数,用于创建http(s)请求,请求参数中添加了用于签名的X-Sdk-Date头和Authorization头。 var opts = sig.Sign(r) 访问API,查看访问结果。如果使用https访问,则将“http.request”改为“https.request”。 var req=http.request(opts, function(res){ console.log(res.statusCode) res.on("data", function(chunk){ console.log(chunk.toString()) }) }) req.on("error",function(err){ console.log(err.message) }) req.write(r.body) req.end()
  • 批量算路-驾车 在驾车条件下批量计算路径。 输入参数 用户配置批量算路-驾车执行动作,相关参数说明如表12所示。 表12 批量算路-驾车输入参数说明 参数 必填 说明 起点经度 是 起点经度,取值范围:[-180,180]。 起点维度 是 起点维度,取值范围:[-90,90]。 终点经度 是 终点经度,取值范围:[-180,180]。 终点维度 是 终点维度,取值范围:[-90,90]。 预计出发时间 否 预计出发时间,必须是当前或者未来时间,不能是过去时间。 时间预估模型 否 时间预估模型。0:best guess;1:路况差于历史平均水平;2路况优于历史平均水平。默认值为0。 文字指引/描述语种 否 文字指引/描述的语种。 所指示的特性 否 计算出的路径应避免所指示的特性。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表13。 表13 批量算路-驾车输出参数说明 参数 说明 从起点到目的地的规划路径 从起点到目的地的规划路径。如果没有结果,返回空数组。 距离矩阵结果每个单元格的信息 距离矩阵结果每个单元格的信息。 Duration的文本描述 Duration的文本描述。 行驶距离 行驶距离,单位:米。 Duration的文本描述 Duration的文本描述。 错误码 起点和终点进行路径规划计算的错误码,具体请参见错误码。 行驶时长 行驶时长,单位:秒。 返回码 返回码。 返回值描述 返回值描述。 起点地址详情 起点地址详情。 目的地地址详情 目的地地址详情。
共100000条