文档首页> 函数工作流 FunctionGraph> API参考> API> 函数异步配置> 停止函数异步调用请求
更新时间：2024-03-14 GMT+08:00
查看PDF

停止函数异步调用请求

功能介绍

当前仅支持参数recursive为false且force为true的函数。 在1：N的函数做并发异步调用的场景下调用停止异步请求接口时，同一函数实例同时在执行的其他请求也会被一并停止并返回4208 function invocation canceled

URI

POST /v2/{project_id}/fgs/functions/{function_urn}/cancel

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目 ID，获取方式请参见获取项目ID。

function_urn

是

String

函数的URN，详细解释见FunctionGraph函数模型的描述。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

Content-Type

是

String

消息体的类型（格式）
表3 请求Body参数

参数

是否必选

参数类型

描述

request_id

是

String

被停止的请求id

type

否

String

停止的类型 支持recursive, force。 recursive: 停止正在调用的子函数。 force: 直接终止runtime。

枚举值：

  • force

  • recursive

响应参数

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码： 403

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码： 404

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

停止函数异步调用请求。

POST /v2/{project_id}/fgs/functions/{function_urn}/cancel

{
  "request_id" : "xxxx"
}

响应示例

状态码： 200

OK

null

状态码： 400

Invalid RequestId

{
  "error_code" : "FSS.0400",
  "error_msg" : "Invalid RequestId"
}

状态码： 403

FORBIDDEN

{
  "error_code" : "FSS.0403",
  "error_msg" : "invalid token"
}

状态码： 404

Not Found

{
  "error_code" : "FSS.0404",
  "error_msg" : "can not find function"
}

状态码： 500

内部错误

{
  "error_code" : "FSS.0500",
  "error_msg" : "xxx"
}

状态码

状态码

描述

200

OK

400

Invalid RequestId

403

FORBIDDEN

404

Not Found

500

内部错误

错误码

请参见错误码。

父主题： 函数异步配置