华为云用户手册

URI POST /v1.0/{project_id}/graphs/{graph_id}/action 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 graph_id 是 String 图ID。 表2 Query参数 参数 是否必选 参数类型 描述 action_id 是 String 图actionId。 枚举值： stop

响应 { "data": { "outputs": { "data_return_size": 8, "paths": [ [ "Alice", "Janet", "Yvette", "Willy", "Jay" ], ... [ "Alice", "Jacob", "Jimmy", "Cary", "Jay" ] ], "runtime": 0.005276, "source": "Alice", "data_offset": 0, "paths_number": 8, "data_total_size": 8, "target": "Jay" } } }

请求样例 POST /ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-algorithm { "algorithmName": "filtered_all_shortest_paths", "edge_filter": { "property_filter": { "leftvalue": { "label_name": "labelName" }, "predicate": "=", "rightvalue": { "value": "friends" } } }, "parameters": { "source": "Alice", "target": "Jay", "directed": true } }

请求消息头 附加请求消息头字段，如指定的URI和HTTP方法所要求的字段。例如，定义消息体类型的请求消息头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 表1 公共请求消息头 参数名 是否必选 说明 示例 Content-Type 是 消息体的类型（格式），默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 application/json X-Auth-Token 是 用户Token。例如， IAM 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 - X-Language 是 请求语言。支持配置如下值： zh-cn：中文 en-us：英文 en-us

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 例如，对于IAM获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称。例如cn-north-1，可以从地区和终端节点中获取。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见IAM获取用户Token。 POST https: //iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于IAM获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求URI 图引擎服务业务面API请求URI由如下部分组成。 {URI-scheme} :// {SERVER_URL} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独拿出来强调。 URI-scheme：表示用于传输请求的协议，当前所有API均采用HTTPS协议。 SERVER_URL：图的访问地址，取值请参考业务面API使用限制。 resource-path：资源路径，即API访问路径。从具体API的URI模块获取，例如“ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=query”。 query-string：查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 例如，对于IAM获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称。例如cn-north-1，可以从地区和终端节点中获取。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见IAM获取用户Token。 POST https: //iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于IAM获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求方法 HTTP请求方法（也称为操作或动词），可告知服务正在请求什么类型的操作。 GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源，如删除对象等。 HEAD：请求服务器资源头部。 PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。 例如，在IAM获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独拿出来强调。 URI-scheme：表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint：指定承载REST服务端点的服务器 域名 或IP，从地区和终端节点中获取。例如，图引擎服务在华北-北京一地区的endpoint为ges.cn-north-1.myhuaweicloud.com。 resource-path：资源路径，即API访问路径。从具体API的URI模块获取，例如IAM“获取用户Token”API的resource-path为“v3/auth/tokens”。 query-string：查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如，您需要获取IAM在“华北-北京一”区域的Token，则需使用“华北-北京一”区域的Endpoint（iam.cn-north-1.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也是相同，所以简洁起见将这两部分省略。

请求消息头 附加请求消息头字段，如指定的URI和HTTP方法所要求的字段。例如，定义消息体类型的请求消息头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 表1 公共请求头 参数 是否必选 说明 示例 Content-Type 是 消息体的类型（格式），默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 application/json X-Auth-Token 使用Token方式认证时必选 用户Token。例如，IAM用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 - X-Project-ID 否 子项目ID。在多项目场景中使用，用于不同项目获取token。 e9993fc787d94b6c886cbaa340f9c0f4 Authorization 使用AK/SK认证时必选。 签名认证信息。该值来源于请求签名结果。 - X-Sdk-Date 使用AK/SK认证时必选。 请求的发生时间，格式为(YYYYMMDD'T'HHMMSS'Z')。 取值为当前系统的GMT时间。 20150907T101459Z Host 使用AK/SK认证时必选。 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 code.test.com or code.test.com:443 Content-Length POST/PUT请求必填。 GET不能包含。 请求body长度，单位为Byte。 3495 X-Language 否 请求语言。支持配置如下值： zh-cn：中文 en-us：英文 en-us 华为云API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参考AK/SK认证。 例如，对于IAM获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

响应参数 参数 类型 说明 errorMessage String 系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误信息。 errorCode String 系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误码。 jobId String 执行算法任务ID。请求失败时，字段为空。 说明： 可以利用返回的jobId查看任务执行状态、获取算法返回结果，详情参考查询Job状态(1.0.0)。 edge_betweenness List 各边的betweenness值，格式： [{“source”: sourceId, “target”: targetId , “betweenness”: betweennessValue },...]，其中： betweennessValue：double类型。

