文档首页/ 函数工作流 FunctionGraph/ API参考/ API/ 函数调用/ 函数异步执行并返回预留实例ID - AsyncInvokeReservedFunction
更新时间:2026-10-21 GMT+08:00
分享

函数异步执行并返回预留实例ID - AsyncInvokeReservedFunction

功能介绍

函数异步执行并返回预留实例ID用于场景指客户端请求执行比较费时任务,不需要同步等待执行完成返回结果,该方法提前返回任务执行对应的预留实例ID, 如果预留实例有异常,可以通过该实例ID把对应实例删除(该接口主要针对白名单用户)。

目前仅支持广州和贵阳一

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。

URI

POST /v2/{project_id}/fgs/functions/{function_urn}/reserved-invocations

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

只能由英文字母、数字组成,且长度为32个字符

默认值:

不涉及

function_urn

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

只能由字母、数字、下划线、中划线、冒号组成

默认值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。

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

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

{自定义key}

是

Object

执行函数请求体,为json格式。

响应参数

状态码:202

表4 响应Header参数

参数

参数类型

描述

Content-Type

String

application/json

表5 响应Body参数

参数

参数类型

描述

instance_id

String

预留实例id

状态码:404

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

函数异步执行并返回预留实例ID。

POST /v2/{project_id}/fgs/functions/{function_urn}/reserved-invocations

{
  "body" : "",
  "requestContext" : {
    "apiId" : "bc1dcffd-xx",
    "requestId" : "xxx",
    "stage" : "RELEASE"
  },
  "queryStringParameters" : {
    "responseType" : "html"
  },
  "httpMethod" : "GET",
  "pathParameters" : null,
  "headers" : {
    "accept-language" : "zh-CN,zh;q=0.8,zh-TW;q=0.7,zh-HK;q=0.5,en-US;q=0.3,en;q=0.2",
    "accept-encoding" : "gzip, deflate, br",
    "x-forwarded-port" : "443",
    "x-forwarded-for" : "127.0.0.1",
    "x-forwarded-proto" : "https"
  },
  "path" : "/apig-event-template",
  "isBase64Encoded" : true
}

响应示例

状态码:202

{
  "instance_id" : "048bad9b-96ae-45ad-8f12-4061a744ef9d"
}

状态码:404

{
  "error_code" : "FSS.1051",
  "error_msg" : "Not found the function"
}

状态码

状态码

描述

202

Accepted

404

Not Found

错误码

请参见错误码。

相关文档