文档首页/ 函数工作流 FunctionGraph/ API参考/ API/ 函数异步配置/ 获取函数活跃异步调用请求列表
更新时间:2024-11-04 GMT+08:00
分享

获取函数活跃异步调用请求列表

功能介绍

获取函数异步调用活跃请求列表

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/fgs/functions/{function_urn}/active-async-invocations

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

function_urn

String

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

表2 Query参数

参数

是否必选

参数类型

描述

requests

String

需要查询的异步请求ID, 多个请求id使用','分隔, 最大支持10个请求id查询。如果不指定,默认查询所有异步调用记录

最小长度:0

最大长度:640

marker

String

本次查询起始位置,默认值0

缺省值:0

最小长度:0

最大长度:64

limit

String

本次查询最大返回的数据条数,最大值500,默认值100

缺省值:100

最小长度:0

最大长度:64

status

String

本次查询指定的异步调用状态,支持5种状态,如果不指定,则查询所有状态的调用记录 WAIT: 等待 RUNNING: 执行中 SUCCESS: 执行成功 FAIL: 执行失败 DISCARD: 请求丢弃

最小长度:0

最大长度:64

query_begin_time

String

搜索起始时间(格式为YYYY-MM-DD'T'HH:mm:ss,UTC时间)。如果不指定默认为当前时间前1小时

query_end_time

String

搜索结束时间(格式为YYYY-MM-DD'T'HH:mm:ss,UTC时间)。如果不指定默认为当前时间

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

Content-Type

String

消息体的类型(格式)

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

invocations

Array of ListFunctionAsyncInvocationsResult objects

异步调用记录列表。

count

Integer

查询数据总条数

next_marker

Integer

查询下一页的起始位置

表5 ListFunctionAsyncInvocationsResult

参数

参数类型

描述

request_id

String

异步调用请求ID

status

String

异步调用状态,支持5种状态 WAIT: 等待 RUNNING: 执行中 SUCCESS: 执行成功 FAIL: 执行失败 DISCARD: 请求丢弃

枚举值:

  • WAIT
  • RUNNING
  • SUCCESS
  • FAIL
  • DISCARD

error_message

String

异步调用错误信息,如果执行成功,则返回空

error_code

Integer

异步调用错误码,如果执行成功,则返回0

start_time

String

异步调用开始时间(格式为YYYY-MM-DD'T'HH:mm:ss,UTC时间)。

end_time

String

异步调用结束时间(格式为YYYY-MM-DD'T'HH:mm:ss,UTC时间)。

状态码: 403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

获取函数活跃异步调用请求列表。

GET /v2/{project_id}/fgs/functions/{function_urn}/active-async-invocations

响应示例

状态码: 200

OK

{
  "invocations" : [ {
    "request_id" : "403fcbd6-ec41-401f-9fa7-386f3d3d****",
    "status" : "SUCCESS",
    "error_message" : "",
    "start_time" : "2019-10-25T15:37:27",
    "end_time" : "2019-10-25T15:37:27",
    "error_code" : 0
  } ],
  "next_marker" : 1,
  "count" : 10
}

状态码: 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"
}

SDK代码示例

SDK代码示例如下。

 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
51
52
53
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.*;

import java.time.OffsetDateTime;
import java.time.format.DateTimeFormatter;

public class ListActiveAsyncInvocationsSolution {

    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();
        ListActiveAsyncInvocationsRequest request = new ListActiveAsyncInvocationsRequest();
        request.withRequests("<requests>");
        request.withMarker("<marker>");
        request.withLimit("<limit>");
        request.withStatus("<status>");
        request.withQueryBeginTime(OffsetDateTime.parse("<query_begin_time>", DateTimeFormatter.ISO_OFFSET_DATE_TIME));
        request.withQueryEndTime(OffsetDateTime.parse("<query_end_time>", DateTimeFormatter.ISO_OFFSET_DATE_TIME));
        try {
            ListActiveAsyncInvocationsResponse response = client.listActiveAsyncInvocations(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());
        }
    }
}
 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
# 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 = ListActiveAsyncInvocationsRequest()
        request.requests = "<requests>"
        request.marker = "<marker>"
        request.limit = "<limit>"
        request.status = "<status>"
        request.query_begin_time = "<query_begin_time>"
        request.query_end_time = "<query_end_time>"
        response = client.list_active_async_invocations(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
51
package main

import (
	"fmt"
	"time"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/sdktime"
    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.ListActiveAsyncInvocationsRequest{}
	requestsRequest:= "<requests>"
	request.Requests = &requestsRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	limitRequest:= "<limit>"
	request.Limit = &limitRequest
	statusRequest:= "<status>"
	request.Status = &statusRequest
	dateTimeQueryBeginTime, _ := time.ParseInLocation("2006-01-02T15:04:05Z", "<query_begin_time>", time.UTC)
	queryBeginTimeRequest:= sdktime.SdkTime(dateTimeQueryBeginTime)
	request.QueryBeginTime = &queryBeginTimeRequest
	dateTimeQueryEndTime, _ := time.ParseInLocation("2006-01-02T15:04:05Z", "<query_end_time>", time.UTC)
	queryEndTimeRequest:= sdktime.SdkTime(dateTimeQueryEndTime)
	request.QueryEndTime = &queryEndTimeRequest
	response, err := client.ListActiveAsyncInvocations(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

OK

403

FORBIDDEN

404

Not Found

500

内部错误

错误码

请参见错误码

相关文档