华为云用户手册

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 jobId String 关闭图任务ID。请求失败时为空。 说明： 可以查询jobId查看任务执行状态、获取返回结果，详情参考任务中心API。

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

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 jobId String 启动图任务ID。请求失败时字段为空。 说明： 可以查询jobId查看任务执行状态、获取返回结果，详情参考任务中心API。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取方法请参见获取Token接口，响应消息头中X-Subject-Token的值即为Token。 表4 请求Body参数 参数 是否必选 参数类型 描述 graph_backup_id 否 String 启动图时关联的备份ID，设置此参数时，表示从备份进行启动；如果为空，表示从上次关闭图时的状态启动。可参考新增备份(1.0.0)进行备份。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 jobId String 删除图任务ID。请求失败时字段为空。 说明： 可以查询jobId查看任务执行状态、获取返回结果，详情参考任务中心API。 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。

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。 枚举值：start

URI DELETE /v1.0/{project_id}/graphs/{graph_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 graph_id 是 String 图ID。 表2 Query参数 参数 是否必选 参数类型 描述 keepBackup 否 Boolean 删除图后是否保留备份，默认保留1个自动备份和2个手动备份。该查询参数为空时，表示不保留。

响应示例 状态码： 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" }}

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

响应示例 状态码： 200 成功响应示例 Http Status Code: 200{ "jobId": "03e774f5-29ea-4187-9508-5435f3892ead016886200", "jobType": 1} 状态码： 400 失败响应示例 Http Status Code: 400{ "errorMessage": "Bad Request, parameter labels and vertexFilters cannot all be null", "errorCode": "GES.8203"}

请求示例 查询满足过滤条件的顶点集合，请求的起始位置为0，每页资源数量的最大值为2，用于过滤的属性条件为movie和user，用于过滤的属性名为Age。 POST https://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/vertices/action?action_id=query { "offset":0, "limit":2, "labels": ["movies", "user"], "vertexFilters":[{ "propertyName":"Age", "predicate":"=", "values":["18-24"] } ]} SERVER_URL：图的访问地址，取值请参考业务面API使用限制。 vertexFilters样例1， [ { "propertyName":"Gender", "predicate":"=", "values":["F"] }, { "propertyName":"Age", "predicate":"range", "values":["18-24","56+"], "type":"or" }] vertexFilters样例2（full_text_combination） "vertexFilters": [ { "propertyName": "propertyName", "predicate": "full_text_combination", "values": [ { "propertyName": "movieid", "value": "0" }, { "propertyName": "title", "value": "american" } ] } ] 当predicate为“full_text_match”、“full_text_prefix”、“full_text_wildcard”、“full_text_regexp”和“full_text_fuzzy”、“full_text_combination”时，vertexFilters列表中只能有一个元素，即不能有多层过滤并列存在。labels参数不可以同时出现。当predicate为“full_text_combination”时，最外层的propertyName直接设置为“propertyName”即可， values不再是简单的string类型列表，values的每个元素有“propertyName”和“value”两个成员。如果您想使用以上全文索引的能力，需要预先调用创建全文索引的API。

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

响应示例 状态码： 200 成功响应示例 Http Status Code: 200{ "jobId": "f9987cab-64d3-4b3d-ac43-e91ae0c21bef168127124", "jobType": 0} 状态码： 400 失败响应示例 Http Status Code: 400{ "errorMessage": "Bad Request, parameter labels and edgeFilters cannot all be null", "errorCode": "GES.8103"}

URI GET /ges/v1.0/{project_id}/graphs/{graph_name}/vertices/detail?vertexIds={vertex_ids} 表1 路径参数 参数 是否必选 类型 说明 project_id 是 String 项目ID。获取方法请参见获取项目ID。 graph_name 是 String 图名称。 vertex_ids 是 String 需要查询的节点id列表。当vertexIds指定多个id时，URL中用“,”隔开。 说明： 图规格为持久化版规格的图暂时仅支持一个id。

响应示例 状态码： 200 成功响应示例 Http Status Code: 200{ "data": { "vertices": [ { "id": "Ray", "label": "user", "properties": { "Occupation": [ "college/grad student" ], "Name": [ "雷" ], "Zip-code": [ "90241" ], "Gender": [ "M" ], "Age": [ "18-24" ] } } ] }} 状态码： 400 失败响应示例 Http Status Code: 400 { "errorMessage":"graph [demo] is not found", "errorCode":"GES.8204" }

响应示例 状态码： 200 成功响应示例（不包括图规格为持久化版） Http Status Code: 200{ "data": { "edges": [ { "index": "6", "source": "Ray", "label": "rate", "properties": { "Score": [ 3 ], "Datetime": [ "2000-11-22 19:23:05" ] }, "target": "Rocky" } ] }} 成功响应样例（持久化版） { "data": { "edges": [ { "source": "46", "target": "39", "label": "rate", "sortKey": 5, "properties": { "Rating": [ 5 ], "Datetime": [ "2018-01-0120:30:05" ] } } ] }, "result": "success"} 状态码： 400 失败响应示例 Http Status Code: 400{"errorMessage":"graph [demo] is not found","errorCode":"GES.8107"}

请求示例 请求样例（不包括图规格为持久化版） GET http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/edges/detail?source=Ray&target=Rocky&index=6 请求样例（持久化版） GET/ges/v1.0/{project_id}/graphs/{graph_name}/edges/detail? source=46&&target=39&&label=rate&&sortKey=5&&sortKeyType=int SERVER_URL：图的访问地址，取值请参考业务面API使用限制。

请求参数 表2 Body参数说明 参数 是否必选 类型 说明 project_id 是 String 项目ID。获取方法请参见获取项目ID。 graph_name 是 String 图名称。 sourceVertex 是 String 边的起点。 targetVertex 是 String 边的终点。 index 否 Integer 边的标识号，若不设置，则查询source、target之间所有的边。 说明： 图规格为持久化版的图，暂不支持该参数。 label（持久化版） 否 String 边的label值。 sortKey（持久化版） 否 String 用来区分重复边，重复边指的是：sourceVertex（边的起点）,targetVertex（边的终点）和 label都相同的边。 sortKeyType（持久化版） 否 String sortKey的类型，取值为int/string/null。例如：sortkeyType=int，当sortKey被传入时，此参数为必选。

响应参数 表3 响应Body参数 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 data Object 查询结果。查询成功时显示结果，若查询失败时，字段为空。 表4 data参数说明 参数 是否必选 类型 说明 edges 是 List 边的结果集合。没有查询到对应边时，edges内容为空。

URI （不包括图规格为持久化版） GET /ges/v1.0/{project_id}/graphs/{graph_name}/edges/detail?source={sourceVertex}&target={targetVertex}&index={index} URI （持久化版） GET/ges/v1.0/{project_id}/graphs/{graph_name}/edges/detail?source={sourceVertex}&target={targetVertex}&label={label}&sortKey={sortKey}&sortKeyType={sortKeyType}

响应参数 表2 响应Body参数说明 参数 类型 说明 errorMessage String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段可能为空。 执行失败时，用于显示错误码。 data Object 查询结果。请求失败时，该字段为空。 表3 data参数说明 参数 类型 说明 vertexNum Integer 图的点数。 edgeNum Integer 图的边数。 labelDetails（2.2.14） Object 不同label下的点边数目信息。若需要正常显示此字段，请按照表 labelDetails数据各要素说明建立点边索引。 表4 执行成功时，labelDetails数据各要素说明 参数 类型 说明 labelInVertex Object 不同label下面点的数目，若某label下点的数目为0则不显示。 若需要响应中包含该要素，请参考新建索引，新建索引时索引类型为"GlobalCompositeVertexIndex "，hasLabel为"true",属性列表置空。 labelInEdge Object 不同label下面边的数目，若某label下边的数目为0则不显示。 若需要响应中包含该要素，请参考新建索引，新建索引时索引类型为"GlobalCompositeEdgeIndex "，hasLabel为"true",属性列表置空。 errorMessage String 系统提示信息。 执行成功时，字段为空。 执行失败时，用于显示错误信息。 errorCode String 系统提示信息。 执行成功时，字段为空。 执行失败时，用于显示错误码。

响应示例 状态码： 200 成功响应示例1（返回不同label下点边数目的情况） Http Status Code: 200{ "data": { "vertexNum": 146, "labelDetails": { "labelInVertex": { "movie": 46, "user": 100 }, "labelInEdge": { "default": 450, "rate": 1209 } }, "edgeNum": 1659 }} 成功响应示例2（无法提供不同label下点边数目的情况） Http Status Code: 200{ "data": { "vertexNum": 146, "labelDetails": { "errorMessage": "Label index in vertices is not found.Label index in edges is not found.", "errorCode": "GES.8017" }, "edgeNum": 1659 }} 成功响应示例3（只有不同label下点数目正常返回的情况） Http Status Code: 200{ "data": { "vertexNum": 146, "labelDetails": { "errorMessage": "Label index in edges is not found.", "labelInVertex": { "movie": 46, "user": 100 }, "errorCode": "GES.8017" }, "edgeNum": 1659 }} 响应成功示例（持久化版图规格的响应是jobId ） Http Status Code: 200{"jobId": "f99f60f1-bba6-4cde-bd1a-ff4bdd1fd500000168232"} 状态码： 400 失败响应示例 Http Status Code: 400{ "errorMessage": "graph [demo] is not found", "errorCode": "GES.8001"}

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

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

请求示例 通过读取文件删除点边，点文件目录为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=delete-by-file{ "vertexsetPath": "datasets/movie/movie.csv", "vertexsetFormat": "csv", "edgesetPath": "datasets/movie/ranking_edge.csv", "edgesetFormat": "csv", "targetProperties": [ { "label": "rate", "properties": [ "Rating" ] } ], "delimiter": ",", "trimQuote": "\"", "obsParameters": { "accessKey": "XXXXXXX", "secretKey": "XXXXXXX" }}

响应示例 状态码： 200 成功响应示例 Http Status Code: 200{ "jobId": "b4f2e9a0-0439-4edd-a3ad-199bb523b613"} 状态码： 400 失败响应示例 Http Status Code: 400{ "errorMessage": "parameter format error", "errorCode": "GES.8013"}

概述 欢迎使用函数工作流（FunctionGraph）。FunctionGraph是一项基于事件驱动的函数托管计算服务。通过函数工作流，只需编写业务函数代码并设置运行的条件，无需配置和管理服务器等基础设施，函数以弹性、免运维、高可靠的方式运行。此外，按函数实际执行资源计费，不执行不产生费用。 您可以使用本文档提供API对函数资源进行相关操作，如创建、删除、查询、执行函数等。支持的全部操作请参见API概览。 父主题： 使用前必读

响应示例 状态码： 200 OK { "func_urn" : "urn:fss:xxxxxxxxxx:7aad83af3e8d42e99ac194e8419e2c9b:function:default:test:latest", "func_name" : "test", "domain_id" : "14ee2e3501124efcbca7998baa24xxxx", "runtime" : "Node.js6.10", "code_type" : "inline", "code_filename" : "index.zip", "code_size" : 245, "digest" : "39d51ae334ffb239037e194159f4cc9cec31086719aa73db7d0a608343121a290f7115693e008bd01cb12b99a803856e83aa96173b26c528c41cfed18267e08f", "last_modified" : "2019-10-31 11:37:58", "func_code" : { "file" : "", "link" : "" }, "strategy_config" : { "concurrency" : -1 }} 状态码： 404 Not Found 找不到资源。 { "error_code" : "FSS.1052", "error_msg" : "Not found the function version"}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 func_urn String 函数的URN（Uniform Resource Name），唯一标识函数。 func_name String 函数名称。 domain_id String 域名id。 runtime String FunctionGraph函数的执行环境 Python2.7: Python语言2.7版本。 Python3.6: Pyton语言3.6版本。 Python3.9: Python语言3.9版本。 Go1.8: Go语言1.8版本。 Go1.x: Go语言1.x版本。 Java8: Java语言8版本。 Java11: Java语言11版本。 Node.js6.10: Nodejs语言6.10版本。 Node.js8.10: Nodejs语言8.10版本。 Node.js10.16: Nodejs语言10.16版本。 Node.js12.13: Nodejs语言12.13版本。 Node.js14.18: Nodejs语言14.18版本。 C#(.NET Core 2.0): C#语言2.0版本。 C#(.NET Core 2.1): C#语言2.1版本。 C#(.NET Core 3.1): C#语言3.1版本。 Custom: 自定义运行时。 PHP7.3: Php语言7.3版本。 http: HTTP函数。 枚举值： Java8 Java11 Node.js6.10 Node.js8.10 Node.js10.16 Node.js12.13 Node.js14.18 Python2.7 Python3.6 Go1.8 Go1.x C#(.NET Core 2.0) C#(.NET Core 2.1) C#(.NET Core 3.1) PHP7.3 Python3.9 http code_type String 函数代码类型，取值有4种。 inline: UI在线编辑代码。 zip: 函数代码为zip包。 obs: 函数代码来源于obs存储。 jar: 函数代码为jar包，主要针对Java函数。 枚举值： inline zip obs jar code_url String 当CodeType为obs时，该值为函数代码包在OBS上的地址，CodeType为其他值时，该字段为空。 code_filename String 函数的文件名，当CodeType为jar/zip时必须提供该字段，inline和obs不需要提供。 code_size Long 函数大小，单位：字节。 digest String 函数代码SHA512 hash值，用于判断函数是否变化。 last_modified String 函数最后一次更新时间。 func_code FuncCode object FuncCode结构返回体。 depend_list Array of strings 依赖id列表 depend_version_list Array of strings 依赖版本id列表 strategy_config StrategyConfig object 函数策略配置。 dependencies Array of Dependency objects 函数依赖代码包列表。 表4 FuncCode 参数 参数类型 描述 file String 函数代码，如果不为空必须进行base64编码，为空时使用默认的代码。 link String 函数代码链接。 表5 StrategyConfig 参数 参数类型 描述 concurrency Integer 单函数最大实例数，v1取值0和-1，v2取值-1到1000 -1代表该函数实例数无限制 0代表该函数被禁用 concurrent_num Integer 单实例最大并发数，v2版本才支持，取值-1到1000 表6 Dependency 参数 参数类型 描述 owner String 依赖包属主的domainId。 link String 依赖包在OBS上的链接。 runtime String FunctionGraph函数的执行环境 Python2.7: Python语言2.7版本。 Python3.6: Pyton语言3.6版本。 Python3.9: Python语言3.9版本。 Go1.8: Go语言1.8版本。 Go1.x: Go语言1.x版本。 Java8: Java语言8版本。 Java11: Java语言11版本。 Node.js6.10: Nodejs语言6.10版本。 Node.js8.10: Nodejs语言8.10版本。 Node.js10.16: Nodejs语言10.16版本。 Node.js12.13: Nodejs语言12.13版本。 Node.js14.18: Nodejs语言14.18版本。 C#(.NET Core 2.0): C#语言2.0版本。 C#(.NET Core 2.1): C#语言2.1版本。 C#(.NET Core 3.1): C#语言3.1版本。 Custom: 自定义运行时。 PHP7.3: Php语言7.3版本。 http: HTTP函数。 枚举值： Java8 Java11 Node.js6.10 Node.js8.10 Node.js10.16 Node.js12.13 Node.js14.18 Python2.7 Python3.6 Go1.8 Go1.x C#(.NET Core 2.0) C#(.NET Core 2.1) C#(.NET Core 3.1) Custom PHP7.3 Python3.9 http etag String 依赖包的md5值 size Long 依赖包大小。 name String 依赖包名称。 description String 依赖包描述。 file_name String 依赖包文件名，如果创建方式为zip时。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

触发器类型模型 { "trigger_type_code":"string", "display_name":"string", "status":"string", "event_codes":"array of string", "description":"string" } 触发器类型模型字段说明如表1所示。 表1 触发器类型模型字段说明 字段名称 字段说明 trigger_type_code 触发器类型代码，取值：SMN、APIG、OBS、TIMER、DMS、DIS、LTS、DDS、CTS、kafka、DEDICATEDGATEWAY、APIC。 display_name 触发器类型显示值。 status 触发器类型状态，可能的状态如下： DISABLED：禁用该触发器。 TEST：触发器处于测试状态，用户端应设为不可见。 ACTIVE：触发器可用。 event_codes 触发器事件属性字段。 description 触发器说明。