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

获取函数流指标

功能介绍

获取函数流指标

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/fgs/workflow-statistic

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

period

String

参数解释:

时间段,单位为分钟。

约束限制:

不涉及。

取值范围:

只能选择1,5,15,60 这四个时间段。

默认值:

不涉及。

start_time

String

参数解释:

开始时间,精确到ms的时间戳。

约束限制:

小于等于当前时间。

取值范围:

只能选择1,5,15,60 这四个时间段。

默认值:

不涉及。

end_time

String

参数解释:

结束时间,精确到ms的时间戳。

约束限制:

大于开始时间, 并且与开始时间之间的间隔不能大于选择的时间段。

取值范围:

不涉及。

默认值:

不涉及。

metric_type

String

参数解释:

FunctionGraph工作流指标类型。

取值范围:

  • workflowFlowTotalCount:函数工作流任务个数。

  • workflowFlowErrorCount:函数工作流任务错误个数。

  • workflowFlowAverageDuration:函数工作流任务平均时延。

  • workflowFlowRunningCount:函数工作流任务运行中个数。

  • workflowFlowRejectCount:函数工作流任务拒绝个数。

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

count

Array of SlaReportsValue objects

参数解释:

函数工作流任务个数。

取值范围:

不涉及

duration

Array of SlaReportsValue objects

参数解释:

函数工作流任务时延。

取值范围:

不涉及

fail_count

Array of SlaReportsValue objects

参数解释:

函数工作流任务错误个数。

取值范围:

不涉及

running_count

Array of SlaReportsValue objects

参数解释:

函数工作流任务运行中个数。

取值范围:

不涉及

表4 SlaReportsValue

参数

参数类型

描述

timestamp

Long

参数解释:

指标的时间戳。

取值范围:

不涉及。

value

Double

参数解释:

指标的值。

取值范围:

不涉及。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

request_id

String

请求ID

状态码: 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

request_id

String

请求ID

请求示例

获取函数流指标。

GET /v2/{projectId}/fgs/workflow-statistic

响应示例

状态码: 200

函数流统计信息

{
  "count" : [ {
    "timestamp" : 0,
    "value" : 0
  } ],
  "duration" : [ {
    "timestamp" : 0,
    "value" : 0
  } ],
  "fail_count" : [ {
    "timestamp" : 0,
    "value" : 0
  } ],
  "running_count" : [ {
    "timestamp" : 0,
    "value" : 0
  } ]
}

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
46
47
48
49
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 ShowTenantMetricSolution {

    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();
        ShowTenantMetricRequest request = new ShowTenantMetricRequest();
        request.withPeriod("<period>");
        request.withStartTime("<start_time>");
        request.withEndTime("<end_time>");
        request.withMetricType("<metric_type>");
        try {
            ShowTenantMetricResponse response = client.showTenantMetric(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
30
31
32
33
# 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 = ShowTenantMetricRequest()
        request.period = "<period>"
        request.start_time = "<start_time>"
        request.end_time = "<end_time>"
        request.metric_type = "<metric_type>"
        response = client.show_tenant_metric(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
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.ShowTenantMetricRequest{}
	periodRequest:= "<period>"
	request.Period = &periodRequest
	startTimeRequest:= "<start_time>"
	request.StartTime = &startTimeRequest
	endTimeRequest:= "<end_time>"
	request.EndTime = &endTimeRequest
	metricTypeRequest:= "<metric_type>"
	request.MetricType = &metricTypeRequest
	response err := client.ShowTenantMetric(request)
	if err == nil {
        fmt.Printf("%+v\n" response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

函数流统计信息

400

Bad Request

500

Internal Server Error

错误码

请参见错误码

相关文档