请求示例 POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/algorithm { "algorithmName":"edge_betweenness", "parameters":{ "seeds":"1,2", "directed":true } } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

请求参数 表2 请求Body参数 参数 是否必选 类型 说明 algorithmName 是 String 算法名字。 parameters 否 parameters Object 算法参数。 表3 parameters 参数 是否必选 类型 说明 directed 否 Boolean 是否考虑边的方向。取值为true或false，默认值为false。 weight 否 String 边上权重。取值为：空或字符串。 空：边上的权重、距离默认为1。 字符串：对应的边上的属性将作为权重，当某边没有对应属性时，权重将默认为1。 seeds 否 String 节点ID，输入节点个数不大于100000。 当图较大时，运行betweenness较慢，可以设置seeds作为采样节点，进行近似运算，seeds节点越多越接近准确解。 k 否 Integer 采样个数，k不大于100000。 当图较大时，运行betweenness较慢，可以设置k，算法将从图中随机选取k各点，进行采样运算，k值越大约接近准确解。

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

请求示例 POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/algorithm { "algorithmName":"infomap", "parameters":{ "convergence":0.00001, "max_iterations":100 } } 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" }

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

请求参数 表2 请求Body参数 参数 是否必选 类型 说明 algorithmName 是 String 算法名字。 parameters 否 parameters Object 算法参数。 表3 parameters 参数 是否必选 类型 说明 convergence 否 Double 收敛精度，取值范围为(0,1)，默认值为0.00001。 max_iterations 否 Integer 最大迭代次数。API调用限制为[1,2147483647]，前端调用限制为[1,2000]，默认值为100。 weight 否 String 边上权重。取值为：空或字符串，当图中的边没有配置该属性时，算法会报错。 空：边上的权重、距离默认为1。 字符串：对应的边上的属性将作为权重。

响应参数 参数 类型 说明 errorMessage String 系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误信息。 errorCode String 系统提示信息，执行成功时，字段可能为空。执行失败时，用于显示错误码。 jobId String 执行算法任务ID。请求失败时，字段为空。 说明： 可以利用返回的jobId查看任务执行状态、获取算法返回结果，详情参考查询Job状态(1.0.0)。 batch_paths List 批量路径，格式： [paths_element,...] 其中, paths_element,表示从某个source到某个target的路径，格式如： { "paths": [ [ "Alice", "Janet", "Sue", "Serena", "Bonnie" ] ], "source": "Alice", "target": "Bonnie" }, paths_number Integer 路径个数。

响应示例 状态码： 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 参数 是否必选 类型 说明 sources 是 String 起点ID集合，多个节点ID以逗号分隔（即，标准 CS V输入格式），个数不大于100000。 targets 是 String 终点ID集合，多个节点ID以逗号分隔（即，标准CSV输入格式），个数不大于100000。 directed 否 Boolean 是否考虑边的方向。取值为true或false，默认值为false。 说明： 当数据集不包含inedge时，若directed=true，选择一个不依赖于Inedge的算法实现版本计算输出，性能会下降；当directed=false时，会报错。 cutoff 否 Integer 最大长度，取值范围为[1,100]，默认值为6。 path_limit 否 Integer 路径数量上限，取值范围是[1,1000000]，默认值为1000000。

请求示例 POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/algorithm { "algorithmName":"all_pairs_shortest_paths", "parameters":{ "sources":”1,2”, "targets":”5,6”, "directed":true, "cutoff":3, "path_limit":10000 } } SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

请求示例 POST http://{SERVER_URL}/ges/v1.0/{project_id}/hyg/{graph_name}/algorithm { "algorithmName":"personalrank", "parameters":{ "source":"lili", "alpha":0.85, "convergence":0.00001, "max_iterations":1000 } } 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 参数 是否必选 类型 说明 source 是 String 节点id。 alpha 否 Double 权重系数(又称阻尼系数)，取值范围为（0,1），默认值为0.85。 convergence 否 Double 收敛精度，取值范围为（0,1），默认值为0.00001。 max_iterations 否 Integer 最大迭代次数。API调用限制为[1,2147483647]，前端调用限制为[1,2000]，默认值为1000。 directed 否 Boolean 是否考虑边的方向，取值为true或false，默认值为true。

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

功能介绍 根据输入参数，执行personalrank算法。 PersonalRank算法又称Personalized PageRank算法。该算法继承了经典PageRank算法的思想，利用图链接结构来递归计算各节点的重要性。与PageRank算法不同的是，为了保证随机行走中各节点的访问概率能够反映出用户的偏好，PersonalRank算法在随机行走中的每次跳转会以（1-alpha）的概率返回到source节点。

响应示例 状态码： 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，详情请查阅对应的算法参数说明。