文档

ListInstances

更新时间:

调用ListInstances接口查询函数的可用实例。

使用说明

ListInstances接口提供了查询函数实例实时状态的能力。使用该接口查询到的实例,即是当前调用对应函数流量链路上的可用实例。

可用实例是指正在执行请求,或者可被调度以处理请求的实例。ListInstancesInvokeFunction流量链路下的实例保持一致。

请求头

该接口无特殊请求头,关于公共请求头信息,请参见公共参数

请求语法

GET /services/{serviceName[.qualifier]}/functions/{function_name}/instances HTTP/1.1

请求参数

名称

类型

位置

是否必选

示例值

描述

serviceName String Path service_name

服务的名称。

functionName String Path function_name

函数的名称

qualifier String Path test

服务的版本或别名。默认是LATEST。

此处的qualifierInvokeFunctionqualifier含义一致,即调用ListInstances时指定qualifier=test查询出来的实例,就是调用InvokeFunctionqualifier=test链路上的实例。

重要 查询预留模式的实例需要传入的qualifier参数必须为别名,而不能是版本。因为预留资源直接与别名绑定,预留模式的实例也在对应的别名下进行管理。
instanceIds Array of String Query ["1ef6b6ff-7f7b-485e-ab49-501ac681****", "04db0821-c6d2-4c10-970b-93e36f1a****"]

实例ID。

limit Long Query 20

限定此次返回资源的数量,取值范围[0,1000]。

返回结果可以小于指定的数量,但不能多于指定的数量。

返回数据

名称

类型

示例值

描述

Array

查询返回的实例信息列表。

instanceId String ["1ef6b6ff-7f7b-485e-ab49-501ac681****", "04db0821-c6d2-4c10-970b-93e36f1a****"]

实例ID。

versionId Long 1

实例所属的服务版本。如果是LATEST别名下的函数实例,则返回版本号为0。

示例

请求示例

GET /services/{serviceName[.qualifier]}/functions/{function_name}/instances?instanceIds=["[\"1ef6b6ff-7f7b-485e-ab49-501ac681****\", \"04db0821-c6d2-4c10-970b-93e36f1a****\"]"]&limit=20 HTTP/1.1
Host:fc-ram.aliyuncs.com
Content-Type:application/json

正常返回示例

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

[ {
  "instanceId" : "[\"1ef6b6ff-7f7b-485e-ab49-501ac681****\", \"04db0821-c6d2-4c10-970b-93e36f1a****\"]",
  "versionId" : 1
} ]