算法公共参数
请求参数
|
参数 |
是否必选 |
类型 |
说明 |
|---|---|---|---|
|
algorithmName |
是 |
String |
算法名字。 取值范围(以下显示的均为算法实际调用时的名称):
|
|
parameters |
是 |
Object |
算法参数。详情请参考各算法参数描述。 |
|
参数 |
是否必选 |
类型 |
说明 |
|---|---|---|---|
|
executionMode |
否 |
String |
默认值为“sync”。 支持的算法(以下显示的均为算法实际调用时的名称):
|
|
offset |
否 |
Integer |
同步结果的偏移量,默认值为“0”。
说明:
executionMode=sync时有效。 支持的算法(以下显示的均为算法实际调用时的名称):
|
|
limit |
否 |
Integer |
同步结果返回的最大数量,最大值为100000。默认值为“100000”。
说明:
executionMode=sync时有效。 支持的算法(以下显示的均为算法实际调用时的名称):
|
响应参数
|
参数 |
类型 |
说明 |
|---|---|---|
|
errorMessage |
String |
系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误信息。 |
|
errorCode |
String |
系统提示信息,执行成功时,字段可能为空。执行失败时,用于显示错误码。 |
|
status |
String |
查询成功时返回任务状态,可选值为pending,running,complete。查询失败时字段为空。 |
|
data |
Object |
算法运行的结果。查询失败时字段为空。 |
请求示例
{
"algorithmName":"XXX",
"parameters":{
...
}
}
响应示例
根据输入参数,执行指定算法,查询算法结果(根据算法请求返回的job_id,调用查询job_id接口获取算法结果)。
状态码: 200
成功响应示例
{
"data": {
"outputs": {
"path": [
"46",
"133",
"138"
],
"source": "46",
"target": "138"
}
},
"result": "success"
}
response_data 表示各算法的具体返回结果,不同算法返回结果不同。
状态码: 400
失败响应示例
Http Status Code: 400
{
"errorMessage": "UnSupported value [shortest_path11] for parameter [algorithmName].",
"errorCode": "GES.8402",
"result": "failed"
}