ListFunctionInstances--函数服务-火山引擎

文档中心

立即注册

导航

ListFunctionInstances

最近更新时间：2025.06.12 14:59:20首次发布时间：2024.08.07 11:48:17

查询函数实例列表。

请求说明

请求方式：POST
请求地址：http://open.volcengineapi.com/?Action=ListFunctionInstances&Version=2024-06-06

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListFunctionInstances	接口名称。当前 API 的名称为 `ListFunctionInstances`。
Version	String	是	2024-06-06	接口版本。当前 API 的版本为 `2024-06-06`。
FunctionId	String	是	nw******	函数 ID。

请求示例

POST http://open.volcengineapi.com/?Action=ListFunctionInstances&Version=2024-06-06 HTTP/1.1
Content-Type: application/json
{
    "FunctionId": "nw******"
}

返回参数

参数	类型	示例值	描述
Items	Array of FunctionInstance		函数实例的详细信息列表。
Total	Integer	1	返回列表数据的总量。

FunctionInstance

参数	类型	示例值	描述
Id	String	nw******	函数 ID。
CreationTime	String	2024-06-25 11:17:11.492301904 +0800 CST	函数实例创建时间。
InstanceName	String	nw******-vd9qztck6t-74b9cf8975-bkd99	函数实例名称。
InstanceStatus	String	Starting	函数实例状态： Starting：启动中 Ready：就绪 Failed：失败 Terminating：终止中 Unknown：未知状态
RevisionNumber	Integer	1	函数实例版本编号。
UserVpcIP	String	192.168.1.4	用户函数绑定 VPC 使用的 ENI IPv4 地址
UserVpcIPv6	String	fdbd:dc01:ff:30a:f323:xxx:xxx:xxx	用户函数绑定 VPC 使用的 ENI IPv6 地址
InstanceType	String		Instance type (elastic / frozen / activated / reserved)
AvailabilityZone	String	cn-beijing-b	函数实例缩在az名称

返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListFunctionInstances",
        "Version": "2024-06-06",
        "Service": "vefaas",
        "Region": "cn-beijing"
    },
    "Result": {
        "Items": [
            {
                "Id": "nw******",
                "CreationTime": "2024-06-25 11:17:11.492301904 +0800 CST",
                "InstanceName": "nw******-vd9qztck6t-74b9cf8975-bkd99",
                "InstanceStatus": "Starting",
                "RevisionNumber": 1
            }
        ],
        "Total": 1
    }
}

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。