文档首页> 函数工作流 FunctionGraph> API参考> API> 函数异步配置> 获取函数异步配置列表
更新时间：2024-03-14 GMT+08:00
查看PDF

获取函数异步配置列表

功能介绍

获取指定函数所有版本的异步配置列表。。

URI

GET /v2/{project_id}/fgs/functions/{function_urn}/async-invoke-configs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

function_urn

是

String

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

参数

是否必选

参数类型

描述

marker

否

String

上一次查询到的最后的记录位置。

最大长度：64

limit

否

String

每页显示的条目数量。

  • 如果不提供该值或者提供的值等于0，则使用默认值：10，最大值100，大于100取值100。

  • 如果该值小于0，则返回参数错误。

缺省值：10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

Content-Type

是

String

消息体的类型（格式）

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

async_invoke_configs

Array of ListFunctionAsyncInvokeConfigResult objects

函数异步配置列表。

count

Long

列表总数。

最小值：0

page_info

PageInfo object
表5 ListFunctionAsyncInvokeConfigResult

参数

参数类型

描述

func_urn

String

函数URN。

最小长度：1

最大长度：269

max_async_event_age_in_seconds

Integer

消息最大存活时长，取值范围[60，86400]。单位：秒。

max_async_retry_attempts

Integer

异步调用失败后的最大重试次数，默认值为3。取值范围[0，8]。

destination_config

FuncAsyncDestinationConfig object

异步调用目标。

created_time

String

异步调用配置的创建时间。

last_modified

String

异步调用配置的最后更改时间。

enable_async_status_log

Boolean

开启异步调用状态持久化
表6 FuncAsyncDestinationConfig

参数

参数类型

描述

on_success

FuncDestinationConfig object

当函数执行成功时，函数计算将调用该配置对应的目标。

on_failure

FuncDestinationConfig object

当函数执行失败（系统错误或函数内部错误）时，函数计算将调用该配置对应的目标。
表7 FuncDestinationConfig

参数

参数类型

描述

destination

String

目标类型。

  • OBS：通知到OBS服务。

  • SMN：通知到SMN服务。

  • DIS：通知到DIS服务。

  • FunctionGraph： 通知到函数服务。

枚举值：

  • OBS

  • SMN

  • DIS

  • FunctionGraph

param

String

通知目标服务对应参数,json字符串。

  • OBS：包含bucket桶，对象目录前缀prefix，对象默认expires过期时间[0~365]天，0默认不过期。

  • SMN：包含smn 主题topic_urn。

  • DIS：包含DIS 通道名stream_name。

  • FunctionGraph：包含func_urn，函数urn
表8 PageInfo

参数

参数类型

描述

next_marker

Long

下一次读取位置

previous_marker

Long

上一次读取位置

current_count

Long

当前页总数

请求示例

获取函数异步配置列表。

GET /v2/{project_id}/fgs/functions/{function_urn}/async-invoke-configs

响应示例

状态码： 200

Ok

{
  "async_invoke_configs" : [ {
    "func_urn" : "urn:fss:{region}:5691ba790e2b46ceb38316xxxxxxxxxx:function:default:test_async:latest",
    "max_async_event_age_in_seconds" : 60,
    "max_async_retry_attempts" : 1,
    "destination_config" : {
      "on_success" : {
        "destination" : "FunctionGraph",
        "param" : "{\"func_urn\":\"urn:fss:{region}:5691ba790e2b46ceb38316xxxxxxxxxx:function:default:testPython:latest\"}"
      },
      "on_failure" : {
        "destination" : "FunctionGraph",
        "param" : "{\"func_urn\":\"urn:fss:{region}:5691ba790e2b46ceb38316xxxxxxxxxx:function:default:testPython:latest\"}"
      }
    },
    "created_time" : "2021-03-04T14:50:02+08:00",
    "last_modified" : "2021-03-04 14:50:02"
  } ],
  "count" : 2,
  "page_info" : {
    "next_marker" : 2,
    "previous_marker" : 0,
    "current_count" : 2
  }
}

状态码

状态码

描述

200

Ok

错误码

请参见错误码。

父主题： 函数异步配置