文档首页/ 函数工作流 FunctionGraph/ API参考/ API/ 函数预留实例/ 获取函数预留实例配置列表 - ListReservedInstanceConfigs
更新时间:2025-12-08 GMT+08:00
分享

获取函数预留实例配置列表 - ListReservedInstanceConfigs

功能介绍

获取函数预留实例配置列表

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

GET /v2/{project_id}/fgs/functions/reservedinstanceconfigs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

function_urn

String

参数解释

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

约束限制

只能由字母、数字、下划线、中划线、冒号组成.

取值范围

长度1-269位。

默认取值

不涉及

marker

String

参数解释

本次查询起始位置。

约束限制

只能由数字组成,长度1-64位。

取值范围

不涉及

默认取值

'0'

limit

String

参数解释

本次查询最大返回的数据条数。

约束限制

只能由数字组成,长度1-64位。

取值范围

不涉及。

默认取值

'100'

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

Content-Type

String

参数解释:

消息体的类型(格式)。

约束限制:

不涉及。

取值范围:

只能为application/json

默认取值:

application/json

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

reserved_instances

Array of ReservedInstanceConfigs objects

参数解释

函数预留实例列表。

约束限制:

不涉及。

page_info

PageInfo object

参数解释:

读取位置信息。

取值范围:

不涉及。

count

Long

参数解释

函数个数。

约束限制

不涉及。

表5 ReservedInstanceConfigs

参数

参数类型

描述

function_urn

String

参数解释

函数URN。

约束限制

不涉及。

qualifier_type

String

参数解释

FunctionGraph函数的预留实例类型

取值范围

  • version: 查询某个版本的预留实例

  • alias: 查询某个别名的预留实例

qualifier_name

String

参数解释

限定类型对应的取值。

约束限制

不涉及。

min_count

Integer

参数解释

预留实例个数。

约束限制

不涉及。

idle_mode

Boolean

参数解释

是否开启闲置模式配置。

约束限制

不涉及。

tactics_config

TacticsConfig object

参数解释

预留实例策略配置。

取值范围

不涉及。

表6 TacticsConfig

参数

参数类型

描述

cron_configs

Array of CronConfig objects

参数解释

定时配置列表。

取值范围

不涉及。

metric_configs

Array of MetricConfig objects

参数解释

流量配置列表。

取值范围

不涉及。

表7 CronConfig

参数

参数类型

描述

name

String

参数解释

定时配置名称。

取值范围

不涉及。

cron

String

参数解释

定时表达式。

取值范围

不涉及。

count

Integer

参数解释

拉起预留实例个数。

取值范围

不涉及。

start_time

Long

参数解释

开始时间戳。

取值范围

epoch时间戳格式。

expired_time

Long

参数解释

失效时间戳。

取值范围

epoch时间戳格式。

表8 MetricConfig

参数

参数类型

描述

name

String

参数解释

流量配置名称。

取值范围

不涉及。

type

String

参数解释

流量配置类型。

取值范围

当前只支持预留实例使用率一种类型。

  • Concurrency:预留实例使用率。

threshold

Integer

参数解释

流量阈值。

取值范围

[0, 100]

min

Integer

参数解释

流量最小值。

取值范围

不涉及。

表9 PageInfo

参数

参数类型

描述

next_marker

Long

参数解释

下一次读取位置。

取值范围

大于等于0。

previous_marker

Long

参数解释

上一次读取位置。

取值范围

大于等于0。

current_count

Long

参数解释

当前页总数。

取值范围

大于等于0。

状态码: 400

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 401

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 403

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 404

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 500

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

获取函数预留实例配置列表

GET https://{Endpoint}/v2/{project_id}/fgs/functions/reservedinstanceconfigs

响应示例

状态码:200

OK

{
    "reserved_instances": [
        {
            "function_urn": "urn:fss:{region}:46b6f338fc3445b8846c71dfb1fbxxxx:function:default:xxxxx:latest",
            "qualifier_type": "version",
            "qualifier_name": "latest",
            "min_count": 10,
            "idle_mode": false,
            "tactics_config": {
                "cron_configs": [
                    {
                        "name": "cronConfig",
                        "cron": "0 1 * * * *",
                        "count": 15,
                        "start_time": 1658073600,
                        "expired_time": 1658160000
                    }
                ],
                "metric_configs": [
                    {
                        "name": "metricConfig",
                        "type": "Concurrency",
                        "threshold": 90,
                        "min": 12
                    }
                ]
            }
        }
    ],
    "page_info": {
        "next_marker": 1,
        "previous_marker": 0,
        "current_count": 1
    },
    "count": 1
}

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

    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();
        ListReservedInstanceConfigsRequest request = new ListReservedInstanceConfigsRequest();
        request.withFunctionUrn("<function_urn>");
        request.withMarker("<marker>");
        request.withLimit("<limit>");
        try {
            ListReservedInstanceConfigsResponse response = client.listReservedInstanceConfigs(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
# 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 = ListReservedInstanceConfigsRequest()
        request.function_urn = "<function_urn>"
        request.marker = "<marker>"
        request.limit = "<limit>"
        response = client.list_reserved_instance_configs(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
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.ListReservedInstanceConfigsRequest{}
	functionUrnRequest:= "<function_urn>"
	request.FunctionUrn = &functionUrnRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	limitRequest:= "<limit>"
	request.Limit = &limitRequest
	response, err := client.ListReservedInstanceConfigs(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK

400

Bad Request 请求错误。

401

Unauthorized 鉴权失败。

403

Forbidden 没有操作权限。

404

Not Found 找不到资源。

500

Internal Server Error 服务内部错误。

错误码

请参见错误码

相关文档