文档首页> 函数工作流 FunctionGraph> API参考> API> 函数预留实例> 获取函数预留实例配置列表
更新时间：2024-03-25 GMT+08:00
查看PDF

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

功能介绍

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目 ID，获取方式请参见获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

function_urn

否

String

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

marker

否

String

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

缺省值：0

最小长度：1

最大长度：64

limit

否

String

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

缺省值：100

最小长度：1

最大长度：64

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

Content-Type

是

String

消息体的类型（格式）

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

reserved_instances

Array of ReservedInstanceConfigs objects

函数预留实例列表

page_info

PageInfo object

   

count

Long

函数个数
表5 ReservedInstanceConfigs

参数

参数类型

描述

function_urn

String

函数URN

qualifier_type

String

限定类型, 支持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

流量阈值

min

Integer

流量最小值
表9 PageInfo

参数

参数类型

描述

next_marker

Long

下一次读取位置

previous_marker

Long

上一次读取位置

current_count

Long

当前页总数

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

状态码

状态码

描述

200

OK

400

Bad Request 请求错误。

401

Unauthorized 鉴权失败。

403

Forbidden 没有操作权限。

404

Not Found 找不到资源。

500

Internal Server Error 服务内部错误。

错误码

请参见错误码。

父主题： 函数预留实例