更新时间:2025-07-31 GMT+08:00
分享

获取函数异步配置信息

功能介绍

获取指定函数某一版本的异步配置信息。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

function_urn

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

Content-Type

String

参数解释:

消息体的类型(格式)。

约束限制:

不涉及。

取值范围:

只能为application/json

默认取值:

application/json

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

func_urn

String

参数解释

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

取值范围

只能由字母、数字、下划线、中划线、冒号组成,长度1-269位。

max_async_event_age_in_seconds

Integer

参数解释

异步消息保存最大时长,单位秒。

取值范围

0到86400秒。

max_async_retry_attempts

Integer

参数解释

异步调用失败后的最大重试次数,默认值为3。

取值范围

0到8次。

destination_config

FuncAsyncDestinationConfig object

参数解释

异步调用完成后通知用户的目标信息。

取值范围

不涉及。

created_time

String

参数解释

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

*取值范围

带时区的时间串。

last_modified

String

参数解释

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

取值范围

带时区的时间串。

enable_async_status_log

Boolean

参数解释

是否开启异步调用状态持久化,开启后可以跟踪查询异步请求的状态。

取值范围

  • true:开启。

  • false: 不开启。

表4 FuncAsyncDestinationConfig

参数

参数类型

描述

on_success

FuncDestinationConfig object

参数解释

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

取值范围

不涉及。

on_failure

FuncDestinationConfig object

参数解释

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

取值范围

不涉及。

表5 FuncDestinationConfig

参数

参数类型

描述

destination

String

参数解释

目标类型。

取值范围

  • OBS:通知到OBS服务。

  • SMN:通知到SMN服务。

  • DIS:通知到DIS服务。

  • FunctionGraph: 通知到函数服务。

param

String

参数解释

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

取值范围

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

  • SMN:包含smn 主题topic_urn。

  • DIS:包含DIS 通道名stream_name。

  • FunctionGraph:包含func_urn,函数urn

状态码: 404

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

获取函数异步配置信息。

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

响应示例

状态码: 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代码示例如下。

Java

 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
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 ShowFunctionAsyncInvokeConfigSolution {

    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();
        ShowFunctionAsyncInvokeConfigRequest request = new ShowFunctionAsyncInvokeConfigRequest();
        try {
            ShowFunctionAsyncInvokeConfigResponse response = client.showFunctionAsyncInvokeConfig(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());
        }
    }
}

Python

 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
# 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 = ShowFunctionAsyncInvokeConfigRequest()
        response = client.show_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)

Go

 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
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.ShowFunctionAsyncInvokeConfigRequest{}
	response err := client.ShowFunctionAsyncInvokeConfig(request)
	if err == nil {
        fmt.Printf("%+v\n" response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

Ok

404

Not Found

错误码

请参见错误码

相关文档