更新时间:2024-03-21 GMT+08:00
分享

设置函数异步配置信息

功能介绍

设置函数异步配置信息。

调用方法

请参见如何调用API

URI

PUT /v2/{project_id}/fgs/functions/{function_urn}/async-invoke-config

表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参数

参数

是否必选

参数类型

描述

max_async_event_age_in_seconds

Integer

消息最大存活时长,取值范围[1,86400],单位:秒,默认值为3600。

最小值:1

最大值:86400

max_async_retry_attempts

Integer

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

最小值:0

最大值:3

destination_config

FuncAsyncDestinationConfig object

异步调用目标。

enable_async_status_log

Boolean

开启异步调用状态持久化

表4 FuncAsyncDestinationConfig

参数

是否必选

参数类型

描述

on_success

FuncDestinationConfig object

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

on_failure

FuncDestinationConfig object

当函数执行失败(系统错误或函数内部错误)时,函数计算将调用该配置对应的目标。

表5 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

响应参数

状态码: 200

表6 响应Body参数

参数

参数类型

描述

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

开启异步调用状态持久化

表7 FuncAsyncDestinationConfig

参数

参数类型

描述

on_success

FuncDestinationConfig object

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

on_failure

FuncDestinationConfig object

当函数执行失败(系统错误或函数内部错误)时,函数计算将调用该配置对应的目标。

表8 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

状态码: 400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 404

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

设置函数异步配置信息,消息最大存活时间设置为10s,最大重试次数为3次,开启异步调用状态持久化。

PUT /v2/{project_id}/fgs/functions/{function_urn}/async-invoke-config

{
  "max_async_event_age_in_seconds" : 10,
  "max_async_retry_attempts" : 3,
  "enable_async_status_log" : true
}

响应示例

状态码: 200

Ok

{
  "func_urn" : "urn:fss:xxxxxxxxx:7aad83af3e8d42e99ac194xxxxxxxxxx:function:default:test: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"
}

SDK代码示例

SDK代码示例如下。

设置函数异步配置信息,消息最大存活时间设置为10s,最大重试次数为3次,开启异步调用状态持久化。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.functiongraph.v2.region.FunctionGraphRegion;
import com.huaweicloud.sdk.functiongraph.v2.*;
import com.huaweicloud.sdk.functiongraph.v2.model.*;


public class UpdateFunctionAsyncInvokeConfigSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        FunctionGraphClient client = FunctionGraphClient.newBuilder()
                .withCredential(auth)
                .withRegion(FunctionGraphRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateFunctionAsyncInvokeConfigRequest request = new UpdateFunctionAsyncInvokeConfigRequest();
        UpdateFunctionAsyncInvokeConfigRequestBody body = new UpdateFunctionAsyncInvokeConfigRequestBody();
        body.withEnableAsyncStatusLog(true);
        body.withMaxAsyncRetryAttempts(3);
        body.withMaxAsyncEventAgeInSeconds(10);
        request.withBody(body);
        try {
            UpdateFunctionAsyncInvokeConfigResponse response = client.updateFunctionAsyncInvokeConfig(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

设置函数异步配置信息,消息最大存活时间设置为10s,最大重试次数为3次,开启异步调用状态持久化。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkfunctiongraph.v2.region.functiongraph_region import FunctionGraphRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkfunctiongraph.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = FunctionGraphClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(FunctionGraphRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateFunctionAsyncInvokeConfigRequest()
        request.body = UpdateFunctionAsyncInvokeConfigRequestBody(
            enable_async_status_log=True,
            max_async_retry_attempts=3,
            max_async_event_age_in_seconds=10
        )
        response = client.update_function_async_invoke_config(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

设置函数异步配置信息,消息最大存活时间设置为10s,最大重试次数为3次,开启异步调用状态持久化。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    functiongraph "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/functiongraph/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/functiongraph/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/functiongraph/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := functiongraph.NewFunctionGraphClient(
        functiongraph.FunctionGraphClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateFunctionAsyncInvokeConfigRequest{}
	enableAsyncStatusLogUpdateFunctionAsyncInvokeConfigRequestBody:= true
	maxAsyncRetryAttemptsUpdateFunctionAsyncInvokeConfigRequestBody:= int32(3)
	maxAsyncEventAgeInSecondsUpdateFunctionAsyncInvokeConfigRequestBody:= int32(10)
	request.Body = &model.UpdateFunctionAsyncInvokeConfigRequestBody{
		EnableAsyncStatusLog: &enableAsyncStatusLogUpdateFunctionAsyncInvokeConfigRequestBody,
		MaxAsyncRetryAttempts: &maxAsyncRetryAttemptsUpdateFunctionAsyncInvokeConfigRequestBody,
		MaxAsyncEventAgeInSeconds: &maxAsyncEventAgeInSecondsUpdateFunctionAsyncInvokeConfigRequestBody,
	}
	response, err := client.UpdateFunctionAsyncInvokeConfig(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

Ok

400

Bad Request

404

Not Found

错误码

请参见错误码

相关文档